Mybatis全局配置文件解析

一、全局配置文件解析

mybatis官方中文文档：

https://mybatis.org/mybatis-3/zh/index.html

本文主要分析的是

• setings设置
• properties设置
• typeAliases（类型别名）设置
• typeHandlers（类型处理器）设置

• 环境配置（environments）设置

• 数据源（dataSource）设置

• 数据库厂商标识（databaseIdProvider）设置（移植性）

• 映射器（mappers）

1、properties设置

mybatis可以使用properties来引入外部的properties配置文件的内容。

引入方式有两种：

resource：引入类路径下的资源:  <properties resource=""></properties>

url:引用网络路径或者磁盘路径下的资源:<properties url="db.properties"></properties>

读取规则：

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

• 首先读取在 properties 元素体内指定的属性。
• 然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
• 最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

实例：

/*******************db.properties*******************/
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/qccr_okr?characterEncoding=utf-8
jdbc.username=root
jdbc.password=123456

/*******************mybatis-config.xml*******************/
<configuration>
    <!--
    1、mybatis可以使用properties来引入外部的properties配置文件的内容
      resource：引入类路径下的资源
      url:引用网络路径或者磁盘路径下的资源
    -->
    <properties resource="db.properties"></properties>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

2、setings设置

如： 

1.   cacheEnabled：全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。
2.    useGeneratedKeys：允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键，     默认为false。
3.    mapUnderscoreToCamelCase：是否开启驼峰命名自动映射.

           等。

实例：

<settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="cacheEnabled" value="true"/>
        <setting name="useGeneratedKeys" value="false"/>
</settings>

3、typeAliases（类型别名）设置

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。

两种设置方式：

一种是基于xml标签方式进行设置。

一种是基于注解的方式进行设置。

实例：

/*****类别名设置：当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方****/
<typeAliases>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
</typeAliases>

/*****也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean****/
比如：
<typeAliases>
  <package name="domain.blog"/>
</typeAliases>
会搜索每一个在包 domain.blog 中的 Java Bean

/***********还可以用直接方式来起别名**********/
@Alias("author")
public class Author {
    ...
}

4、类型处理器（typeHandlers）设置

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。

下表描述了一些默认的类型处理器：

你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型：

1、实现 org.apache.ibatis.type.TypeHandler 接口

2、继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler。

<!-- mybatis-config.xml -->
<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

5、环境配置（environments）设置

environments 元素定义了如何配置环境。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

标签解释：

• 默认使用的环境 ID（比如：default="development"）。
• 每个 environment 元素定义的环境 ID（比如：id="development"）。
• 事务管理器的配置（比如：type="JDBC"）。
• 数据源的配置（比如：type="POOLED"）。

       默认环境和环境 ID 顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

事务管理器（transactionManager）:

1、JDBC:直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。

2、MANAGED:这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。

<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>

3、定义 MyBatis 对事务的处理：实现TransactionFactory接口和Transaction来实现自定义。

6、数据源（dataSource）设置

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。

有三种内建的数据源类型：

UNPOOLED：这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。

POOLED： 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。

JNDI：这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。

7、数据库厂商标识（databaseIdProvider）设置（移植性）

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。 如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。 为支持多厂商特性，只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

实例：

8、映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要来定义 SQL 映射语句了。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。

<!-- 使用相对于类路径的资源引用 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- 使用完全限定资源定位符（URL） -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>