广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > Python >解析Mybatis SqlSessionFactory初始化原理
  • 599

0
分享到

解析Mybatis SqlSessionFactory初始化原理

2024-04-02 19:04:59 599人浏览 八月长安

Python 官方文档：入门教程 => 点击学习

摘要

目录引言sqlSessionFactory不使用 XML 构建 SqlSessionFactorySqlSessionFactoryBuilder拓展引言 现在内卷越来越严重，关于

引言

现在内卷越来越严重，关于常用的ORM框架mybatis，小编准备了三篇文章，分别将介绍SqlSessionFactory初始化原理、SqlSession执行流程，Mybatis代理模式运行方式与最终总结，这是第一篇，感兴趣的朋友可以持续关注。

SqlSessionFactory

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。


String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。后面会再探讨 XML 配置文件的详细内容，这里先给出一个简单的示例：


<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "Http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="passWord" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

当然，还有很多可以在 XML 文件中配置的选项，上面的示例仅罗列了最关键的部分。 注意 XML 头部的声明，它用来验证 XML 文档的正确性。environment 元素体中包含了事务管理和连接池的配置。mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息。

不使用 XML 构建 SqlSessionFactory

如果你更愿意直接从 Java 代码而不是 XML 文件中创建配置，或者想要创建你自己的配置建造器，MyBatis 也提供了完整的配置类，提供了所有与 XML 文件等价的配置项。


DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

注意该例中，configuration 添加了一个映射器类（mapper class）。映射器类是 Java 类，它们包含 SQL 映射注解从而避免依赖 XML 文件。不过，由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套联合映射），仍然需要使用 XML 配置。有鉴于此，如果存在一个同名 XML 配置文件，MyBatis 会自动查找并加载它（在这个例子中，基于类路径和 BlogMapper.class 的类名，会加载 BlogMapper.xml）。具体细节稍后讨论。

SqlSessionFactoryBuilder


String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

build 方法：


// 1.我们最初调用的build
public SqlSessionFactory build(InputStream inputStream) {
    //调用了重载方法
    return build(inputStream, null, null);
}
​
// 2.调用的重载方法
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
        // 创建 XMLConfigBuilder, XMLConfigBuilder是专门解析mybatis的配置文件的类
        XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
        // 执行 XML 解析
        // 创建 DefaultSqlSessionFactory 对象
        return build(parser.parse());
    } catch (Exception e) {
        //···
    }
}

parser.parse()


public Configuration parse() {
    if (parsed) {
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    // 标记已解析
    parsed = true;
    // parser.evalnode("/configuration")，
    // 通过xpath 读取配置文件的节点，将读取出配置文件的所以节点
    //<configuration>
    //   <environments default="development">
   //   </environments>
    //<configuration>
    parseConfiguration(parser.evalNode("/configuration"));
    return configuration;
  }

parseConfiguration(XNode root)


// 解析每个节点 这里每个方法进去都会有很多配置，这里就不一一解析，大家感兴趣可以看看，
//  settingsElement(settings);mapperElement(root.evalNode("mappers"));
private void parseConfiguration(XNode root) {
    try {
        //issue #117 read properties first
        // 解析 <properties /> 标签
        propertiesElement(root.evalNode("properties"));
        // 解析 <settings /> 标签
        Properties settings = settingsAsProperties(root.evalNode("settings"));
        // 加载自定义的 VFS 实现类
        loadCustomVfs(settings);
        // 解析 <typeAliases /> 标签
        typeAliasesElement(root.evalNode("typeAliases"));
        // 解析 <plugins /> 标签
        pluginElement(root.evalNode("plugins"));
        // 解析 <objectFactory /> 标签
        objectFactoryElement(root.evalNode("objectFactory"));
        // 解析 <objectWrapperFactory /> 标签
        objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
        // 解析 <reflectorFactory /> 标签
        reflectorFactoryElement(root.evalNode("reflectorFactory"));
        // 赋值 <settings /> 到 Configuration 属性
        settingsElement(settings);
        // read it after objectFactory and objectWrapperFactory issue #631
        // 解析 <environments /> 标签
        environmentsElement(root.evalNode("environments"));
        // 解析 <databaseIdProvider /> 标签
        databaseIdProviderElement(root.evalNode("databaseIdProvider"));
        // 解析 <typeHandlers /> 标签
        typeHandlerElement(root.evalNode("typeHandlers"));
        // 解析 <mappers /> 标签
        mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
        throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
}

    // 获取mapper
  private void mapperElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
         // 如果是 包将在这里进行渲染
        if ("package".equals(child.getName())) {
          String mapperPackage = child.getStringAttribute("name");
          configuration.addMappers(mapperPackage);
        } else {
            // 读取resource 标签 
          String resource = child.getStringAttribute("resource");
           // 读取url 标签  
          String url = child.getStringAttribute("url");
            // 读取注解
          String mapperClass = child.getStringAttribute("class");
            // 根据不同的方式完成
          if (resource != null && url == null && mapperClass == null) {
            ErrorContext.instance().resource(resource);
            InputStream inputStream = Resources.getResourceAsStream(resource);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url != null && mapperClass == null) {
            ErrorContext.instance().resource(url);
            InputStream inputStream = Resources.getUrlAsStream(url);
            XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
            mapperParser.parse();
          } else if (resource == null && url == null && mapperClass != null) {
            Class<?> mapperInterface = Resources.classForName(mapperClass);
            configuration.addMapper(mapperInterface);
          } else {
            throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
          }
        }
      }
    }
  }

