深入浅出Mybatis系列(三)---配置详解之properties与environments(mybatis源码篇)

本文涉及的产品
RDS MySQL DuckDB 分析主实例,集群系列 4核8GB
RDS MySQL DuckDB 分析主实例,基础系列 4核8GB
RDS AI 助手,专业版
简介:

  上篇文章《深入浅出Mybatis系列(二)---配置简介(mybatis源码篇)》我们通过对mybatis源码的简单分析,可看出,在mybatis配置文件中,在configuration根节点下面,可配置properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers这些节点。那么本次,就会先介绍properties节点和environments节点。

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

复制代码
 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>
复制代码

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

  当以上两种方法都xml配置优先, 外部指定properties配置其次。至于为什么,接下来的源码分析会提到,请留意一下。

  再看一下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子节点, 怎么理解呢? 

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

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

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

XMLConfigBuilder:

复制代码
  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 + "}";
    }
  }
}
复制代码

好啦,以上就是对于properties 和 environments元素节点的分析,比较重要的都在对于源码的注释中标出。本次文章到此结束,接下来的文章会继续分析其他节点的配置。

相关实践学习
如何快速连接云数据库RDS MySQL
本场景介绍如何通过阿里云数据管理服务DMS快速连接云数据库RDS MySQL,然后进行数据表的CRUD操作。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
相关文章
|
5月前
|
XML Java 数据库连接
MyBatis的常见配置
MyBatis 常见配置包括数据库连接、类型别名、映射器等核心模块,合理配置可提升开发效率与系统性能。主要内容涵盖核心配置文件结构、关键配置项详解及配置优先级说明。
582 4
|
11月前
|
Oracle 关系型数据库 Java
【YashanDB知识库】Mybatis-Plus适配崖山配置
【YashanDB知识库】Mybatis-Plus适配崖山配置
|
6月前
|
SQL XML Java
通过MyBatis的XML配置实现灵活的动态SQL查询
总结而言,通过MyBatis的XML配置实现灵活的动态SQL查询,可以让开发者以声明式的方式构建SQL语句,既保证了SQL操作的灵活性,又简化了代码的复杂度。这种方式可以显著提高数据库操作的效率和代码的可维护性。
425 18
|
11月前
|
Java 数据库连接 微服务
微服务——MyBatis配置——事务管理
本段内容主要介绍了事务管理的两种类型:JDBC 和 MANAGED。JDBC 类型直接利用数据源连接管理事务,依赖提交和回滚机制;而 MANAGED 类型则由容器全程管理事务生命周期,例如 JEE 应用服务器上下文,默认会关闭连接,但可根据需要设置 `closeConnection` 属性为 false 阻止关闭行为。此外,提到在使用 Spring + MyBatis 时,无需额外配置事务管理器,因为 Spring 模块自带的功能可覆盖上述配置,且这两种事务管理器类型均无需设置属性。
191 0
|
11月前
|
Java 数据库连接 数据库
微服务——MyBatis配置——多环境配置
在 MyBatis 中,多环境配置允许为不同数据库创建多个 SqlSessionFactory。通过传递环境参数给 SqlSessionFactoryBuilder,可指定使用哪种环境;若忽略,则加载默认环境。`environments` 元素定义环境配置,包括默认环境 ID、事务管理器和数据源类型等。每个环境需唯一标识,确保默认环境匹配其中之一。代码示例展示了如何构建工厂及配置 XML 结构。
185 0
|
11月前
|
缓存 Java 数据库连接
微服务——MyBatis配置——常见配置
本文介绍了 MyBatis 的常见配置及其加载顺序。属性配置优先级为:方法参数传递的属性 &gt; resource/url 属性中配置 &gt; properties 元素中指定属性。同时列举了多个关键配置项,如 `cacheEnabled`(全局缓存开关)、`lazyLoadingEnabled`(延迟加载)、`useGeneratedKeys`(使用 JDBC 自动生成主键)等,并详细说明其作用、有效值及默认值。这些配置帮助开发者优化 MyBatis 的性能与行为。
186 0
|
10月前
|
SQL 存储 Java
Mybatis源码解析:详述初始化过程
以上就是MyBatis的初始化过程,这个过程主要包括SqlSessionFactory的创建、配置文件的解析和加载、映射文件的加载、SqlSession的创建、SQL的执行和SqlSession的关闭。这个过程涉及到了MyBatis的核心类和接口,包括SqlSessionFactory、SqlSessionFactoryBuilder、XMLConfigBuilder、XMLMapperBuilder、Configuration、SqlSession和Executor等。通过这个过程,我们可以看出MyBatis的灵活性和强大性,它可以很好地支持定制化SQL、存储过程以及高级映射,同时也避免了几
201 20
|
11月前
|
Java 数据库连接 数据库
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——MyBatis 介绍和配置
本文介绍了Spring Boot集成MyBatis的方法,重点讲解基于注解的方式。首先简述MyBatis作为持久层框架的特点,接着说明集成时的依赖导入,包括`mybatis-spring-boot-starter`和MySQL连接器。随后详细展示了`properties.yml`配置文件的内容,涵盖数据库连接、驼峰命名规范及Mapper文件路径等关键设置,帮助开发者快速上手Spring Boot与MyBatis的整合开发。
1667 0
|
11月前
|
缓存 Java 数据库连接
MyBatis篇-常见配置
本文介绍了 MyBatis 的常见配置及事务管理相关内容。首先概述了 MyBatis 属性加载顺序,方法参数属性优先级最高。接着列举了几个常见配置属性,如 cacheEnabled、lazyLoadingEnabled 等,并说明其作用与默认值。在多环境配置部分,讲解如何通过 SqlSessionFactoryBuilder 指定环境,以及 environments 元素的配置细节。最后讨论了两种事务管理模式:JDBC 和 MANAGED,分别适用于不同场景,并指出在使用 Spring 模块时无需额外配置事务管理器。
|
缓存 NoSQL Java
Mybatis学习:Mybatis缓存配置
MyBatis缓存配置包括一级缓存(事务级)、二级缓存(应用级)和三级缓存(如Redis,跨JVM)。一级缓存自动启用,二级缓存需在`mybatis-config.xml`中开启并配置映射文件或注解。集成Redis缓存时,需添加依赖、配置Redis参数并在映射文件中指定缓存类型。适用于查询为主的场景,减少增删改操作,适合单表操作且表间关联较少的业务。
268 6