Mybatis 的 where 标签，竟然还有这么多不知道的！

背景

在上篇文章，我们系统地学习了where 1=1 相关的知识点，大家可以回看《​​不要再用where 1=1了!有更好的写法!​​》这篇文章。文章中涉及到了Mybatis的替代方案，有好学的朋友在评论区有朋友问了基于Mybatis写法的问题。

于是，就有了这篇文章。本篇文章会将Mybatis中where标签的基本使用形式、小技巧以及容易踩到的坑进行总结梳理，方便大家更好地实践运用。

原始的手动

拼接在不使用Mybatis的where标签时，我们通常是根据查询条件进行手动拼接，也就是用到了上面提到的where 1=1的方式，示例如下：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    where 1=1
    <if test="username != null and username != ''">
     and username = #{username}
    </if>
    <if test="idNo != null and idNo != ''">
      and id_no = #{idNo}
    </if>
  </select>

这种方式主要就是为了避免语句拼接错误，出现类似如下的错误SQL：

select * from t_user where and username = 'Tom' and id = '1001';
select * from t_user where and id = '1001';

当添加上1=1时，SQL语句便是正确的了：

select * from t_user where 1=1 and username = 'Tom' and id = '1001';
select * from t_user where 1=1 and id = '1001';

这个我们之前已经提到过，多少对MySQL数据库的有一定的压力。因为1=1条件的优化过滤是需要MySQL做的。如果能够将这部分放到应用程序来做，就减少了MySQL的压力。毕竟，应用程序是可以轻易地横向扩展的。

Mybatis where标签的使用

为了能达到MySQL性能的调优，我们可以基于Mybatis的where标签来进行实现。where标签是顶层的遍历标签，需要配合if标签使用，单独使用无意义。通常有下面两种实现形式。

方式一：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

方式二：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

仔细观察会发现，这两种方式的区别在于第一if条件中的SQL语句是否有and。

这里就涉及到where标签的两个特性：

• 第一，只有if标签有内容的情况下才会插入where子句；
• 第二，若子句的开通为 “AND” 或 “OR”，where标签会将它替换去除；

所以说，上面的两种写法都是可以了，Mybatis的where标签会替我们做一些事情。

但需要注意的是：where标签只会智能的去除(忽略)首个满足条件语句的前缀。所以建议在使用where标签时，每个语句都最好写上 and 前缀或者 or 前缀，否则像以下写法就会出现问题：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        id_no = #{idNo}
      </if>
    </where>
  </select>

生成的SQL语句如下：

select * from t_user      WHERE username = ?  id_no = ?

很显然，语法是错误的。

因此，在使用where标签时，建议将所有条件都添加上and或or；

进阶：自定义trim标签

上面使用where标签可以达到拼接条件语句时，自动去掉首个条件的and或or，那么如果是其他自定义的关键字是否也能去掉呢?

此时，where标签就无能为力了，该trim标签上场了，它也可以实现where标签的功能。

 <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <trim prefix="where" prefixOverrides="and | or ">
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </trim>
  </select>

将上面基于where标签的写改写为trim标签，发现执行效果完全一样。而且trim标签具有了更加灵活的自定义性。

where语句的坑

另外，在使用where语句或其他语句时一定要注意一个地方，那就是：注释的使用。

先来看例子：

 <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        
        and id_no = #{idNo}
      </if>
    </where>
  </select>

上述SQL语句中添加了 的注释，生成的SQL语句为：

select * from t_user WHERE username = ?  and id_no = ? 

执行时，直接报错。

还有一个示例：

  <select id="selectSelective" resultType="com.secbro.entity.User">
    select * from t_user
    <where>
      <if test="username != null and username != ''">
        -- and username = #{username}
        and username = #{username}
      </if>
      <if test="idNo != null and idNo != ''">
        and id_no = #{idNo}
      </if>
    </where>
  </select>

生成的SQL语句为：

select * from t_user WHERE -- and username = ? and username = ? and id_no = ? 

同样会导致报错。

这是因为我们使用 XML 方式配置 SQL 时，如果在 where 标签之后添加了注释，那么当有子元素满足条件时，除了 < !-- --> 注释会被 where 忽略解析以外，其它注释例如 // 或 或 -- 等都会被 where 当成首个子句元素处理，导致后续真正的首个 AND 子句元素或 OR 子句元素没能被成功替换掉前缀，从而引起语法错误。

同时，个人在实践中也经常发现因为在XML中使用注释不当导致SQL语法错误或执行出错误的结果。强烈建议，非必要，不要在XML中注释掉SQL，可以通过版本管理工具来追溯历史记录和修改。

小结

本文基于Mybatis中where标签的使用，展开讲了它的使用方式、特性以及拓展到trim标签的替代作用，同时，也提到了在使用时可能会出现的坑。内容虽然简单，但如果能够很好地实践、避免踩坑也是能力的体现。