private void settingsElement(Properties props) {
    configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
    configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
    configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
    configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
 .....
    configuration.setShrinkWhitespacesInSql(booleanValueOf(props.getProperty("shrinkWhitespacesInSql"), false));
  }

mapperParser.parse();


// 这里我们先看一下 mapperParser.parse();方法 懂得原理，都是类似的
  public void parse() {
    if (!configuration.isResourceLoaded(resource)) {
      // 加载 mapper所有子节点
      configurationElement(parser.evalNode("/mapper"));
      configuration.addLoadedResource(resource);
        // 绑定 Namespace
      bindMapperForNamespace();
    }
 // 构建ResultMap  
    parsePendingResultMaps();
    parsePendinGCacheRefs();
    parsePendingStatements();
  }
   // 这里将解析整个 xml文件
    private void configurationElement(XNode context) {
    try {
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.isEmpty()) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }
      builderAssistant.setCurrentNamespace(namespace);
      cacheRefElement(context.evalNode("cache-ref"));
      cacheElement(context.evalNode("cache"));
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));
      resultMapElements(context.evalNodes("/mapper/resultMap"));
      sqlElement(context.evalNodes("/mapper/sql"));
        // 解析标签，
      buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
    }
  }

// 关于注解的方式的parse
  public void parse() {
    String resource = type.toString();
    if (!configuration.isResourceLoaded(resource)) {
      loadXmlResource();
      configuration.addLoadedResource(resource);
      assistant.setCurrentNamespace(type.getName());
      parseCache();
      parseCacheRef();
      for (Method method : type.getMethods()) {
        if (!canHaveStatement(method)) {
          continue;
        }
        if (getAnnotationWrapper(method, false, Select.class, SelectProvider.class).isPresent()
            && method.getAnnotation(ResultMap.class) == null) {
          parseResultMap(method);
        }
        try {
          parseStatement(method);
        } catch (IncompleteElementException e) {
          configuration.addIncompleteMethod(new MethodResolver(this, method));
        }
      }
    }
    parsePendingMethods();
  }

到此Mybatis的初始化工作就完毕了，主要做了两件大事

  • 解析核心配置文件到Configuration对象，解析映射配置文件到MappedStatement对象，并保存在Configuration的对应Map中
  • 创建了DefaultSqlSessionFactory返回

通过上面的代码分析，总结了一下使用的重要的类，通过下图的装配，最终返回SqlSessionFactory，而SqlSessionFactory的最终实现是 DefaultSqlSessionFactory，关于DefaultSqlSessionFactory的介绍我们将放在下篇文章进行讲解，感兴趣的小伙伴可以持续关注！

拓展

看到这里很多人就会有个疑问，这是通过配置文件的方式在进行配置，但是SpringBoot 没有这样的配置文件，是怎么做到的呢？其实springBoot是通过自定配置完成；


@Configuration
// 实例化 SqlSessionFactory
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
// MybatisProperties 我们常用的配置
@EnableConfigurationProperties({MybatisProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class})
public class MybatisAutoConfiguration implements InitializingBean {}

到此这篇关于解析Mybatis SqlSessionFactory初始化原理的文章就介绍到这了,更多相关Mybatis SqlSessionFactory初始化 内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:
点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: 解析Mybatis SqlSessionFactory初始化原理

