Mybatis 中 XML 配置汇总

淡淡的烟草味﹌ 2023-06-07 15:29 4阅读 0赞

# mybatic-config #

#### 属性（properties） ####

这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。例如：

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

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

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

从 MyBatis 3.4.2 开始，你可以为占位符指定一个默认值。例如：

这个特性默认是关闭的。如果你想为占位符指定一个默认值， 你应该添加一个指定的属性来开启这个特性。例如：

#### 设置（settings） ####

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

一个配置完整的 settings 元素的示例如下：

#### 类型别名（typeAliases） ####

类型别名是为 Java 类型设置一个短的名字。 它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。例如：

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

#### 类型处理器（typeHandlers） ####

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

可以实现 `org.apache.ibatis.type.TypeHandler` 接口， 或继承一个很便利的类 `org.apache.ibatis.type.BaseTypeHandler`实现自定义的类型处理器。

#### 插件（plugins） ####

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

*  Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
 *  ParameterHandler (getParameterObject, setParameters)
 *  ResultSetHandler (handleResultSets, handleOutputParameters)
 *  StatementHandler (prepare, parameterize, batch, update, query)

例子：

// ExamplePlugin.java
    @Intercepts({ @Signature(
      type= Executor.class,
      method = "update",
      args = { MappedStatement.class,Object.class})})
    public class ExamplePlugin implements Interceptor { 
      private Properties properties = new Properties();
      public Object intercept(Invocation invocation) throws Throwable { 
        // implement pre processing if need
        Object returnObject = invocation.proceed();
        // implement post processing if need
        return returnObject;
      }
      public void setProperties(Properties properties) { 
        this.properties = properties;
      }
    }

<plugins>
      <plugin interceptor="org.mybatis.example.ExamplePlugin">
        <property name="someProperty" value="100"/>
      </plugin>
    </plugins>

上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用， Executor 是负责执行低层映射语句的内部对象。

#### 环境配置（environments） ####

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；

**不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。**

所以，如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。

**每个数据库对应一个 SqlSessionFactory 实例**

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

注意这里的关键点:

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

一定要保证默认的环境 ID 要匹配其中一个环境 ID。

**事务管理器（transactionManager）**

在 MyBatis 中有两种类型的事务管理器（也就是 type=”\[JDBC|MANAGED\]”）：

*  JDBC – 这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
 *  MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。例如:

> 如果你正在使用 Spring + MyBatis，则没有必要配置事务管理器， 因为 Spring 模块会使用自带的管理器来覆盖前面的配置。

**数据源（dataSource）**

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

*  许多 MyBatis 的应用程序会按示例中的例子来配置数据源。虽然这是可选的，但为了使用延迟加载，数据源是必须配置的。

有三种内建的数据源类型（也就是 type=”\[UNPOOLED|POOLED|JNDI\]”）：

**UNPOOLED**– 这个数据源的实现只是每次被请求时打开和关闭连接。

**POOLED**– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。

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

#### 映射器（mappers） ####

可以使用相对于类路径的资源引用， 或完全限定资源定位符（包括 `file:///` 的 URL），或类名和包名等来查找映射文件。例如：

<mappers>
      <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
      <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
      <mapper resource="org/mybatis/builder/PostMapper.xml"/>
    </mappers>

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

这些配置会告诉了 MyBatis 去哪里找映射文件.

# mybatic-mapper #

#### 结果映射（resultMap） ####

*  constructor
    
    用于在实例化类时，注入结果到构造方法中
    
     *  `idArg` \- ID 参数；标记出作为 ID 的结果可以帮助提高整体性能
     *  `arg` \- 将被注入到构造方法的一个普通结果
 *  id – 一个 ID 结果；标记出作为 ID 的结果可以帮助提高整体性能
 *  result – 注入到字段或 JavaBean 属性的普通结果
 *  association
    
    一个复杂类型的关联；许多结果将包装成这种类型
    
     *  关联的嵌套 Select 查询
        
            <resultMap id="blogResult" type="Blog">
              <association property="author" column="author_id" javaType="Author" select="selectAuthor"/>
            </resultMap>
            
            <select id="selectAuthor" resultType="Author">
              SELECT * FROM AUTHOR WHERE ID = #{id}
            </select>
     *  关联的嵌套结果映射
        
            <resultMap id="blogResult" type="Blog">
              <id property="id" column="blog_id" />
              <result property="title" column="blog_title"/>
              <association property="author" javaType="Author">
                <id property="id" column="author_id"/>
                <result property="username" column="author_username"/>
                <result property="password" column="author_password"/>
                <result property="email" column="author_email"/>
                <result property="bio" column="author_bio"/>
              </association>
            </resultMap>
        
        **非常重要**： id 元素在嵌套结果映射中扮演着非常重要的角色。你应该总是指定一个或多个可以唯一标识结果的属性。 虽然，即使不指定这个属性，MyBatis 仍然可以工作，但是会产生严重的**性能问题**。 只需要指定可以唯一标识结果的最少属性。显然，你可以选择主键（复合主键也可以）。
 *  collection  
    一个复杂类型的集合
    
     *  集合的嵌套 Select 查询
        
            <resultMap id="blogResult" type="Blog">
              <collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/>
            </resultMap>
            
            <select id="selectBlog" resultMap="blogResult">
              SELECT * FROM BLOG WHERE ID = #{id}
            </select>
            
            <select id="selectPostsForBlog" resultType="Post">
              SELECT * FROM POST WHERE BLOG_ID = #{id}
            </select>
        
        `ofType` 属性：将 JavaBean（或字段）属性的类型和集合存储的类型区分开来
        
            <collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/>
        
        读作：posts 是一个存储 Post 的 ArrayList 集合
        
        在一般情况下，MyBatis 可以推断 javaType 属性，因此并不需要填写。所以很多时候你可以简略成：
        
            <collection property="posts" column="id" ofType="Post" select="selectPostsForBlog"/>
     *  集合的嵌套结果映射
        
        使用嵌套 Select 查询来为博客加载文章。
        
            <select id="selectBlog" resultMap="blogResult">
              select
              B.id as blog_id,
              B.title as blog_title,
              B.author_id as blog_author_id,
              P.id as post_id,
              P.subject as post_subject,
              P.body as post_body,
              from Blog B
              left outer join Post P on B.id = P.blog_id
              where B.id = #{id}
            </select>
            
            <resultMap id="blogResult" type="Blog">
              <id property="id" column="blog_id" />
              <result property="title" column="blog_title"/>
              <collection property="posts" ofType="Post">
                <id property="id" column="post_id"/>
                <result property="subject" column="post_subject"/>
                <result property="body" column="post_body"/>
              </collection>
            </resultMap>
        
        更详略的、可重用的结果映射，可以使用下面的等价形式：
        
            <resultMap id="blogResult" type="Blog">
              <id property="id" column="blog_id" />
              <result property="title" column="blog_title"/>
              <collection property="posts" ofType="Post" resultMap="blogPostResult" columnPrefix="post_"/>
            </resultMap>
            
            <resultMap id="blogPostResult" type="Post">
              <id property="id" column="id"/>
              <result property="subject" column="subject"/>
              <result property="body" column="body"/>
            </resultMap>

