mybatis详解-(6)配置文件

怼烎@ 2022-06-02 23:53 283阅读 0赞

前面几节中介绍了mybatis的helloworld操作。在配置文件中也添加了一些配置，比如`<properties>`,`<settings>`，但是到底有哪些配置呢，并不清楚。本节介绍一下两个配置文件的一些标签

# 1主配置文件 #

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

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

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

<properties>
            <property name="mysql.driver" value="com.mysql.jdbc.Driver"/>
            <property name="mysql.url" value="jdbc:mysql://localhost:3306/td_xkd"/>
            <property name="mysql.username" value="root"/>
            <property name="mysql.password" value="1234"/>
        </properties>

其中的属性就可以在整个配置文件中使用来替换需要动态配置的属性值。比如:

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

这个例子中的 username 和 password 将会由 properties 元素中设置的相应值来替换。 driver 和 url 属性将会由 config.properties 文件中对应的值来替换。这样就为配置提供了诸多灵活选择。

属性也可以被传递到 SqlSessionFactoryBuilder.build()方法中。例如：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);
    
    // ... or ...
    
    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

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

在 properties 元素体内指定的属性首先被读取。  
然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。  
最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。  
因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的是 properties 属性中指定的属性。

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

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

你可以使用 “:” 作为属性键(e.g. db:username) 或者你也可以在sql定义中使用 OGNL 表达式的三元运算符(e.g. $\{tableName != null ? tableName : ‘global\_constants’\})， 你应该通过增加一个指定的属性来改变分隔键和默认值的字符。例如：

**settings**  
这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。  
![这里写图片描述][SouthEast]  
![这里写图片描述][SouthEast 1]  
一个配置完整的 settings 元素的示例如下：

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

当这样配置时，Blog可以用在任何使用domain.blog.Blog的地方。

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

每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author；若有注解，则别名为其注解值。看下面的例子：

@Alias("author")
    public class Author { 
        ...
    }

已经为许多常见的 Java 类型内建了相应的类型别名。它们都是大小写不敏感的，需要注意的是由基本类型名称重复导致的特殊处理。

<table> 
 <thead> 
  <tr> 
   <th>别名</th> 
   <th>映射类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>_byte</td> 
   <td>byte</td> 
  </tr> 
  <tr> 
   <td>_long</td> 
   <td>long</td> 
  </tr> 
  <tr> 
   <td>_short</td> 
   <td>short</td> 
  </tr> 
  <tr> 
   <td>_int</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>_integer</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>_double</td> 
   <td>double</td> 
  </tr> 
  <tr> 
   <td>_float</td> 
   <td>float</td> 
  </tr> 
  <tr> 
   <td>_boolean</td> 
   <td>boolean</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>String</td> 
  </tr> 
  <tr> 
   <td>byte</td> 
   <td>Byte</td> 
  </tr> 
  <tr> 
   <td>long</td> 
   <td>Long</td> 
  </tr> 
  <tr> 
   <td>short</td> 
   <td>Short</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>Integer</td> 
  </tr> 
  <tr> 
   <td>integer</td> 
   <td>Integer</td> 
  </tr> 
  <tr> 
   <td>double</td> 
   <td>Double</td> 
  </tr> 
  <tr> 
   <td>float</td> 
   <td>Float</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>Boolean</td> 
  </tr> 
  <tr> 
   <td>date</td> 
   <td>Date</td> 
  </tr> 
  <tr> 
   <td>decimal</td> 
   <td>BigDecimal</td> 
  </tr> 
  <tr> 
   <td>bigdecimal</td> 
   <td>BigDecimal</td> 
  </tr> 
  <tr> 
   <td>object</td> 
   <td>Object</td> 
  </tr> 
  <tr> 
   <td>map</td> 
   <td>Map</td> 
  </tr> 
  <tr> 
   <td>hashmap</td> 
   <td>HashMap</td> 
  </tr> 
  <tr> 
   <td>list</td> 
   <td>List</td> 
  </tr> 
  <tr> 
   <td>arraylist</td> 
   <td>ArrayList</td> 
  </tr> 
  <tr> 
   <td>collection</td> 
   <td>Collection</td> 
  </tr> 
  <tr> 
   <td>iterator</td> 
   <td>Iterator</td> 
  </tr> 
 </tbody> 
</table>

太多了，具体参考[Mybatis官方说明][Mybatis]

# 2映射配置文件 #

Mapper XML 文件  
MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好。

SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：

cache – 给定命名空间的缓存配置。  
cache-ref – 其他命名空间缓存配置的引用。  
resultMap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。  
parameterMap – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。  
sql – 可被其他语句引用的可重用语句块。  
insert – 映射插入语句  
update – 映射更新语句  
delete – 映射删除语句  
select – 映射查询语句  
下一部分将从语句本身开始来描述每个元素的细节。  
**select**  
查询语句是 MyBatis 中最常用的元素之一，光能把数据存到数据库中价值并不大，如果还能重新取出来才有用，多数应用也都是查询比修改要频繁。对每个插入、更新或删除操作，通常对应多个查询操作。这是 MyBatis 的基本原则之一，也是将焦点和努力放到查询和结果映射的原因。简单查询的 select 元素是非常简单的。比如：

<select id="selectPerson" parameterType="int" resultType="hashmap">
      SELECT * FROM PERSON WHERE ID = #{id}
    </select>

这个语句被称作 selectPerson，接受一个 int（或 Integer）类型的参数，并返回一个 HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值。

