MyBatis之配置解析

MyBatis之配置解析

一、核心配置文件

MyBatis的核心配置文件为mybatis-config.xml，此配置文件是设置MyBatis 行为和属性信息。该文件配置了 MyBatis 的一些全局信息，包含数据库连接信息和 MyBatis 运行时所需的各种特性，以及设置和影响 MyBatis 行为的一些属性。

 configuration（配置）
     properties（属性）
     settings（设置）
     typeAliases（类型别名）
     typeHandlers（类型处理器）
     objectFactory（对象工厂）
     plugins（插件）
     environments（环境配置）
         environment（环境变量）
             transactionManager（事务管理器）
             dataSource（数据源）
     databaseIdProvider（数据库厂商标识）
     mappers（映射器）
 <!-- 注意元素节点的顺序！顺序不对会报错 -->

• configuration 元素是整个 XML 配置文件的根节点，其角色就相当于是 MyBatis 的总管， MyBatis 所有的配置信息都会存放在它里面。 MyBatis 还提供了设置这些配置信息的方法。 Configuration 可从配置文件里获取属性值，也可以通过程序直接设置。

• mybatis-config.xml 文件的元素节点是有一定顺序的，节点位置若不按顺序排位，那么 XML 文件会报错。

Configuration 可供配置的内容如下。

• properties 元素：properties 元素描述的都是外部化、可替代的属性。数据库这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。

1. 在资源目录下新建一个db.properties

    driver=com.mysql.jdbc.Driver
    url=jdbc:mysql://localhost:3306/mybatis?
    use SSL=true&use Unicode=true&character Encoding=utf8
    username=root
    password=123456

2. 将文件导入properties 配置文件

    <configuration>
        <!--导入properties文件-->
        <properties resource="db.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="mapper/Mapper.xml"/>
        </mappers>
    </configuration>

• settings 元素：作用是设置一些非常重要的设置选项，用于设置和改变 MyBatis 运行中的行为。

   <settings>
     <setting name="cacheEnabled" value="true"/>
     <setting name="lazyLoadingEnabled" value="true"/>
     <setting name="multipleResultSetsEnabled" value="true"/>
     <setting name="useColumnLabel" value="true"/>
     <setting name="useGeneratedKeys" value="false"/>
     <setting name="autoMappingBehavior" value="PARTIAL"/>
     <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
     <setting name="defaultExecutorType" value="SIMPLE"/>
     <setting name="defaultStatementTimeout" value="25"/>
     <setting name="defaultFetchSize" value="100"/>
     <setting name="safeRowBoundsEnabled" value="false"/>
     <setting name="mapUnderscoreToCamelCase" value="false"/>
     <setting name="localCacheScope" value="SESSION"/>
     <setting name="jdbcTypeForNull" value="OTHER"/>
     <setting name="lazyLoadTriggerMethods" value="equals,clone,hash Code,toString"/>
   </settings>

• typeAliases 元素：typeAliases 元素的作用是配置类型别名，通过与 MyBatis 的 SQL 映射文件相关联，减少输入多余的完整类名，以简化操作。

   <!--配置别名,注意顺序,这样配置时， User 可以用在任何使用 com.mybatis.pojo.User 的地方。-->
   <type Aliases>
       <typeAlias type="com.mybatis.pojo.User" alias="User"/>
   </type Aliases>
   ​

  也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如:

   <type Aliases>
       <package name="com.mybatis.pojo"/>
   </type Aliases>

  若有注解，则别名为其注解值。见下面的例子：

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

• environments 元素：表示配置 MyBatis 的多套运行环境，MyBatis 可以配置多套运行环境，如开发环境、测试环境、生产环境等，我们可以灵活选择不同的配置，从而将 SQL 映射应用到不同的数据库环境上。因为毎个数据库都是对应一个 SqlSessionFactorγ 实例的，需要指明哪个运行环境将被创建，并把运行环境中设置的参数传递给 SqlSessionFactoryBuilder，所以必须要明确选择出当前的唯一一个运行环境。

 <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>

1. 子元素节点：transactionManager - [ 事务管理器 ]

2. 子元素节点：数据源（dataSource）,使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源:

   1. unpooled： 这个数据源的实现只是每次被请求时打开和关闭连接。

   2. pooled： 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来 , 这是一种使得并发 Web 应用快速响应请求的流行处理方式。

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

