Mybatis配置解析

一、Mybatis核心配置文件

核心配置文件：mybatis-config.xml

MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 配置文档的顶层结构如下：

configuration（配置）
properties（属性）
settings（设置）
typeAliases（类型别名）
typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins（插件）
environments（环境配置）
environment（环境变量）
transactionManager（事务管理器）
dataSource（数据源）
databaseIdProvider（数据库厂商标识）
mappers（映射器）

二、环境配置（environments）

mybatis可以配置多套环境使用，将SQL映射到不同的数据库中。比如开发、测试和生产环境的数据库不同，需要不同的配置。但是，尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。有多少个环境，就需要多少个SqlSessionFactory实例。

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

将environment作为参数传入，实例化不同的factory。如果忽略了环境参数，那么将会加载默认环境。

<!--    default为默认使用的环境-->
    <environments default="development">
<!--        id为development的环境-->
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="org.postgresql.Driver"/>
                <property name="url" value="jdbc:postgresql://127.0.0.1:5432/postgres?useSSL=false"/>
                <property name="username" value="postgres"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
<!--        id为test的环境-->
        <environment id="test">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED"></dataSource>
            ...
        </environment>
    </environments>

事务管理器（transactionManager） 有两种配置： type=“[JDBC|MANAGED]”

• JDBC：使用了 JDBC 的提交和回滚设施。
• MANAGED ： 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。

数据源（dataSource） 有三种类型：type=“[UNPOOLED|POOLED|JNDI]”

• UNPOOLED– 这个数据源的实现会每次请求时打开和关闭连接。
• POOLED– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。默认的是这个。
• JNDI – 这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用。

三、属性（properties）

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。

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

也即是property标签的value可以通过外部来配置来动态改变。

编写一个db.properties

driver=org.postgresql.Driver
url=jdbc:postgresql://127.0.0.1:5432/postgres?useSSL=false
username=postgres
password=123456

在核心配置文件中添加<properties>标签，但是这里有一个问题，xml中的标签不是随便添加的，必须要有一个先后顺序，因为加载的时候是从头开始加载的。

在mybatis的核心配置中引入db.properties和修改环境配置中的<property>标签如下：

<configuration>
    <properties resource="db.properties">
<!--        <property name="username" value="dev_user"/>-->
<!--        <property name="password" value="F2Fa3!33TYyg"/>-->
    </properties>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <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>
    <mappers>
        <mapper resource="com/hjxlog/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

这时候${driver},${url}等值将从db.properties文件中读取。

同时，也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值。

如果这三个地方都有配置属性值，mybatis的读取顺序是：

1. 先读取<properties>标签中的<property>属性值；

2. 再读取<properties resource="db.properties">引入的db.properties的属性值，如果有相同的，会用db.properties的值覆盖<property>的；

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

另外，还可以使用默认值，就是加入需要读取的属性没有读取到，就使用默认值：

<dataSource type="POOLED">
  <!-- ... -->
  <property name="username" value="${username:ut_user}"/> <!-- 如果属性 'username' 没有被配置，'username' 属性的值将为 'ut_user' -->
</dataSource>

但是使用默认值的前提是需要开启默认值特性，即：

    <properties resource="db.properties">
<!--        <property name="username" value="dev_user"/>-->
<!--        <property name="password" value="F2Fa3!33TYyg"/>-->
        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 启用默认值特性 -->
    </properties>

四、类型别名（typeAliases）

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

4.1 在Mybatis核心配置文件中配置

这里的配置是在Mybatis的核心配置文件中配置的。

    <typeAliases>
        <typeAlias alias="User" type="com.hjxlog.domain.User"/>
    </typeAliases>

将Java类的全路径替换成一个别名，在xml使用。

4.2 扫描包

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，使用 Bean 的首字母小写的非限定类名来作为它的别名。

    <typeAliases>
        <package name="com.hjxlog.domain"/>
    </typeAliases>

4.3 注解

使用注解的形式起别名：

@Alias("theUser")
public class User {
}

    <select id="selectUserList" resultType="theUser">
        select * from public.user
    </select>

其中，mybatis核心配置文件中配置优先级最高，开启包扫描后，如果还有另外配置注解，则以注解为准。

Java类型的别名，如果在前面加下划线_，映射的是基本类型，如果没有加下划线，映射的是包装类型。

五、设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。

了解几个常用的：

• cacheEnabled：全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。
• lazyLoadingEnabled： 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。
• useGeneratedKeys：允许 JDBC 支持自动生成主键，需要数据库驱动支持。
• mapUnderscoreToCamelCase：是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。
• logImpl：指定 MyBatis 所用日志的具体实现，未指定时将自动查找。

六、映射器（mappers）

映射器就是告诉 MyBatis 到哪里去找到这些语句。

方式一：

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

方式二：

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

方式三：

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

注意：

• 接口和mapper文件必须同名
• 接口和mapper文件在同一个包下

方式四：

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