注意参数符号：

#{id}

这就告诉 MyBatis 创建一个预处理语句参数，通过 JDBC，这样的一个参数在 SQL 中会由一个“?”来标识，并被传递到一个新的预处理语句中，就像这样：

// Similar JDBC code, NOT MyBatis…
    String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
    PreparedStatement ps = conn.prepareStatement(selectPerson);
    ps.setInt(1,id);

当然，这需要很多单独的 JDBC 的代码来提取结果并将它们映射到对象实例中，这就是 MyBatis 节省你时间的地方。我们需要深入了解参数和结果映射，细节部分我们下面来了解。

select 元素有很多属性允许你配置，来决定每条语句的作用细节。

![这里写图片描述][SouthEast 2]

**insert, update 和 delete**  
数据变更语句 insert，update 和 delete 的实现非常接近：

![这里写图片描述][SouthEast 3]  
下面就是 insert，update 和 delete 语句的示例：

<insert id="insertAuthor">
      insert into Author (id,username,password,email,bio)
      values (#{id},#{username},#{password},#{email},#{bio})
    </insert>
    
    <update id="updateAuthor">
      update Author set
        username = #{username},
        password = #{password},
        email = #{email},
        bio = #{bio}
      where id = #{id}
    </update>
    
    <delete id="deleteAuthor">
      delete from Author where id = #{id}
    </delete>

如前所述，插入语句的配置规则更加丰富，在插入语句里面有一些额外的属性和子元素用来处理主键的生成，而且有多种生成方式。

首先，如果你的数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），那么你可以设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性上就OK了。例如，如果上面的 Author 表已经对 id 使用了自动生成的列类型，那么语句可以修改为:

<insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
      insert into Author (username,password,email,bio)
      values (#{username},#{password},#{email},#{bio})
    </insert>

如果你的数据库还支持多行插入, 你也可以传入一个Authors数组或集合，并返回自动生成的主键。

<insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
      insert into Author (username, password, email, bio) values
      <foreach item="item" collection="list" separator=",">
        (#{item.username}, #{item.password}, #{item.email}, #{item.bio})
      </foreach>
    </insert>

对于不支持自动生成类型的数据库或可能不支持自动生成主键 JDBC 驱动来说，MyBatis 有另外一种方法来生成主键。

这里有一个简单（甚至很傻）的示例，它可以生成一个随机 ID（你最好不要这么做，但这里展示了 MyBatis 处理问题的灵活性及其所关心的广度）

<insert id="insertAuthor">
      <selectKey keyProperty="id" resultType="int" order="BEFORE">
        select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
      </selectKey>
      insert into Author
        (id, username, password, email,bio, favourite_section)
      values
        (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
    </insert>

在上面的示例中，selectKey 元素将会首先运行，Author 的 id 会被设置，然后插入语句会被调用。这给你了一个和数据库中来处理自动生成的主键类似的行为，避免了使 Java 代码变得复杂。

selectKey 元素描述如下：

![这里写图片描述][SouthEast 4]

**sql**  
这个元素可以被用来定义可重用的 SQL 代码段，可以包含在其他语句中。它可以被静态地(在加载参数) 参数化. 不同的属性值通过包含的实例变化. 比如：

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

这个 SQL 片段可以被包含在其他语句中，例如：

<select id="selectUsers" resultType="map">
      select
        <include refid="userColumns"><property name="alias" value="t1"/></include>,
        <include refid="userColumns"><property name="alias" value="t2"/></include>
      from some_table t1
        cross join some_table t2
    </select>

属性值可以用于包含的refid属性或者包含的字句里面的属性值，例如：

<sql id="sometable">
      ${prefix}Table
    </sql>
    
    <sql id="someinclude">
      from
        <include refid="${include_target}"/>
    </sql>
    
    <select id="select" resultType="map">
      select
        field1, field2, field3
      <include refid="someinclude">
        <property name="prefix" value="Some"/>
        <property name="include_target" value="sometable"/>
      </include>
    </select>

**参数（Parameters）**  
前面的所有语句中你所见到的都是简单参数的例子，实际上参数是 MyBatis 非常强大的元素，对于简单的做法，大概 90% 的情况参数都很少，比如：

<select id="selectUsers" resultType="User">
      select id, username, password
      from users
      where id = #{id}
    </select>

上面的这个示例说明了一个非常简单的命名参数映射。参数类型被设置为 int，这样这个参数就可以被设置成任何内容。原生的类型或简单数据类型（比如整型和字符串）因为没有相关属性，它会完全用参数值来替代。然而，如果传入一个复杂的对象，行为就会有一点不同了。比如：

<insert id="insertUser" parameterType="User">
      insert into users (id, username, password)
      values (#{id}, #{username}, #{password})
    </insert>

太多了，建议还是看看[Mybatis官方文档][Mybatis 1]

[SouthEast]: /images/20220603/022e5dd3ecb5406191403a0c3060d637.png
[SouthEast 1]: /images/20220603/465648fab20e458ba264797fd289b512.png
[Mybatis]: http://www.mybatis.org/mybatis-3/zh/configuration.html
[SouthEast 2]: /images/20220603/06cfea6adedb43939fb6facb9edb4086.png
[SouthEast 3]: /images/20220603/e1915d0c63f441a1b28cd21210345e4c.png
[SouthEast 4]: /images/20220603/4d14873abf574ae1ac7512e2645c7ca6.png
[Mybatis 1]: http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html#