mybatis trim标签的使用

╰+哭是因爲堅強的太久メ 2022-05-20 02:12 225阅读 0赞

<table> 
 <tbody> 
  <tr> 
   <td><font>mybatis的<strong>trim</strong>标签一般用于去除sql语句中多余的and关键字，逗号，或者给sql语句前拼接 “where“、“set“以及“values(“ 等前缀，或者添加“)“等后缀，可用于选择性插入、更新、删除或者条件查询等操作。</font></td> 
  </tr> 
 </tbody> 
</table>

--------------------

以下是trim标签中涉及到的属性：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>prefix</td> 
   <td>给sql语句拼接的前缀</td> 
  </tr> 
  <tr> 
   <td>suffix</td> 
   <td>给sql语句拼接的后缀</td> 
  </tr> 
  <tr> 
   <td>prefixOverrides</td> 
   <td>去除sql语句前面的关键字或者字符，该关键字或者字符由prefixOverrides属性指定，假设该属性指定为"AND"，当sql语句的开头为"AND"，trim标签将会去除该"AND"</td> 
  </tr> 
  <tr> 
   <td>suffixOverrides</td> 
   <td>去除sql语句后面的关键字或者字符，该关键字或者字符由suffixOverrides属性指定</td> 
  </tr> 
 </tbody> 
</table>

下面使用几个例子来说明trim标签的使用。

--------------------

## 1、使用trim标签去除多余的and关键字 ##

有这样的一个例子：

<select id="findActiveBlogLike"
         resultType="Blog">
      SELECT * FROM BLOG 
      WHERE 
      <if test="state != null">
        state = #{state}
      </if> 
      <if test="title != null">
        AND title like #{title}
      </if>
      <if test="author != null and author.name != null">
        AND author_name like #{author.name}
      </if>
    </select>

如果这些条件没有一个能匹配上会发生什么？最终这条 SQL 会变成这样：

SELECT * FROM BLOG
    WHERE

这会导致查询失败。如果仅仅第二个条件匹配又会怎样？这条 SQL 最终会是这样:

SELECT * FROM BLOG
    WHERE 
    AND title like ‘someTitle’

你可以使用where标签来解决这个问题，where 元素只会在至少有一个子元素的条件返回 SQL 子句的情况下才去插入“WHERE”子句。而且，若语句的开头为“AND”或“OR”，where 元素也会将它们去除。

<select id="findActiveBlogLike"
         resultType="Blog">
      SELECT * FROM BLOG 
      <where> 
        <if test="state != null">
             state = #{state}
        </if> 
        <if test="title != null">
            AND title like #{title}
        </if>
        <if test="author != null and author.name != null">
            AND author_name like #{author.name}
        </if>
      </where>
    </select>

trim标签也可以完成相同的功能，写法如下：

<trim prefix="WHERE" prefixOverrides="AND">
    	<if test="state != null">
    	  state = #{state}
    	</if> 
    	<if test="title != null">
    	  AND title like #{title}
    	</if>
    	<if test="author != null and author.name != null">
    	  AND author_name like #{author.name}
    	</if>
    </trim>

--------------------

## 2、使用trim标签去除多余的逗号 ##

有如下的例子：  
![这里写图片描述][70]

如果红框里面的条件没有匹配上，sql语句会变成如下：

INSERT INTO role(role_name,) VALUES(roleName,)

插入将会失败。  
使用trim标签可以解决此问题，只需做少量的修改，如下所示：  
![这里写图片描述][70 1]

其中最重要的属性是

suffixOverrides=","

表示去除sql语句结尾多余的逗号.

--------------------

注：如果你有兴趣的话，可以研究下Mybatis逆向工程生成的Mapper文件。其中也使用了trim标签，但结合了foreach、choose等标签，更多的是牵扯到Criterion的源码研究。不过研究完之后，你将熟练掌握mybatis各种标签的使用，学到Criterion的设计思想，对自己的启发将会很大。

--------------------

如果想要了解更多关余trim标签的内容，请移步《trim标签源码解析》。本文参考 [Mybatis官方文档][Mybatis]

[70]: /images/20220520/abd40e0bd0524f379fb42ce999e392e2.png
[70 1]: /images/20220520/37689703b80e413dba16da9231b6bee7.png
[Mybatis]: http://www.mybatis.org/mybatis-3/zh/dynamic-sql.html