• mappers 元素：定义映射SQL语句文件，要定义 SQL 映射语句，首先我们需要告诉 MyBatis 到哪里去找到这些语句。 Java 在自动查找这方面没有提供一个很好的方法，所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用， 或完全限定资源定位符（包括 file:/// 的 URL），或类名和包名等。映射器是MyBatis中最核心的组件之一，在MyBatis 3之前，只支持xml映射器，即：所有的SQL语句都必须在xml文件中配置。而从MyBatis 3开始，还支持接口映射器，这种映射器方式允许以Java代码的方式注解定义SQL 语句，非常简洁。在 <mappers> 中有两个子元素 <package> 、<mapper> ，用来定义 SQL 的映射语句，我们只需要告诉 MyBatis 去哪里找到这些 SQL 语句（即去哪里找相应的 SQL 映射文件），整个项目中可以有1个或多个SQL 映射文件。

1. 引入资源方式

    <!-- 使用相对于类路径的资源引用 -->
    <mappers>
      <mapper resource="org/mybatis/builder/PostMapper.xml"/>
    </mappers>
    <!-- 使用完全限定资源定位符（URL） -->
    <mappers>
      <mapper url="file:///var/mappers/AuthorMapper.xml"/>
    </mappers>
    <!-- 
    使用映射器接口实现类的完全限定类名,
    需要配置文件名称和接口名称一致，并且位于同一目录下
    -->
    <mappers>
      <mapper class="org.mybatis.builder.AuthorMapper"/>
    </mappers>
    <!-- 
    将包内的映射器接口实现全部注册为映射器
    但是需要配置文件名称和接口名称一致，并且位于同一目录下
    -->
    <mappers>
      <package name="org.mybatis.builder"/>
    </mappers>

2. Mapper文件:

    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper
            PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.mybatis.mapper.Mapper"> 
    </mapper>

   1. namespace和子元素的id联合保证唯一 , 区别不同的mapper

   2. 绑定DAO接口，namespace的命名必须跟某个接口同名，接口中的方法与映射文件中sql语句id应该一一对应。

   3. namespace命名规则 : 包名+类名。

二、生命周期和作用域

作用域（Scope）和生命周期：不同作用域和生命周期类是至关重要的，因为错误的使用会导致非常严重的并发问题。

Mybatis的执行过程流程图，分析一下：

• SqlSessionFactoryBuilder 的作用在于创建 SqlSessionFactory，创建成功后，SqlSessionFactoryBuilder 就失去了作用，所以它只能存在于创建 SqlSessionFactory 的方法中，因此SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。

• SqlSessionFactory 可以被认为是一个数据库连接池，它的作用是创建 SqlSession 接口对象。因为 MyBatis 的本质就是 Java 对数据库的操作，所以 SqlSessionFactory 的生命周期存在于整个 MyBatis 的应用之中，所以一旦创建了 SqlSessionFactory，就要长期保存它，直至不再使用 MyBatis 应用，所以可以认为 SqlSessionFactory 的生命周期就等同于 MyBatis 的应用周期。

• 由于 SqlSessionFactory 是一个对数据库的连接池，所以它占据着数据库的连接资源。如果创建多个 SqlSessionFactory，那么就存在多个数据库连接池，这样不利于对数据库资源的控制，也会导致数据库连接资源被消耗光，出现系统宕机等情况，所以尽量避免发生这样的情况。

• 在一般的应用中我们往往希望 SqlSessionFactory 作为一个单例，让它在应用中被共享。所以SqlSessionFactory 的最佳作用域是应用作用域。

• 如果SqlSessionFactory 相当于数据库连接池，那么 SqlSession 就相当于一个数据库连接（Connection 对象），你可以在一个事务里面执行多条 SQL，然后通过它的 commit、rollback 等方法，提交或者回滚事务。所以它应该存活在一个业务请求中，处理完整个请求后，应该关闭这条连接，让它归还给 SqlSessionFactory，否则数据库资源就很快被耗费精光，系统就会瘫痪，所以用 try...catch...finally... 语句来保证其正确关闭。SqlSession 的最佳的作用域是请求或方法作用域。