Mybatis之XML映射文件

红太狼 2022-05-13 04:22 250阅读 0赞

MyBatis 针对 SQL 构建，真正强大在于它的映射语句。  
SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：  
*cache* – 给定命名空间的缓存配置。  
*cache-ref*– 其他命名空间缓存配置的引用。  
*resultMap* – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。  
*sql* – 可被其他语句引用的可重用语句块。  
*insert* – 映射插入语句  
*update* – 映射更新语句  
*delete* – 映射删除语句  
*select* – 映射查询语句  
\- **Sql**  
sql用来定义可以重用的SQL代码段,可以包含在其他语句中(即在重复使用某一个代码段的时候可以使用sql)。比如：

<sql id="userColumns">id,username,password</sql>

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

<select id="selectUsers" resultType="com.mybatis.User">
        select <include refid="userColumns"/>
        from user where id=#{id}
    </select>

属性值也可以被用在 include 元素的 refid 属性里：

例如：

**定义id为someinclude的Sql片段：**
    <sql id="someinclude">
      from
        <include refid="${target}"/>
    </sql>
    **重用id为someinclude的Sql片段，并获取它的值，形成完整的Sql语句：**
    <select id="select" resultType="map">
      select
        field1, field2, field3
      <include refid="someinclude">
        <property name="target" value="sometable"/>
      </include>
    </select>

**-Select**  
查询语句是 MyBatis 中最常用的元素之一，就是将数据从数据库重新取出。对每个插入、更新或删除操作，通常对应多个查询操作。这是 MyBatis 的基本原则之一，也是将焦点和努力放到查询和结果映射的原因。例如：

<select id="selectUser" parameterType="int" resultType="java.util.Map">
      SELECT * FROM PERSON WHERE ID = #{id}
    </select>

