《深入理解Mybatis原理》MyBatis初始化机制详解

莱莱  金牌会员 | 2024-12-31 07:58:03 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 879|帖子 879|积分 2637

重要构件及其相互关系

重要构件：

重要的核心部件表明如下：

  • SqlSession： 作为MyBatis工作的重要顶层API，表示和数据库交互的会话，完成必要数据库增删改查功能
  • Executor：MyBatis实行器，是MyBatis 调度的核心，负责SQL语句的生成和查询缓存的维护
  • StatementHandler： 封装了JDBC Statement操作，负责对JDBC statement 的操作，如设置参数、将Statement结果集转换成List聚集。
  • ParameterHandler： 负责对用户通报的参数转换成JDBC Statement 所需要的参数，
  • ResultSetHandler：负责将JDBC返回的ResultSet结果集对象转换成List类型的聚集；
  • TypeHandler： 负责java数据类型和jdbc数据类型之间的映射和转换
  • MappedStatement： MappedStatement维护了一条节点的封装，
  • SqlSource： 负责根据用户通报的parameterObject，动态地生成SQL语句，将信息封装到BoundSql对象中，并返回
  • BoundSql： 表示动态生成的SQL语句以及相应的参数信息
  • Configuration： MyBatis所有的配置信息都维持在Configuration对象之中。
MyBatis初始化的方式

MyBatis的初始化可以有两种方式：

  • 基于XML配置文件：基于XML配置文件的方式是将MyBatis的所有配置信息放在XML文件中，MyBatis通过加载XML配置文件，将配置文信息组装成内部的Configuration对象。
  • 基于Java API：这种方式不使用XML配置文件，需要MyBatis使用者在Java代码中，手动创建Configuration对象，然后将配置参数set 进入Configuration对象中。
基于XML配置

如今就从使用MyBatis的简单例子入手，深入分析一下MyBatis是怎样完成初始化的，都初始化了什么。看以下代码：
  1. // mybatis初始化
  2. String resource = "mybatis-config.xml";  
  3. InputStream inputStream = Resources.getResourceAsStream(resource);  
  4. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
  6. // 创建SqlSession
  7. SqlSession sqlSession = sqlSessionFactory.openSession();  
  9. // 执行SQL语句
  10. List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");
复制代码
上述语句的作用是实行com.foo.bean.BlogMapper.queryAllBlogInfo 定义的SQL语句，返回一个List结果集。总的来说，上述代码履历了三个阶段：

  • mybatis初始化
  • 创建SqlSession
  • 实行SQL语句
上述代码的功能是根据配置文件mybatis-config.xml 配置文件，创建SqlSessionFactory对象，然后产生SqlSession，实行SQL语句。而mybatis的初始化就发生在第三句：SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
那么第三句到底发生了什么。
MyBatis初始化基本过程

SqlSessionFactoryBuilder根据传入的数据流生成Configuration对象，然后根据Configuration对象创建默认的SqlSessionFactory实例。
初始化的基本过程如下序列图所示：

由上图所示，mybatis初始化要颠末简单的以下几步：

  • 调用SqlSessionFactoryBuilder对象的build(inputStream)方法；
  • SqlSessionFactoryBuilder会根据输入流inputStream等信息创建XMLConfigBuilder对象;
  • SqlSessionFactoryBuilder调用XMLConfigBuilder对象的parse()方法；
  • XMLConfigBuilder对象返回Configuration对象；
  • SqlSessionFactoryBuilder根据Configuration对象创建一个DefaultSessionFactory对象；
  • SqlSessionFactoryBuilder返回 DefaultSessionFactory对象给Client，供Client使用。
SqlSessionFactoryBuilder相关的代码如下所示：
  1. public SqlSessionFactory build(InputStream inputStream)  {  
  2.     return build(inputStream, null, null);  
  3. }  
  5. public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties)  {  
  6.     try  {  
  7.         //2. 创建XMLConfigBuilder对象用来解析XML配置文件，生成Configuration对象  
  8.         XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);  
  9.         //3. 将XML配置文件内的信息解析成Java对象Configuration对象  
  10.         Configuration config = parser.parse();  
  11.         //4. 根据Configuration对象创建出SqlSessionFactory对象  
  12.         return build(config);  
  13.     } catch (Exception e) {  
  14.         throw ExceptionFactory.wrapException("Error building SqlSession.", e);  
  15.     } finally {  
  16.         ErrorContext.instance().reset();  
  17.         try {  
  18.             inputStream.close();  
  19.         } catch (IOException e) {  
  20.             // Intentionally ignore. Prefer previous error.  
  21.         }  
  22.     }
  23. }
  25. // 从此处可以看出，MyBatis内部通过Configuration对象来创建SqlSessionFactory,用户也可以自己通过API构造好Configuration对象，调用此方法创SqlSessionFactory  
  26. public SqlSessionFactory build(Configuration config) {  
  27.     return new DefaultSqlSessionFactory(config);  
  28. }  
复制代码
上述的初始化过程中，涉及到了以下几个对象：

  • SqlSessionFactoryBuilder ： SqlSessionFactory的构造器，用于创建SqlSessionFactory，采用了Builder设计模式
  • Configuration ：该对象是mybatis-config.xml文件中所有mybatis配置信息
  • SqlSessionFactory：SqlSession工厂类，以工厂形式创建SqlSession对象，采用了Factory工厂设计模式
  • XmlConfigParser ：负责将mybatis-config.xml配置文件解析成Configuration对象，共SqlSessonFactoryBuilder使用，创建SqlSessionFactory
创建Configuration对象的过程

