经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 数据库/运维 » MyBatis » 查看文章
解析Mybatis SqlSessionFactory初始化原理
来源:jb51  时间:2021/7/12 9:39:48  对本文有异议

引言

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

SqlSessionFactory

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

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

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

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

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3. PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6. <environments default="development">
  7. <environment id="development">
  8. <transactionManager type="JDBC"/>
  9. <dataSource type="POOLED">
  10. <property name="driver" value="${driver}"/>
  11. <property name="url" value="${url}"/>
  12. <property name="username" value="${username}"/>
  13. <property name="password" value="${password}"/>
  14. </dataSource>
  15. </environment>
  16. </environments>
  17. <mappers>
  18. <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  19. </mappers>
  20. </configuration>
  21.  

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

不使用 XML 构建 SqlSessionFactory

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

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

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

SqlSessionFactoryBuilder

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

build 方法:

  1. // 1.我们最初调用的build
  2. public SqlSessionFactory build(InputStream inputStream) {
  3. //调用了重载方法
  4. return build(inputStream, null, null);
  5. }
  6. // 2.调用的重载方法
  7. public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
  8. try {
  9. // 创建 XMLConfigBuilder, XMLConfigBuilder是专门解析mybatis的配置文件的类
  10. XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
  11. // 执行 XML 解析
  12. // 创建 DefaultSqlSessionFactory 对象
  13. return build(parser.parse());
  14. } catch (Exception e) {
  15. //···
  16. }
  17. }
  18.  

parser.parse()

  1. public Configuration parse() {
  2. if (parsed) {
  3. throw new BuilderException("Each XMLConfigBuilder can only be used once.");
  4. }
  5. // 标记已解析
  6. parsed = true;
  7. // parser.evalNode("/configuration"),
  8. // 通过xpath 读取配置文件的节点,将读取出配置文件的所以节点
  9. //<configuration>
  10. // <environments default="development">
  11. // </environments>
  12. //<configuration>
  13. parseConfiguration(parser.evalNode("/configuration"));
  14. return configuration;
  15. }

parseConfiguration(XNode root)

  1. // 解析每个节点 这里每个方法进去都会有很多配置,这里就不一一解析,大家感兴趣可以看看,
  2. // settingsElement(settings);mapperElement(root.evalNode("mappers"));
  3. private void parseConfiguration(XNode root) {
  4. try {
  5. //issue #117 read properties first
  6. // 解析 <properties /> 标签
  7. propertiesElement(root.evalNode("properties"));
  8. // 解析 <settings /> 标签
  9. Properties settings = settingsAsProperties(root.evalNode("settings"));
  10. // 加载自定义的 VFS 实现类
  11. loadCustomVfs(settings);
  12. // 解析 <typeAliases /> 标签
  13. typeAliasesElement(root.evalNode("typeAliases"));
  14. // 解析 <plugins /> 标签
  15. pluginElement(root.evalNode("plugins"));
  16. // 解析 <objectFactory /> 标签
  17. objectFactoryElement(root.evalNode("objectFactory"));
  18. // 解析 <objectWrapperFactory /> 标签
  19. objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
  20. // 解析 <reflectorFactory /> 标签
  21. reflectorFactoryElement(root.evalNode("reflectorFactory"));
  22. // 赋值 <settings /> 到 Configuration 属性
  23. settingsElement(settings);
  24. // read it after objectFactory and objectWrapperFactory issue #631
  25. // 解析 <environments /> 标签
  26. environmentsElement(root.evalNode("environments"));
  27. // 解析 <databaseIdProvider /> 标签
  28. databaseIdProviderElement(root.evalNode("databaseIdProvider"));
  29. // 解析 <typeHandlers /> 标签
  30. typeHandlerElement(root.evalNode("typeHandlers"));
  31. // 解析 <mappers /> 标签
  32. mapperElement(root.evalNode("mappers"));
  33. } catch (Exception e) {
  34. throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
  35. }
  36. }
  37.  
  38. // 获取mapper
  39. private void mapperElement(XNode parent) throws Exception {
  40. if (parent != null) {
  41. for (XNode child : parent.getChildren()) {
  42. // 如果是 包将在这里进行渲染
  43. if ("package".equals(child.getName())) {
  44. String mapperPackage = child.getStringAttribute("name");
  45. configuration.addMappers(mapperPackage);
  46. } else {
  47. // 读取resource 标签
  48. String resource = child.getStringAttribute("resource");
  49. // 读取url 标签
  50. String url = child.getStringAttribute("url");
  51. // 读取注解
  52. String mapperClass = child.getStringAttribute("class");
  53. // 根据不同的方式完成
  54. if (resource != null && url == null && mapperClass == null) {
  55. ErrorContext.instance().resource(resource);
  56. InputStream inputStream = Resources.getResourceAsStream(resource);
  57. XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
  58. mapperParser.parse();
  59. } else if (resource == null && url != null && mapperClass == null) {
  60. ErrorContext.instance().resource(url);
  61. InputStream inputStream = Resources.getUrlAsStream(url);
  62. XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
  63. mapperParser.parse();
  64. } else if (resource == null && url == null && mapperClass != null) {
  65. Class<?> mapperInterface = Resources.classForName(mapperClass);
  66. configuration.addMapper(mapperInterface);
  67. } else {
  68. throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
  69. }
  70. }
  71. }
  72. }
  73. }
  74.  
  75. private void settingsElement(Properties props) {
  76. configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
  77. configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
  78. configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
  79. configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
  80. .....
  81. configuration.setShrinkWhitespacesInSql(booleanValueOf(props.getProperty("shrinkWhitespacesInSql"), false));
  82. }

