mybatis源碼配置文件解析之一：解析properties標籤

mybatis做爲平常開發的經常使用ORM框架，在開發中起着很重要的做用，瞭解其源碼對平常的開發有很大的幫助。源碼版本爲：3-3.4.x，可執行到github進行下載。

從這篇文章開始逐一分析mybatis的核心配置文件（mybatis-config.xml），今天先來看properties標籤的解析過程。

1、概述

在單獨使用mybatis的時候，mybatis的核心配置文件（mybatis-config.xml）就顯的特別重要，是整個mybatis運行的基礎，只有把配置文件中的各個標籤正確解析後才能夠正確使用mybatis，下面看properties標籤的配置，properties標籤的做用就是加載properties文件或者property標籤，下面看其具體配置，實例以下

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

上面是配置的properties標籤的配置，在標籤中配置了resource屬性和property子標籤。下面看具體的解析流程，這裏分析properties標籤的解析過程，啓動流程暫不說，直接看解析的代碼。

2、詳述

上面，看到了properties標籤的配置，下面看其解析方法，這裏只粘貼部分代碼，下面是parseConfiguration方法的代碼，

private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
      //解析properties標籤    
      propertiesElement(root.evalNode("properties"));
      //解析settings標籤
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      //解析別名標籤，例<typeAlias alias="user" type="cn.com.bean.User"/>
      typeAliasesElement(root.evalNode("typeAliases"));
      //解析插件標籤
      pluginElement(root.evalNode("plugins"));
      //解析objectFactory標籤，此標籤的做用是mybatis每次建立結果對象的新實例時都會使用ObjectFactory，若是不設置
      //則默認使用DefaultObjectFactory來建立，設置以後使用設置的
      objectFactoryElement(root.evalNode("objectFactory"));
      //解析objectWrapperFactory標籤
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      //解析reflectorFactory標籤
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      // read it after objectFactory and objectWrapperFactory issue #631
      //解析environments標籤
      environmentsElement(root.evalNode("environments"));
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      //解析<mappers>標籤
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

從上面的代碼中能夠找到下面的代碼，即爲解析的代碼，

propertiesElement(root.evalNode("properties"));

這個方法就是解析properties標籤，下面看具體的解析過程。

一、解析子標籤和屬性

/**
 * 解析mybatis-config.xml文件中的properties標籤
 *<properties resource="org/mybatis/example/config.properties">
 *<property name="username" value="dev_user"/>
 *<property name="password" value="F2Fa3!33TYyg"/>
 *</properties>
 *解析步驟：
 *一、解析配置的property標籤，放到defaults中；
 *二、解析resource或url屬性，放到defaults中；
 *三、獲取configuration中的variables變量值，放到defaults中
 * @param context
 * @throws Exception
 */
  private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
      //一、讀取properties標籤中的property標籤<property name="" value=""/>
      Properties defaults = context.getChildrenAsProperties();
      //二、讀取properties標籤中的resource、url屬性
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      //resource和url屬性不能同時出如今properties標籤中
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }
      //若是resource不爲空，則解析爲properties，放到defaults中，因爲defaults是key-value結構，因此會覆蓋相同key的值
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {//若是url不爲空，則解析爲properties，放到defaults中，因爲defaults是key-value結構，因此會覆蓋相同key的值
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      //三、得到configuration中的variables變量的值，此變量能夠經過SqlSessionFactoryBuilder.build()傳入properties屬性值
      Properties vars = configuration.getVariables();
      //若是調用build的時候傳入了properties屬性，放到defaults中
      if (vars != null) {
        defaults.putAll(vars);
      }
      //放到parser和configuration對象中
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }

從上面的解析過程能夠看到，首先解析properties標籤的子標籤，也就是property標籤，經過下面的方法得到，

//一、讀取properties標籤中的property標籤<property name="" value=""/>
      Properties defaults = context.getChildrenAsProperties();

