Loading...
墨滴

王磊

2021/11/14  阅读:34  主题:萌绿

MyBatis 中为什么不建议使用 where 1=1?

最近接手了一个老项目,“愉悦的心情”自然无以言表,做开发的朋友都懂,这里就不多说了,都是泪... ​

接手老项目,自然是要先熟悉一下业务代码,然而在翻阅 mapper 文件时,发现了一个比较诡异的事情。这里给出简化后的业务代码:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
    <select id="list" resultType="com.example.demo.model.User">
        select * from user
        where 1=1
        <if test="name!=null">
            and name=#{name}
        </if>
        <if test="password!=null">
            and password=#{password}
        </if>
    </select>
</mapper>

机智的小伙伴可能已经看出了问题,在众多 mapper 中发现了一个相同的想象,几乎所有的 mapper 中都包含了一个无用的拼接 SQL:where 1=1。作为一个几乎有代码洁癖症的人,自然是忍不住动手改造一番了。

错误的改造方式

既然是去掉 where 1=1,那最简单的方式就是将它直接从代码中删除了,如下代码所示:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
    <select id="list" resultType="com.example.demo.model.User">
        select * from user
            where
            <if test="name!=null">
                name=#{name}
            </if>
            <if test="password!=null">
                and password=#{password}
            </if>
    </select>
</mapper>

以上代码删除了 1=1,并且把第一个 name 查询中的 and 去掉了,以防 SQL 查询报错。 ​

但这样就没问题了吗?我们直接来看结果,当包含参数 name 查询时,结果如下: image.png 一切顺利成章,完美的一塌糊涂。 然而,当省略 name 参数时(因为 name 为非必要参数,所以可以省略),竟然引发了以下异常: image.png 又或者只有 password 查询时,结果也是一样: image.png 都是报错信息,那肿么办呢?难不成把 1=1 恢复回去?

正确的改进方式

其实不用,在 MyBatis 中早已经想到了这个问题,我们可以将 SQL 中的 where 关键字换成 MyBatis 中的 标签,并且给每个 标签内都加上 and 拼接符,这样问题就解决了 ,如下代码所示:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">
    <select id="list" resultType="com.example.demo.model.User">
        select * from user
        <where>
            <if test="name!=null">
               and name=#{name}
            </if>
            <if test="password!=null">
                and password=#{password}
            </if>
        </where>
    </select>
</mapper>

代码改造完成之后,接下来我们来测试一下所有的请求场景。

不传任何参数的请求

此时我们可以不传递任何参数(查询所有数据),如下图所示: image.png 生成的 SQL 语句如下: image.png

传递 1 个参数的请求

也可以传递 1 个参数,根据 name 进行查询,如下图所示: image.png 生成的 SQL 如下图所示: image.png 也可以只根据 password 进行查询,如下图所示: image.png 生成的 SQL 如下图所示: image.png

传递 2 个参数的请求

也可以根据 name 加 password 的方式进行联合查询,如下图所示: image.png 生成的 SQL 如下图所示: image.png

用法解析

我们惊喜的发现,在使用了 标签之后,无论是任何查询场景,传一个或者传多个参数,或者直接不传递任何参数,都可以轻松搞定。 ​

首先, 标签会判断,如果没有任何参数,则不会在 SQL 语句中拼接 where 查询,反之才会拼接 where 查询;其次在 查询的 标签中,每个 标签都可以加 and 关键字,MyBatis 会自动将第一个条件前面的 and 关键字删除掉,从而不会导致 SQL 语法错误,这一点官方文档中也有说明,如下图所示: image.png

总结

在 MyBatis 中,建议尽量避免使用无意义的 SQL 拼接 where 1=1,我们可以使用 标签来替代 where 1=1,这样的写既简洁又优雅,何乐而不为呢?以上内容仅为个人观点,欢迎评论区留言讨论。 ​

关注公众号「Java中文社群」查看更多 MyBatis 和 Spring Boot 的系列文章。

王磊

2021/11/14  阅读:34  主题:萌绿

作者介绍

王磊