这个语句被称作 selectUser (id=”selectUser”)，接受一个 int（或 Integer）类型的参数，并返回一个 Map类型的对象，其中的键是列名，值便是结果行中的对应值。 **(切记，\#\{id\} 后面不需要加标点符号)**  
注意参数符号：\#\{id\}  
这样MyBatis 会创建一个预处理语句参数，这个参数在 SQL 中会由一个“?”来标识，并被传递到一个新的预处理语句中，结果：

String selectUser= "SELECT * FROM User WHERE ID=?"; PreparedStatement ps = conn.prepareStatement(selectUser); ps.setInt(1,id);

select 语句属性配置细节：  
![这里写图片描述][70]  
\- **insert**  
数据变更语句 insert，update 和 delete 的实现非常接近，都没有resultType或是resultMap返回结果的设置，只有输入参数的设置。

一个简单的insert例子：

<insert id="insertStudent" parameterType="com.mybatis.Student"> 
        INSERT INTO STUDENT (STUDENT_ID, 
                         STUDENT_NAME, 
                        STUDENT_SEX) 
           VALUES  (#{studentID}, 
                 #{studentName}, 
                #{studentSex}) 
    </insert>

**insert使用数据库支持的自动生成主键策略：**  
Mybatis 配置文件 useGeneratedKeys 参数只针对 insert 语句生效，默认为 false。当设置为 true 时，表示如果插入的表以自增列为主键，则允许 JDBC 支持自动生成主键，并可将自动生成的主键返回。(设置useGeneratedKeys=”true”，然后把keyProperty 设成对应的列.)  
**Error：**如果是 Oracle 这样不支持自增主键列的数据库，如果把useGeneratedKeys 参数配置为 true，在插入多条数据时则可能会出现 ORA-00933: SQL command not properly ended  
**修改：**这时，可以将 useGeneratedKeys 配置为 false，或者为了保证兼容性，使用 mybatis 提供的 selectKey 手动提供类似自增序列的效果。

<insert id="insertStudent" parameterType="com.mybatis.Student"> 
      <selectKey keyProperty="studentID" resultType="_long" order="BEFORE"> 
          select CAST(RANDOM * 100000 as INTEGER) a FROM SYSTEM.SYSDUMMY1 
      </selectKey> 
        INSERT INTO STUDENT (STUDENT_ID, 
                     STUDENT_NAME, 
                     STUDENT_SEX) 
           VALUES  (#{studentID}, 
                #{studentName}, 
                #{studentSex})   
    </insert>

insert语句属性配置细节：  
![这里写图片描述][70 1]  
selectKey语句属性配置细节：  
![这里写图片描述][70 2]  
\- **update 和 delete**  
一个简单的update例子：

<update id="updateStudent" parameterType="com.mybatis.Student"> 
        UPDATE STUDENT 
          SET STUDENT_NAME = #{studentName},  
              STUDENT_SEX = #{studentSex}
        WHERE STUDENT_ID = #{studentID}  
    </update>

一个简单的delete例子：

<delete id="deleteStudent" parameterType="com.mybatis.Student"> 
        DELETE FROM STUDENT WHERE STUDENT_ID = #{studentID} 
    </delete>

update、delete语句属性配置细节：  
![这里写图片描述][70 3]  
\- **参数（Parameters）**

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

此示例是一个简单的命名参数映射，参数类型为int。原生的类型或简单数据类型（比如整型和字符串）因为没有相关属性，它会完全用参数值来替代，**并且只能提供一个参数**。

如果是复杂的命名参数映射，则需要使用Java实体类，或Map类型做参数类型。通过\#\{\}可以直接得到其属性。比如：  
**Java实体类型参数：**

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

如果 User 类型的参数对象传递到了语句中，id、username 和 password 属性将会被查找，然后将它们的值传入预处理语句的参数中。  
**Map类型参数：**

<select id="getStudentByMap" parameterType="Map" resultMap="com.mybatis.Student"> 
      SELECT * from STUDENT 
       WHERE STUDENT_NAME = #{name} 
         AND STUDENT_SEX = #{sex} 
    </select>

**多参数类型实现：**  
如果想传入多个参数，则需要在接口的参数上添加@Param注解。例如：  
接口注解@Param添加：

public List<Student> getStudentListByParam(@Param(value = "name") String name, @Param(value = "sex") String sex);

SQL语句：

<select id="getStudentListByParam" resultMap="com.mybatis.Student"> 
      SELECT * from STUDENT 
      <where> 
        <if test="name!=null and name!='' "> 
          STUDENT_NAME LIKE CONCAT(CONCAT('%', #{name}),'%') 
        </if> 
        <if test="sex!= null and sex!= '' "> 
          AND STUDENT_SEX = #{sex} 
        </if>
      </where> 
    </select>

**- 字符串替换**  
默认情况下,使用 \#\{\} 格式的语法会导致 MyBatis 创建 PreparedStatement 参数并安全地设置参数（就像使用 ? 一样）。这样做更安全，更迅速，通常也是首选做法，不过有时你就是想直接在 SQL 语句中插入一个不转义的字符串。比如，像 ORDER BY，你可以这样来使用：

ORDER BY ${columnName}

这里 MyBatis 不会修改或转义字符串。  
用这种方式接受用户的输入，并将其用于语句中的参数是不安全的，会导致潜在的 SQL 注入攻击，因此要么不允许用户输入这些字段，要么自行转义并检验。  
\- **缓存**  
MyBatis 包含一个非常强大的查询缓存特性,它可以非常方便地配置和定制。MyBatis 3 中的缓存实现的很多改进都已经实现了,使得它更加强大而且易于配置。

默认情况下是没有开启缓存的,除了局部的 session 缓存,可以增强变现而且处理循环 依赖也是必须的。要开启二级缓存,你需要在你的 SQL 映射文件中添加一行:

字面上看就是这样。这个简单语句的效果如下:

映射语句文件中的所有 select 语句将会被缓存。  
映射语句文件中的所有 insert,update 和 delete 语句会刷新缓存。  
缓存会使用 Least Recently Used(LRU,最近最少使用的)算法来收回。  
根据时间表(比如 no Flush Interval,没有刷新间隔), 缓存不会以任何时间顺序 来刷新。  
缓存会存储列表集合或对象(无论查询方法返回什么)的 1024 个引用。  
缓存会被视为是 read/write(可读/可写)的缓存,意味着对象检索不是共享的,而 且可以安全地被调用者修改,而不干扰其他调用者或线程所做的潜在修改。

所有的这些属性都可以通过缓存元素的属性来修改。比如:  
创建一个FIFO 缓存让60 秒就清空一次，存储512 个对象结果或列表引用，并且返回的结果是只读。因为在不用的线程里的两个调用者修改它们可能会导致引用冲突。

**使用自定义缓存：**  
除了这些自定义缓存的方式, 你也可以通过实现你自己的缓存或为其他第三方缓存方案 创建适配器来完全覆盖缓存行为。

这个示 例展 示了 如何 使用 一个 自定义 的缓 存实 现。type 属 性指 定的 类必 须实现 org.mybatis.cache.Cache 接口。这个接口是 MyBatis 框架中很多复杂的接口之一,但是简单给定它做什么就行。

public interface Cache { 
      String getId();
      int getSize();
      void putObject(Object key, Object value);
      Object getObject(Object key);
      boolean hasKey(Object key);
      Object removeObject(Object key);
      void clear();
    }

要配置你的缓存, 简单和公有的 JavaBeans 属性来配置你的缓存实现, 而且是通过 cache 元素来传递属性, 比如, 下面代码会在你的缓存实现中调用一个称为 “setCacheFile(String file)” 的方法:

你可以使用所有简单类型作为 JavaBeans 的属性,MyBatis 会进行转换。 And you can specify a placeholder(e.g. $\{cache.file\}) to replace value defined at configuration properties.

从3.4.2版本开始，MyBatis已经支持在所有属性设置完毕以后可以调用一个初始化方法。如果你想要使用这个特性，请在你的自定义缓存类里实现 org.apache.ibatis.builder.InitializingObject 接口。

public interface InitializingObject {
      void initialize() throws Exception;
    }

记得缓存配置和缓存实例是绑定在 SQL 映射文件的命名空间是很重要的。因此,所有 在相同命名空间的语句正如绑定的缓存一样。 语句可以修改和缓存交互的方式, 或在语句的 语句的基础上使用两种简单的属性来完全排除它们。默认情况下,语句可以这样来配置:

因为那些是默认的,你明显不能明确地以这种方式来配置一条语句。相反,如果你想改 变默认的行为,只能设置 flushCache 和 useCache 属性。比如,在一些情况下你也许想排除 从缓存中查询特定语句结果,或者你也许想要一个查询语句来刷新缓存。相似地,你也许有 一些更新语句依靠执行而不需要刷新缓存。

[70]: /images/20220513/ead68c0971d34f07ab0f6c22a74f5a40.png
[70 1]: /images/20220513/6fa3a93546d94223adb7b2c47dd5aa2b.png
[70 2]: /images/20220513/8b13952ff72646c6a3ee78f6050e85c8.png
[70 3]: /images/20220513/86f34554291d49e6aa0d1f019e7de193.png