接着上述的 MyBatis初始化基本过程讨论，当SqlSessionFactoryBuilder实行build()方法，调用了XMLConfigBuilder的parse()方法，然后返回了Configuration对象。那么parse()方法是如何处理XML文件，生成Configuration对象的呢？


  • XMLConfigBuilder会将XML配置文件的信息转换为Document对象
而XML配置定义文件DTD转换成XMLMapperEntityResolver对象，然后将二者封装到XpathParser对象中，XpathParser的作用是提供根据Xpath表达式获取基本的DOM节点Node信息的操作。如下图所示：



  • 之后XMLConfigBuilder调用parse()方法
会从XPathParser中取出节点对应的Node对象，然后解析此Node节点的子Node：properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers：
  1. public Configuration parse() {  
  2.     if (parsed) {  
  3.         throw new BuilderException("Each XMLConfigBuilder can only be used once.");  
  4.     }  
  5.     parsed = true;  
  6.     //源码中没有这一句，只有 parseConfiguration(parser.evalNode("/configuration"));  
  7.     //为了让读者看得更明晰，源码拆分为以下两句  
  8.     XNode configurationNode = parser.evalNode("/configuration");  
  9.     parseConfiguration(configurationNode);  
  10.     return configuration;  
  11. }  
  12. /**
  13. * 解析 "/configuration"节点下的子节点信息，然后将解析的结果设置到Configuration对象中
  14. */  
  15. private void parseConfiguration(XNode root) {  
  16.     try {  
  17.         //1.首先处理properties 节点     
  18.         propertiesElement(root.evalNode("properties")); //issue #117 read properties first  
  19.         //2.处理typeAliases  
  20.         typeAliasesElement(root.evalNode("typeAliases"));  
  21.         //3.处理插件  
  22.         pluginElement(root.evalNode("plugins"));  
  23.         //4.处理objectFactory  
  24.         objectFactoryElement(root.evalNode("objectFactory"));  
  25.         //5.objectWrapperFactory  
  26.         objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));  
  27.         //6.settings  
  28.         settingsElement(root.evalNode("settings"));  
  29.         //7.处理environments  
  30.         environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631  
  31.         //8.database  
  32.         databaseIdProviderElement(root.evalNode("databaseIdProvider"));  
  33.         //9.typeHandlers  
  34.         typeHandlerElement(root.evalNode("typeHandlers"));  
  35.         //10.mappers  
  36.         mapperElement(root.evalNode("mappers"));  
  37.     } catch (Exception e) {  
  38.         throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);  
  39.     }  
  40. }
复制代码
注意：在上述代码中，另有一个非常重要的地方，就是解析XML配置文件子节点的方法mapperElements(root.evalNode("mappers")), 它将解析我们配置的Mapper.xml配置文件，Mapper配置文件可以说是MyBatis的核心，MyBatis的特性和理念都体如今此Mapper的配置和设计上。

  • 然后将这些值解析出来设置到Configuration对象中
解析子节点的过程这里就不一一介绍了，用户可以参照MyBatis源码仔细揣摩，我们就看上述的environmentsElement(root.evalNode("environments")); 方法是如何将environments的信息解析出来，设置到Configuration对象中的：
  1. /**
  2. * 解析environments节点，并将结果设置到Configuration对象中
  3. * 注意：创建envronment时，如果SqlSessionFactoryBuilder指定了特定的环境（即数据源）；
  4. *      则返回指定环境（数据源）的Environment对象，否则返回默认的Environment对象；
  5. *      这种方式实现了MyBatis可以连接多数据源
  6. */  
  7. private void environmentsElement(XNode context) throws Exception {  
  8.     if (context != null)  
  9.     {  
  10.         if (environment == null)  
  11.         {  
  12.             environment = context.getStringAttribute("default");  
  13.         }  
  14.         for (XNode child : context.getChildren())  
  15.         {  
  16.             String id = child.getStringAttribute("id");  
  17.             if (isSpecifiedEnvironment(id))  
  18.             {  
  19.                 //1.创建事务工厂 TransactionFactory  
  20.                 TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));  
  21.                 DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));  
  22.                 //2.创建数据源DataSource  
  23.                 DataSource dataSource = dsFactory.getDataSource();  
  24.                 //3. 构造Environment对象  
  25.                 Environment.Builder environmentBuilder = new Environment.Builder(id)  
  26.                 .transactionFactory(txFactory)  
  27.                 .dataSource(dataSource);  
  28.                 //4. 将创建的Envronment对象设置到configuration 对象中  
  29.                 configuration.setEnvironment(environmentBuilder.build());  
  30.             }  
  31.         }  
  32.     }  
  33. }
  35. private boolean isSpecifiedEnvironment(String id)  
  36. {  
  37.     if (environment == null)  
  38.     {  
  39.         throw new BuilderException("No environment specified.");  
  40.     }  
  41.     else if (id == null)  
  42.     {  
  43.         throw new BuilderException("Environment requires an id attribute.");  
  44.     }  
  45.     else if (environment.equals(id))  
  46.     {  
  47.         return true;  
  48.     }  
  49.     return false;  
  50. }
复制代码

  • 返回Configuration对象
将上述的MyBatis初始化基本过程的序列图细化：

基于Java API

当然可以使用XMLConfigBuilder手动解析XML配置文件来创建Configuration对象，代码如下：
  1. String resource = "mybatis-config.xml";  
  2. InputStream inputStream = Resources.getResourceAsStream(resource);  
  3. // 手动创建XMLConfigBuilder，并解析创建Configuration对象  
  4. XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null); // 看这里
  5. Configuration configuration = parser.parse();  
  6. // 使用Configuration对象创建SqlSessionFactory  
  7. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);  
  8. // 使用MyBatis  
  9. SqlSession sqlSession = sqlSessionFactory.openSession();  
  10. List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");  
复制代码
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

正序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

莱莱

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表