深刻淺出Mybatis系列（三）---配置詳解之properties與environments（mybatis源碼篇）

時間 2019-11-20

標籤深刻 mybatis 系列配置詳解 properties environments 源碼欄目 MyBatis 简体版

原文原文鏈接

　　上篇文章《深刻淺出Mybatis系列（二）---配置簡介（mybatis源碼篇）》咱們經過對mybatis源碼的簡單分析，可看出，在mybatis配置文件中，在configuration根節點下面，可配置properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers這些節點。那麼本次，就會先介紹properties節點和environments節點。html

　　爲了讓你們可以更好地閱讀mybatis源碼，我先簡單的給你們示例一下properties的使用方法。　　java

 1 <configuration>
 2 <!-- 方法一： 從外部指定properties配置文件, 除了使用resource屬性指定外，還可經過url屬性指定url  
 3   <properties resource="dbConfig.properties"></properties> 
 4   -->
 5   <!-- 方法二： 直接配置爲xml -->
 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   </properties>

　　那麼，我要是兩種方法都同時用了，那麼哪一種方法優先？mysql

　　當以上兩種方法都xml配置優先，外部指定properties配置其次。至於爲何，接下來的源碼分析會提到，請留意一下。sql

　　再看一下envirements元素節點的使用方法吧：數據庫

<environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
          <!--
          若是上面沒有指定數據庫配置的properties文件，那麼此處能夠這樣直接配置 
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/test1"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
         -->
         
         <!-- 上面指定了數據庫配置文件， 配置文件裏面也是對應的這四個屬性 -->
         <property name="driver" value="${driver}"/>
         <property name="url" value="${url}"/>
         <property name="username" value="${username}"/>
         <property name="password" value="${password}"/>
         
      </dataSource>
    </environment>
    
    <!-- 我再指定一個environment -->
    <environment id="test">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <!-- 與上面的url不同 -->
        <property name="url" value="jdbc:mysql://localhost:3306/demo"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
      </dataSource>
    </environment>
    
  </environments>

　　environments元素節點能夠配置多個environment子節點，怎麼理解呢？ mybatis

　　假如咱們系統的開發環境和正式環境所用的數據庫不同（這是確定的），那麼能夠設置兩個environment, 兩個id分別對應開發環境（dev）和正式環境（final），那麼經過配置environments的default屬性就能選擇對應的environment了，例如，我將environments的deault屬性的值配置爲dev, 那麼就會選擇dev的environment。至於這個是怎麼實現的，下面源碼就會講。app

　　好啦，上面簡單給你們介紹了一下properties 和 environments 的配置，接下來就正式開始看源碼了：ide

　　上次咱們說過mybatis 是經過XMLConfigBuilder這個類在解析mybatis配置文件的，那麼本次就接着看看XMLConfigBuilder對於properties和environments的解析：源碼分析

