MyBatis动态<if>标签的使用

2023-05-19 20:05:00 mybatis 标签动态

前言

MyBatis中的<if>动态SQL标签，常用场景是根据条件添加WHERE子句。本篇文章将对<if>动态SQL标签使用中的常见问题进行演示和总结。

演示的场景有：if判断字符串，if判断数字。

MyBatis版本：3.5.6

正文

一. if标签判断字符串

查询参数Param如下。

public class Param {
    private int id;
    private String level;
    private int times;
    private String timestamp;
    // 省略get和set
}

语句如下。

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE id=#{id}
    <if test="level != null and level != ''">
        AND e_level=#{level}
    </if>
</select>

上述是判断字符串是否为空（null或者空串），不为空时，为WHERE子句添加额外的条件。

通过<if>标签判断字符串是否为空，是<if>标签使用频率最高的用法，但是有时也会通过<if>标签来判断字符串的值，这里有多种写法，下面给出正确写法，推荐写法和错误写法。

正确写法1

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE id=#{id}
    <if test="level == 'secondary'">
        AND e_times>10
    </if>
</select>

注意''单引号中一定需要是多个字符，如果只有一个字符，会报错。

正确写法2

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE id=#{id}
    <if test="level == 'secondary'.toString()">
        AND e_times>10
    </if>
</select>

这种写法不限制''单引号中的字符个数，一个或多个都可以。

推荐写法

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE id=#{id}
    <if test='level == "secondary"'>
        AND e_times>10
    </if>
</select>

推荐外层用单引号，内层用双引号的写法，能少踩很多坑。

特别注意：错误写法

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE id=#{id}
    <if test="level == 'A'">
        AND e_times>10
    </if>
</select>

这种写法会报错，因为像'A'这种单个字符的情况会被判定为字符，所以MyBatis认为字符串在与字符做比较，从而报错。但是如果是'AA'或者'A'.toString() 这种，就会被判定为字符串，就正常。

二. if标签判断数字

查询参数Param如下。

public class Param {
    private int id;
    private String level;
    private int times;
    private String timestamp;
    // 省略get和set
}

语句如下。

<select id="queryEvents3" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test="times != null">
        AND e_times>#{times}
    </if>
</select>

通过<if>标签也可以对数字判空，同时<if>标签也可以判断数字的值，这里有多种写法，下面给出正确写法，推荐写法和错误写法。

正确写法1

<select id="queryEvents2" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test="times > '10'">
        AND e_times>#{times}
    </if>
</select>

注意''单引号中一定需要是多个数字。

正确写法2

<select id="queryEvents2" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test="times > '0'.toString()">
        AND e_times>#{times}
    </if>
</select>

这种写法不限制''单引号中的数字个数，一个或多个都可以。

正确写法3

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test="times > 0">
        AND e_times>#{times}
    </if>
</select>

判断条件可以直接写数字。

推荐写法

<select id="queryEvents2" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test='times > "0"'>
        AND e_times>#{times}
    </if>
</select>

推荐外层用单引号，内层用双引号的写法，能少踩很多坑。

错误写法

<select id="queryEvents" resultMap="eventResultMap">
    SELECT
        id,
        e_name,
        e_times,
        e_level
    FROM event
    WHERE e_level=#{level}
    <if test="times > '0'">
        AND e_times>#{times}
    </if>
</select>

'0'这种单个数字会被判定为字符，而字符'0'的ASCII值是48，所以times为49及以上时，才满足times > '0'，所以这里有坑，切记。

总结

<if>标签的test判断中，外层用双引号，内层用单引号时，有如下比较规则。

允许数字与字符串做比较；
允许数字与字符做比较，但不推荐。数字与字符做比较时，数字会与字符的ASCAII值做比较，容易出错；
不允许包含字母的字符串与字符做比较。这种情况MyBatis会直接报错；
允许全是数字的字符串与字符做比较，但不推荐。这种情况全是数字的字符串会作为数字来与字符的ASCII值来做比较，容易出错。

而在OGNL表达式中，如果单引号''中只有一个数字或者字母，那么就会被解析为字符，这时就会导致MyBatis或者比较结果错误。

因此推荐<if>标签的test判断中，外层用单引号，内层用双引号，能够避免踩坑。

到此这篇关于mybatis动态<if>标签的使用的文章就介绍到这了,更多相关MyBatis动态<if>标签内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章

MyBatis动态<if>标签的使用

目录

前言

正文

一. if标签判断字符串

二. if标签判断数字

总结