zoukankan      html  css  js  c++  java
  • Mybatis 系列3-结合源码解析properties节点和environments节点

    【Mybatis 系列10-结合源码解析mybatis 执行流程】

    【Mybatis 系列9-强大的动态sql 语句】

    【Mybatis 系列8-结合源码解析select、resultMap的用法】 

    【Mybatis 系列7-结合源码解析核心CRUD配置及用法】

    【Mybatis 系列6-结合源码解析节点配置objectFactory、databaseIdProvider、plugins、mappers】

    【Mybatis 系列5-结合源码解析TypeHandler】 

    【Mybatis 系列4-结合源码解析节点typeAliases】

    【Mybatis 系列3-结合源码解析properties节点和environments节点】

    【Mybatis 系列2-配置文件】

    【Mybatis 系列1-环境搭建】

     

    系列文章 2 中,我们通过对mybatis源码的简单分析,可看出,在mybatis配置文件中,在configuration根节点下面,可配置properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers这些节点。

    那么本次,就会先介绍properties节点和environments节点。

    为了让大家能够更好地阅读mybatis源码,我先简单的给大家示例一下properties的使用方法。

     1 <configuration>
     2  2 <!-- 方法一: 从外部指定properties配置文件, 除了使用resource属性指定外,还可通过url属性指定url  
     3  3   <properties resource="dbConfig.properties"></properties> 
     4  4   -->
     5  5   <!-- 方法二: 直接配置为xml -->
     6  6   <properties>
     7  7       <property name="driver" value="com.mysql.jdbc.Driver"/>
     8  8       <property name="url" value="jdbc:mysql://localhost:3306/test1"/>
     9  9       <property name="username" value="root"/>
    10 10       <property name="password" value="root"/>
    11 11   </properties>

    那么,我要是 两种方法都同时用了,那么哪种方法优先?

    当以上两种方法都xml配置优先, 外部指定properties配置其次。

    为什么呢,接下来的源码分析会提到,请留意一下。

     

    再看一下envirements元素节点的使用方法吧:

     

     1 <environments default="development">
     2     <environment id="development">
     3       <transactionManager type="JDBC"/>
     4       <dataSource type="POOLED">
     5           <!--
     6           如果上面没有指定数据库配置的properties文件,那么此处可以这样直接配置 
     7         <property name="driver" value="com.mysql.jdbc.Driver"/>
     8         <property name="url" value="jdbc:mysql://localhost:3306/test1"/>
     9         <property name="username" value="root"/>
    10         <property name="password" value="root"/>
    11          -->
    12          
    13          <!-- 上面指定了数据库配置文件, 配置文件里面也是对应的这四个属性 -->
    14          <property name="driver" value="${driver}"/>
    15          <property name="url" value="${url}"/>
    16          <property name="username" value="${username}"/>
    17          <property name="password" value="${password}"/>
    18          
    19       </dataSource>
    20     </environment>
    21     
    22     <!-- 我再指定一个environment -->
    23     <environment id="test">
    24       <transactionManager type="JDBC"/>
    25       <dataSource type="POOLED">
    26         <property name="driver" value="com.mysql.jdbc.Driver"/>
    27         <!-- 与上面的url不一样 -->
    28         <property name="url" value="jdbc:mysql://localhost:3306/demo"/>
    29         <property name="username" value="root"/>
    30         <property name="password" value="root"/>
    31       </dataSource>
    32     </environment>
    33     
    34   </environments>

     

    environments元素节点可以配置多个environment子节点, 怎么理解呢?

    假如我们系统的开发环境和正式环境所用的数据库不一样(这是肯定的), 那么可以设置两个environment, 两个id分别对应开发环境(dev)和正式环境(final),那么通过配置environments的default属性就能选择对应的environment了, 例如,我将environments的deault属性的值配置为dev, 那么就会选择dev的environment。

     

    这个是怎么实现的呢?

     

    下面看源码。

    上面简单给大家介绍了一下properties 和 environments 的配置, 接下来就正式开始看源码了:

     

    上次我们说过mybatis 是通过XMLConfigBuilder这个类在解析mybatis配置文件的, 那么本次就接着看看XMLConfigBuilder对于properties和environments的解析:

      1 XMLConfigBuilder:
      2 
      3 public class XMLConfigBuilder extends BaseBuilder {
      4   2 
      5   3     private boolean parsed;
      6   4     //xml解析器
      7   5     private XPathParser parser;
      8   6     private String environment;
      9   7   
     10   8     //上次说到这个方法是在解析mybatis配置文件中能配置的元素节点
     11   9     //今天首先要看的就是properties节点和environments节点
     12  10     private void parseConfiguration(XNode root) {
     13  11         try {
     14  12           //解析properties元素
     15  13           propertiesElement(root.evalNode("properties")); //issue #117 read properties first
     16  14           typeAliasesElement(root.evalNode("typeAliases"));
     17  15           pluginElement(root.evalNode("plugins"));
     18  16           objectFactoryElement(root.evalNode("objectFactory"));
     19  17           objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
     20  18           settingsElement(root.evalNode("settings"));
     21  19           //解析environments元素
     22  20           environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
     23  21           databaseIdProviderElement(root.evalNode("databaseIdProvider"));
     24  22           typeHandlerElement(root.evalNode("typeHandlers"));
     25  23           mapperElement(root.evalNode("mappers"));
     26  24         } catch (Exception e) {
     27  25           throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
     28  26         }
     29  27     }
     30  28   
     31  29     
     32  30     //下面就看看解析properties的具体方法
     33  31     private void propertiesElement(XNode context) throws Exception {
     34  32         if (context != null) {
     35  33           //将子节点的 name 以及value属性set进properties对象
     36  34           //这儿可以注意一下顺序,xml配置优先, 外部指定properties配置其次
     37  35           Properties defaults = context.getChildrenAsProperties();
     38  36           //获取properties节点上 resource属性的值
     39  37           String resource = context.getStringAttribute("resource");
     40  38           //获取properties节点上 url属性的值, resource和url不能同时配置
     41  39           String url = context.getStringAttribute("url");
     42  40           if (resource != null && url != null) {
     43  41             throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
     44  42           }
     45  43           //把解析出的properties文件set进Properties对象
     46  44           if (resource != null) {
     47  45             defaults.putAll(Resources.getResourceAsProperties(resource));
     48  46           } else if (url != null) {
     49  47             defaults.putAll(Resources.getUrlAsProperties(url));
     50  48           }
     51  49           //将configuration对象中已配置的Properties属性与刚刚解析的融合
     52  50           //configuration这个对象会装载所解析mybatis配置文件的所有节点元素,以后也会频频提到这个对象
     53  51           //既然configuration对象用有一系列的get/set方法, 那是否就标志着我们可以使用java代码直接配置? 
     54  52           //答案是肯定的, 不过使用配置文件进行配置,优势不言而喻
     55  53           Properties vars = configuration.getVariables();
     56  54           if (vars != null) {
     57  55             defaults.putAll(vars);
     58  56           }
     59  57           //把装有解析配置propertis对象set进解析器, 因为后面可能会用到
     60  58           parser.setVariables(defaults);
     61  59           //set进configuration对象
     62  60           configuration.setVariables(defaults);
     63  61         }
     64  62     }
     65  63     
     66  64     //下面再看看解析enviroments元素节点的方法
     67  65     private void environmentsElement(XNode context) throws Exception {
     68  66         if (context != null) {
     69  67             if (environment == null) {
     70  68                 //解析environments节点的default属性的值
     71  69                 //例如: <environments default="development">
     72  70                 environment = context.getStringAttribute("default");
     73  71             }
     74  72             //递归解析environments子节点
     75  73             for (XNode child : context.getChildren()) {
     76  74                 //<environment id="development">, 只有enviroment节点有id属性,那么这个属性有何作用?
     77  75                 //environments 节点下可以拥有多个 environment子节点
     78  76                 //类似于这样: <environments default="development"><environment id="development">...</environment><environment id="test">...</environments>
     79  77                 //意思就是我们可以对应多个环境,比如开发环境,测试环境等, 由environments的default属性去选择对应的enviroment
     80  78                 String id = child.getStringAttribute("id");
     81  79                 //isSpecial就是根据由environments的default属性去选择对应的enviroment
     82  80                 if (isSpecifiedEnvironment(id)) {
     83  81                     //事务, mybatis有两种:JDBC 和 MANAGED, 配置为JDBC则直接使用JDBC的事务,配置为MANAGED则是将事务托管给容器, 
     84  82                     TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
     85  83                     //enviroment节点下面就是dataSource节点了,解析dataSource节点(下面会贴出解析dataSource的具体方法)
     86  84                     DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
     87  85                     DataSource dataSource = dsFactory.getDataSource();
     88  86                     Environment.Builder environmentBuilder = new Environment.Builder(id)
     89  87                           .transactionFactory(txFactory)
     90  88                           .dataSource(dataSource);
     91  89                     //老规矩,会将dataSource设置进configuration对象
     92  90                     configuration.setEnvironment(environmentBuilder.build());
     93  91                 }
     94  92             }
     95  93         }
     96  94     }
     97  95     
     98  96     //下面看看dataSource的解析方法
     99  97     private DataSourceFactory dataSourceElement(XNode context) throws Exception {
    100  98         if (context != null) {
    101  99             //dataSource的连接池
    102 100             String type = context.getStringAttribute("type");
    103 101             //子节点 name, value属性set进一个properties对象
    104 102             Properties props = context.getChildrenAsProperties();
    105 103             //创建dataSourceFactory
    106 104             DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance();
    107 105             factory.setProperties(props);
    108 106             return factory;
    109 107         }
    110 108         throw new BuilderException("Environment declaration requires a DataSourceFactory.");
    111 109     } 
    112 110 }

    通过以上对mybatis源码的解读,相信大家对mybatis的配置又有了一个深入的认识。

     

    还有一个问题, 上面我们看到,在配置dataSource的时候使用了 ${driver} 这种表达式

    这种形式是怎么解析的?

     

    其实,是通过PropertyParser这个类解析:

    PropertyParser:

     1 /**
     2  * 这个类解析${}这种形式的表达式
     3  */
     4 public class PropertyParser {
     5 
     6   public static String parse(String string, Properties variables) {
     7     VariableTokenHandler handler = new VariableTokenHandler(variables);
     8     GenericTokenParser parser = new GenericTokenParser("${", "}", handler);
     9     return parser.parse(string);
    10   }
    11 
    12   private static class VariableTokenHandler implements TokenHandler {
    13     private Properties variables;
    14 
    15     public VariableTokenHandler(Properties variables) {
    16       this.variables = variables;
    17     }
    18 
    19     public String handleToken(String content) {
    20       if (variables != null && variables.containsKey(content)) {
    21         return variables.getProperty(content);
    22       }
    23       return "${" + content + "}";
    24     }
    25   }
    26 }

     

    好啦,以上就是对于properties 和 environments元素节点的分析,比较重要的都在对于源码的注释中标出。

    本次文章到此结束,接下来的文章会继续分析其他节点的配置。

  • 相关阅读:
    设计模式
    TCP拥塞控制
    TCP 连接建立和断开,以及状态转换
    python unicode字符串
    python语法笔记(七)
    python语法笔记(六)
    python语法笔记(五)
    python语法笔记(四)
    python语法笔记(三)
    【密码学】公钥与私钥
  • 原文地址:https://www.cnblogs.com/yizhiamumu/p/8996878.html
Copyright © 2011-2022 走看看