#### 自动映射 ####

当自动映射查询结果时，MyBatis 会获取结果中返回的列名并在 Java 类中查找相同名字的属性（忽略大小写）。

通常数据库列使用大写字母组成的单词命名，单词间用下划线分隔；而 Java 属性一般遵循驼峰命名法约定。为了在这两种命名方式之间启用自动映射，需要将 `mapUnderscoreToCamelCase` 设置为 true。

> mapUnderscoreToCamelCase 默认为 false

自动映射和手动映射可以共存，在自动映射处理完毕后，再处理手动映射。在下面的例子中，*id* 和 *userName* 列将被自动映射，*hashed\_password* 列将根据配置进行映射。

<resultMap id="userResultMap" type="User">
      <result property="password" column="hashed_password"/>
    </resultMap>
    
    <select id="selectUsers" resultMap="userResultMap">
      select
        user_id             as "id",
        user_name           as "userName",
        hashed_password
      from some_table
      where id = #{id}
    </select>

#### 缓存 ####

默认情况下，只启用了本地的会话缓存（一级缓存），它仅仅对一个会话中的数据进行缓存。 要启用全局的二级缓存，只需要在你的 SQL 映射文件中添加一行：

基本上就是这样。这个简单语句的效果如下:

*  映射语句文件中的所有 select 语句的结果将会被缓存。
 *  映射语句文件中的所有 insert、update 和 delete 语句会刷新缓存。
 *  缓存会使用最近最少使用算法（LRU, Least Recently Used）算法来清除不需要的缓存。
 *  缓存不会定时进行刷新（也就是说，没有刷新间隔）。
 *  缓存会保存列表或对象（无论查询方法返回哪种）的 1024 个引用。
 *  缓存会被视为读/写缓存，这意味着获取到的对象并不是共享的，可以安全地被调用者修改，而不干扰其他调用者或线程所做的潜在修改。

> 缓存只作用于 cache 标签所在的映射文件中的语句。

![Snipaste\_2019-10-15\_15-51-10.jpg][Snipaste_2019-10-15_15-51-10.jpg]

这些属性可以通过 cache 元素的属性来修改。

这个更高级的配置创建了一个 FIFO 缓存，每隔 60 秒刷新，最多可以存储结果对象或列表的 512 个引用，而且返回的对象被认为是只读的，因此对它们进行修改可能会在不同线程中的调用者产生冲突。

可用的清除策略有：

*  `LRU` – 最近最少使用：移除最长时间不被使用的对象。
 *  `FIFO` – 先进先出：按对象进入缓存的顺序来移除它们。
 *  `SOFT` – 软引用：基于垃圾回收器状态和软引用规则移除对象。
 *  `WEAK` – 弱引用：更积极地基于垃圾收集器状态和弱引用规则移除对象。

默认的清除策略是 LRU。

flushInterval（刷新间隔）属性可以被设置为任意的正整数，设置的值应该是一个以毫秒为单位的合理时间量。 默认情况是不设置，也就是没有刷新间隔，缓存仅仅会在调用语句时刷新。

size（引用数目）属性可以被设置为任意正整数，要注意欲缓存对象的大小和运行环境中可用的内存资源。默认值是 1024。

readOnly（只读）属性可以被设置为 true 或 false。只读的缓存会给所有调用者返回缓存对象的相同实例。 因此这些对象不能被修改。这就提供了可观的性能提升。而可读写的缓存会（通过序列化）返回缓存对象的拷贝。 速度上会慢一些，但是更安全，因此默认值是 false。

> 二级缓存是事务性的。这意味着，当 SqlSession 完成并提交时，或是完成并回滚，但没有执行 flushCache=true 的 insert/delete/update 语句时，缓存会获得更新。

###### 使用自定义缓存 ######