本文链接: https://www.lsjlt.com/news/130232.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • 解析Mybatis SqlSessionFactory初始化原理
    目录引言SqlSessionFactory不使用 XML 构建 SqlSessionFactorySqlSessionFactoryBuilder拓展引言 现在内卷越来越严重，关于...
    99+
    2022-11-12
  • Mybatis SqlSessionFactory初始化原理是什么
    这篇文章主要讲解了“Mybatis SqlSessionFactory初始化原理是什么”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“Mybatis SqlSessionFactory初始化原...
    99+
    2023-06-20
  • mybatis初始化SqlSessionFactory失败的几个原因分析
    目录mybatis初始化SqlSessionFactory失败总结原因有几点SqlSessionFactory异常mybatis初始化SqlSessionFactory失败 总结原因...
    99+
    2022-11-12
  • VueRouter 原理解读之初始化流程
    目录1.1 核心概念官方介绍使用与阅读源码的必要性1.2 基本使用路由配置与项目引入路由组件使用跳转 api 调用2.1 createRouter 初始化入口分析大致流程Router...
    99+
    2023-05-19
    VueRouter 初始化原理  VueRouter 初始化
  • Mysql初始化卡住的原因分析
    小编给大家分享一下Mysql初始化卡住的原因分析，相信大部分人都还不怎么了解，因此分享这篇文章给大家参考一下，希望大家阅读完这篇文章后大有收获，下面让我们一起去了解一下吧！MYSQL安装到这里卡了很久，是不...
    99+
    2022-10-19
  • spring Bean的初始化过程解析
    AbstractAutowireCapableBeanFactory#applyMergedBeanDefinitionPostProcessors 使用BeanPostProce...
    99+
    2022-11-13
  • tdesignvue初始化组件源码解析
    目录前言源码脚本的入口创建目录内容写入删除目录删除导入语句总结前言 Tdesign-vue 是一由腾讯开源的 Vue.js 组件库。我们知道，这些大型的组件库业务覆盖面很广，基本都包...
    99+
    2022-12-21
    tdesign vue初始化组件 tdesign vue
  • 云服务器初始化失败原因分析
    服务器配置不正确 云服务器是一种虚拟的服务器，它的配置文件通常存储在云服务器提供商的服务器上。服务器配置错误是导致云服务器初始化失败的一个常见原因。例如，服务器配置文件中的配置可能包括网络设置，服务器硬件规格和操作系统类型等。在云服务...
    99+
    2023-10-27
    初始化 原因 服务器
  • spring初始化方法的执行顺序及其原理分析
    目录Spring中初始化方法的执行顺序首先通过一个例子来看其顺序配置我们进入这个类看我们看到了annotation-config了我们重点看下这行代码我们直接看initializeB...
    99+
    2022-11-13
  • Java类初始化执行流程解析
    　测试代码:　　 package com.test.ClassLaoderTest; public class test1 { public static Strin...
    99+
    2022-11-12
  • Mybatis 插件原理解析
    Mybati s作为⼀个应⽤⼴泛的优秀的ORM开源框架，这个框架具有强⼤的灵活性，在四⼤组件 (Executor...
    99+
    2022-11-12
  • C#3.0中对象初始化器和集合初始化器怎么理解
    这篇文章主要讲解了“C#3.0中对象初始化器和集合初始化器怎么理解”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“C#3.0中对象初始化器和集合初始化器怎么理解”吧！关于对象初始化器(Obje...
    99+
    2023-06-17
  • C++初始化函数列表详细解析
    在以下三种情况下需要使用初始化成员列表： 一，需要初始化的数据成员是对象的情况； 二，需要初始化const修饰的类成员； 三，需要初始化引用成员数据； 原因：C++可以定义引用类型的...
    99+
    2022-11-15
    初始化函数列表
  • 解析之C++的列表初始化语法
    目录聚合初始化大括号省略（brace elision）std::initializer_list的另一个故事连《Effective Modern C++》都弄错了的规则构造函数的两步...
    99+
    2022-11-12
  • 如何解析ThinkPHP5之 _initialize()初始化方法
    小编给大家分享一下如何解析ThinkPHP5之 _initialize()初始化方法，希望大家阅读完这篇文章之后都有所收获，下面让我们一起去探讨吧！ThinkPHP5之 _initialize() 初始化方法详解前言_initialize(...
    99+
    2023-06-14
  • 实例解析Java中的构造器初始化
    初始化顺序　　当Java创建一个对象时，系统先为该对象的所有实例属性分配内存（前提是该类已经被加载过了），接着程序开始对这些实例属性执行初始化，其初始化顺序是：先执行初始化块或声明属性时制定的初始值，再执行构造器里制定的初始值。 在类的内部...
    99+
    2023-05-31
    java 构造器 初始化
  • 猪齿鱼 Choerodon 的数据初始化设计解析
    数智化效能平台猪齿鱼Choerodon 作为一个微服务框架，需要解决微服务数据初始化本身具有的问题和复杂性，同时也需要满足框架本身特有的数据初始化需求，下面为大家介绍一下这方面的设计思想和实现。 ...
    99+
    2019-12-29
    猪齿鱼 Choerodon 的数据初始化设计解析
  • Spring源码解析容器初始化构造方法
    目录前言构造方法前言 Spring框架被广泛应用于我们的日常工作中，但是很长时间以来我都是只会使用，不懂它的作用原理。通过最近一段时间的阅读源码，个人发现通过阅读源码，能够帮助我们了...
    99+
    2022-11-13
  • Swift中类与结构的初始化示例解析
    目录一，结构的初始化二，结构的初始化三，结构中初始化错误示例四，结构中init可以通过self关键字调用其他的init五，类初始化错误示例六，类的(Designated init)初...
    99+
    2022-11-13
  • 【mybatis】mybatis 拦截器工作原理源码解析
    mybatis 拦截器工作原理（JDK动态代理） 1. mybatis 拦截器案例 场景：分页查询，类似成熟产品:pagehelper, 这里只做简单原理演示 1.0 mybatis全局配置 SqlMapConfig.xml ...
    99+
    2015-01-18
    【mybatis】mybatis 拦截器工作原理源码解析
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作