解析property標籤，並放到Properties對象中。那麼是如何防盜Properties對象中的那，在getChildrenAsProperties方法中，

public Properties getChildrenAsProperties() {
    Properties properties = new Properties();
    for (XNode child : getChildren()) {
      String name = child.getStringAttribute("name");
      String value = child.getStringAttribute("value");
      if (name != null && value != null) {
        properties.setProperty(name, value);
      }
    }
    return properties;
  }

能夠看出是循環property標籤，得到其name和value屬性，並放入properties對象中。

接着解析properties的resource和url屬性，以下

//二、讀取properties標籤中的resource、url屬性
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");

分別得到resource和url屬性，這裏這兩個屬性都是一個路徑。

二、處理屬性

下面看這個判斷，

//resource和url屬性不能同時出如今properties標籤中
      if (resource != null && url != null) {
        throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");
      }

這個判斷代表在properties標籤中，resource和url屬性不能同時出現。

2.一、處理resource和url屬性

下面看resource和url屬性的處理，這裏resource和url兩個屬性都是表明的一個路徑，因此這裏確定是須要讀取相應路徑下的文件。

//若是resource不爲空，則解析爲properties，放到defaults中，因爲defaults是key-value結構，因此會覆蓋相同key的值
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {//若是url不爲空，則解析爲properties，放到defaults中，因爲defaults是key-value結構，因此會覆蓋相同key的值
        defaults.putAll(Resources.getUrlAsProperties(url));
      }

下面看對resource的處理，調用的Resources.getResourceAsProperties(resource))方法，對resource進行處理，

public static Properties getResourceAsProperties(String resource) throws IOException {
    Properties props = new Properties();
    InputStream in = getResourceAsStream(resource);
    props.load(in);
    in.close();
    return props;
  }

從上面的代碼能夠看出是要轉化爲InputStream，最後放到Properties對象中，這裏加載文件的詳細過程，後面再詳細分析。

下面看對url的處理，調用Resources.getUrlAsProperties(url)方法，對url進行處理，

public static Properties getUrlAsProperties(String urlString) throws IOException {
    Properties props = new Properties();
    InputStream in = getUrlAsStream(urlString);
    props.load(in);
    in.close();
    return props;
  }

上面的代碼依然是把url表明的文件處理成Properties對象。

2.三、處理已添加的Properties

在上面處理完property子標籤、resource和url屬性後，還進行了下面的處理，即從configuration中得到properties，

//三、得到configuration中的variables變量的值，此變量能夠經過SqlSessionFactoryBuilder.build()傳入properties屬性值
      Properties vars = configuration.getVariables();
      //若是調用build的時候傳入了properties屬性，放到defaults中
      if (vars != null) {
        defaults.putAll(vars);
      }

若是configuration中已經存在properties信息，則取出來，放到defaults中。

2.四、放入configuration對象中

通過上面的處理，最後把全部的properties信息放到configuration中，

//放到parser和configuration對象中
      parser.setVariables(defaults);
      configuration.setVariables(defaults);

把defaults放到了configuration的variables屬性中，表明的是整個mybatis環境中全部的properties信息。這個信息能夠在mybatis的配置文件中使用${key}使用，好比，${username}，則會從configuration的variables中尋找key爲username的屬性值，並完成自動屬性值替換。

3、總結

上面分析了properties標籤的解析過程，先解析property標籤，而後是resource、url屬性，最後是生成SqlSessionFactory的使用調用SqlSessionFactoryBuilder的build方法，傳入的properties，從上面的解析過程，能夠知道若是存在重複的鍵，那麼最早解析的會被後面解析的覆蓋掉，也就是解析過程是：property子標籤-->resource-->url-->開發者設置的，那麼覆蓋過程爲：開發者設置的-->url-->resource-->property子標籤，優先級最高的爲開發者本身設置的properties屬性。

 

原創不易，有不正之處歡迎指正。