XMLConfigBuilder：post

  1 public class XMLConfigBuilder extends BaseBuilder {
  2 
  3     private boolean parsed;
  4     //xml解析器
  5     private XPathParser parser;
  6     private String environment;
  7   
  8     //上次說到這個方法是在解析mybatis配置文件中能配置的元素節點
  9     //今天首先要看的就是properties節點和environments節點
 10     private void parseConfiguration(XNode root) {
 11         try {
 12           //解析properties元素
 13           propertiesElement(root.evalNode("properties")); //issue #117 read properties first
 14           typeAliasesElement(root.evalNode("typeAliases"));
 15           pluginElement(root.evalNode("plugins"));
 16           objectFactoryElement(root.evalNode("objectFactory"));
 17           objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
 18           settingsElement(root.evalNode("settings"));
 19           //解析environments元素
 20           environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631
 21           databaseIdProviderElement(root.evalNode("databaseIdProvider"));
 22           typeHandlerElement(root.evalNode("typeHandlers"));
 23           mapperElement(root.evalNode("mappers"));
 24         } catch (Exception e) {
 25           throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
 26         }
 27     }
 28   
 29     
 30     //下面就看看解析properties的具體方法
 31     private void propertiesElement(XNode context) throws Exception {
 32         if (context != null) {
 33           //將子節點的 name 以及value屬性set進properties對象
 34           //這兒能夠注意一下順序，xml配置優先， 外部指定properties配置其次
 35           Properties defaults = context.getChildrenAsProperties();
 36           //獲取properties節點上 resource屬性的值
 37           String resource = context.getStringAttribute("resource");
 38           //獲取properties節點上 url屬性的值, resource和url不能同時配置
 39           String url = context.getStringAttribute("url");
 40           if (resource != null && url != null) {
 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.");
 42           }
 43           //把解析出的properties文件set進Properties對象
 44           if (resource != null) {
 45             defaults.putAll(Resources.getResourceAsProperties(resource));
 46           } else if (url != null) {
 47             defaults.putAll(Resources.getUrlAsProperties(url));
 48           }
 49           //將configuration對象中已配置的Properties屬性與剛剛解析的融合
 50           //configuration這個對象會裝載所解析mybatis配置文件的全部節點元素，之後也會頻頻提到這個對象
 51           //既然configuration對象用有一系列的get/set方法， 那是否就標誌着咱們可使用java代碼直接配置？ 
 52           //答案是確定的， 不過使用配置文件進行配置，優點不言而喻
 53           Properties vars = configuration.getVariables();
 54           if (vars != null) {
 55             defaults.putAll(vars);
 56           }
 57           //把裝有解析配置propertis對象set進解析器， 由於後面可能會用到
 58           parser.setVariables(defaults);
 59           //set進configuration對象
 60           configuration.setVariables(defaults);
 61         }
 62     }
 63     
 64     //下面再看看解析enviroments元素節點的方法
 65     private void environmentsElement(XNode context) throws Exception {
 66         if (context != null) {
 67             if (environment == null) {
 68                 //解析environments節點的default屬性的值
 69                 //例如: <environments default="development">
 70                 environment = context.getStringAttribute("default");
 71             }
 72             //遞歸解析environments子節點
 73             for (XNode child : context.getChildren()) {
 74                 //<environment id="development">, 只有enviroment節點有id屬性，那麼這個屬性有何做用？
 75                 //environments 節點下能夠擁有多個 environment子節點
 76                 //相似於這樣： <environments default="development"><environment id="development">...</environment><environment id="test">...</environments>
 77                 //意思就是咱們能夠對應多個環境，好比開發環境，測試環境等， 由environments的default屬性去選擇對應的enviroment
 78                 String id = child.getStringAttribute("id");
 79                 //isSpecial就是根據由environments的default屬性去選擇對應的enviroment
 80                 if (isSpecifiedEnvironment(id)) {
 81                     //事務， mybatis有兩種：JDBC 和 MANAGED, 配置爲JDBC則直接使用JDBC的事務，配置爲MANAGED則是將事務託管給容器， 
 82                     TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
 83                     //enviroment節點下面就是dataSource節點了，解析dataSource節點（下面會貼出解析dataSource的具體方法）
 84                     DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
 85                     DataSource dataSource = dsFactory.getDataSource();
 86                     Environment.Builder environmentBuilder = new Environment.Builder(id)
 87                           .transactionFactory(txFactory)
 88                           .dataSource(dataSource);
 89                     //老規矩，會將dataSource設置進configuration對象
 90                     configuration.setEnvironment(environmentBuilder.build());
 91                 }
 92             }
 93         }
 94     }
 95     
 96     //下面看看dataSource的解析方法
 97     private DataSourceFactory dataSourceElement(XNode context) throws Exception {
 98         if (context != null) {
 99             //dataSource的鏈接池
100             String type = context.getStringAttribute("type");
101             //子節點 name, value屬性set進一個properties對象
102             Properties props = context.getChildrenAsProperties();
103             //建立dataSourceFactory
104             DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance();
105             factory.setProperties(props);
106             return factory;
107         }
108         throw new BuilderException("Environment declaration requires a DataSourceFactory.");
109     } 
110 }

　　經過以上對mybatis源碼的解讀，相信你們對mybatis的配置又有了一個深刻的認識。

　　還有一個問題，上面咱們看到，在配置dataSource的時候使用了 ${driver} 這種表達式，這種形式是怎麼解析的？其實，是經過PropertyParser這個類解析：

PropertyParser：

/**
 * 這個類解析${}這種形式的表達式
 */
public class PropertyParser {

  public static String parse(String string, Properties variables) {
    VariableTokenHandler handler = new VariableTokenHandler(variables);
    GenericTokenParser parser = new GenericTokenParser("${", "}", handler);
    return parser.parse(string);
  }

  private static class VariableTokenHandler implements TokenHandler {
    private Properties variables;

    public VariableTokenHandler(Properties variables) {
      this.variables = variables;
    }

    public String handleToken(String content) {
      if (variables != null && variables.containsKey(content)) {
        return variables.getProperty(content);
      }
      return "${" + content + "}";
    }
  }
}