写点什么

Mybatis 的 where 标签,竟然还有这么多不知道的!

  • 2022 年 3 月 03 日
  • 本文字数:2806 字

    阅读完需:约 9 分钟

背景

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

原始的手动拼接

在不使用 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}*/        and id_no = #{idNo}      </if>    </where>  </select>复制代码
复制代码

上述 SQL 语句中添加了 /**/的注释,生成的 SQL 语句为:

select * from t_user WHERE username = ? /* and id_no = ?*/ 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 标签的替代作用,同时,也提到了在使用时可能会出现的坑。内容虽然简单,但如果能够很好地实践、避免踩坑也是能力的体现。

最后

如果你觉得此文对你有一丁点帮助,点个赞。或者可以加入我的开发交流群:1025263163 相互学习,我们会有专业的技术答疑解惑

如果你觉得这篇文章对你有点用的话,麻烦请给我们的开源项目点点 star:http://github.crmeb.net/u/defu不胜感激 !

PHP 学习手册:https://doc.crmeb.com

技术交流论坛:https://q.crmeb.com

用户头像

还未添加个人签名 2021.11.02 加入

CRMEB就是客户关系管理+营销电商系统实现公众号端、微信小程序端、H5端、APP、PC端用户账号同步,能够快速积累客户、会员数据分析、智能转化客户、有效提高销售、会员维护、网络营销的一款企业应用

评论

发布
暂无评论
Mybatis的where标签,竟然还有这么多不知道的!_💥 玩命不玩心💥_InfoQ写作平台