mapperParser.parse();

  1. // 这里我们先看一下 mapperParser.parse();方法 懂得原理,都是类似的
  2. public void parse() {
  3. if (!configuration.isResourceLoaded(resource)) {
  4. // 加载 mapper所有子节点
  5. configurationElement(parser.evalNode("/mapper"));
  6. configuration.addLoadedResource(resource);
  7. // 绑定 Namespace
  8. bindMapperForNamespace();
  9. }
  10. // 构建ResultMap
  11. parsePendingResultMaps();
  12. parsePendingCacheRefs();
  13. parsePendingStatements();
  14. }
  15. // 这里将解析整个 xml文件
  16. private void configurationElement(XNode context) {
  17. try {
  18. String namespace = context.getStringAttribute("namespace");
  19. if (namespace == null || namespace.isEmpty()) {
  20. throw new BuilderException("Mapper's namespace cannot be empty");
  21. }
  22. builderAssistant.setCurrentNamespace(namespace);
  23. cacheRefElement(context.evalNode("cache-ref"));
  24. cacheElement(context.evalNode("cache"));
  25. parameterMapElement(context.evalNodes("/mapper/parameterMap"));
  26. resultMapElements(context.evalNodes("/mapper/resultMap"));
  27. sqlElement(context.evalNodes("/mapper/sql"));
  28. // 解析标签,
  29. buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
  30. } catch (Exception e) {
  31. throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
  32. }
  33. }
  34.  
  35. // 关于注解的方式的parse
  36. public void parse() {
  37. String resource = type.toString();
  38. if (!configuration.isResourceLoaded(resource)) {
  39. loadXmlResource();
  40. configuration.addLoadedResource(resource);
  41. assistant.setCurrentNamespace(type.getName());
  42. parseCache();
  43. parseCacheRef();
  44. for (Method method : type.getMethods()) {
  45. if (!canHaveStatement(method)) {
  46. continue;
  47. }
  48. if (getAnnotationWrapper(method, false, Select.class, SelectProvider.class).isPresent()
  49. && method.getAnnotation(ResultMap.class) == null) {
  50. parseResultMap(method);
  51. }
  52. try {
  53. parseStatement(method);
  54. } catch (IncompleteElementException e) {
  55. configuration.addIncompleteMethod(new MethodResolver(this, method));
  56. }
  57. }
  58. }
  59. parsePendingMethods();
  60. }

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

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

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

拓展

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

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

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

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号