一起来学习Mybatis（三）-配置文件之properties 属性

前言

  上篇文章《一起来学习Mybatis（二）-初始化配置分析》，我们提到在Mybatis配置文件的根元素<configuration>下，有11个二级元素：properties、settings、typeAliases、plugins、objectFactory、objectWrapperFactory、reflectorFactory、environments、databaseIdProvider、typeHandlers、mappers。 这里不会将重点放在所有元素上，会选择经常用到的几个元素结合源码进行分析，今天就来看看<properties>属性。

分析

  对于properties，大家都不会陌生，在Java应用程序开发中，通常用Properties属性文件来保存数据源的连接信息。现在就以一个数据源连接的属性配置为例，来看看properties是如何起作用的。

Java properties 文件

  先用我们熟悉的Java 属性文件添加一个MySQL数据源的驱动与连接地址，文件名为 jdbc.properties：

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306

Mybatis properties 元素

  在 <properties >元素下分别添加用户名与密码的<propertie>元素，实质上还是一个一个的键值对。

<properties resource="jdbc.properties">
  <property name="username" value="test_user"/>
  <property name="password" value="mybatistest"/>
</properties>

  <properties >的 resource 属性可以添加外部属性文件，正如我们在上面添加的 jdbc.properties 属性文件。

这里的 jdbc.properties 添加到了classpath下，因此无需使用它的完全路径

Mybatis dataSource

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

  ${}表明这些value值都会被动态替换。整个属性值的读取顺序为：properties 属性体内的属性值 -> jdbc.properties -> dataSource 的属性值。还记得在上一篇文章中提到的 SqlSessionFactoryBuilder类在构建SqlSessionFactory时，build方法中的参数吗，property 属性值还可以作为参数直接传递。

public SqlSessionFactory build(Reader reader, String environment, Properties properties) {};
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {};

  由此，可以知道，通过方法参数传递的属性具有最高优先级，resource后者url 属性中指定的配置文件次之，最低优先级的是 properties 属性中指定的属性。

源码

  根据上一篇源码的分析，能够知道XML文件中的properties元素是由 propertiesElement方法来解析的。

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

  进入propertiesElement 方法体：

  private void propertiesElement(XNode context) throws Exception {
    if (context != null) {
      //首先读取properties 属性体内的属性值
      Properties defaults = context.getChildrenAsProperties();
      String resource = context.getStringAttribute("resource");
      String url = context.getStringAttribute("url");
      //注意，properties元素的resource与url属性同时只能选其一
      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.");
      }
      if (resource != null) {
        defaults.putAll(Resources.getResourceAsProperties(resource));
      } else if (url != null) {
        defaults.putAll(Resources.getUrlAsProperties(url));
      }
      //获取build方法中传递的属性值
      Properties vars = configuration.getVariables();
      if (vars != null) {
        defaults.putAll(vars);
      }
      parser.setVariables(defaults);
      configuration.setVariables(defaults);
    }
  }

  可以看得出，这三者是顺序执行的，如果有重复的属性，后面执行的方法则会覆盖掉之前方法读取的属性值。

小结

  优先级关系如下：

1. properties 元素体内指定的属性首先被读取。

2. 然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。

3. 最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。