Mybatis中的动态SQL在xml中支持的几种常用标签

mybatis3之后，采用了功能强大的OGNL表达式语言消除了许多其它繁琐的标签，现在动态SQL在xml中支持的几种标签:

• if
• choose(when、otherwise)
• trim(where、set)
• foreach
• bind

 一.if标签

if标签通常用于where语句中，通过判断参数值来决定是否使用某个查询条件，它也经常用于UPDATE语句中判断是否更新某一个字段，还可以再INSERT语句中用来判断是否插入某个字段的值。

1.1 在where条件中使用if

用法：含义就是当if满足时，就执行标签体中的内容。

需求：准备如下数据表，当只输入用户名的时候，就根据这个用户名进行模糊查询匹配的用户；当只输入邮箱时，就根据邮箱完全匹配用户胡；当两者都同时输入时，就需要用这两个条件去查询匹配的用户。

表格：

贴下关键代码：

 （1）controller

@PostMapping("/selectByUser")
    public List<SysUser> selectByUser(){
        SysUser sysUser=new SysUser();
        sysUser.setUserName("tes");
        return userService.selectByUser(sysUser);
    }

说明：这里只传入了userName。而userEmail为null

（2）service实现类

 @Override
    public List<SysUser> selectByUser(SysUser sysUser) {
        return userMapper.selectByUser(sysUser);
    }

（3）mapper接口

List<SysUser> selectByUser(SysUser sysUser);

（4）mapper.xm<select id="selectByUser" resultType="com.example.demo.dao.SysUser">        select id,        user_name userName,

        user_password userPassword,
        user_email userEmail,
        user_info userInfo,
        head_img headImg,
        created_time createTime
        from sys_user
        where 1=1
        <if test="userName!=null and userName!=''">
            and user_name like concat('%',#{userName},'%')
        </if>
        <if test="userEmail!=null and userEmail!=''">
            and user_email=#{userEmail}
        </if>
    </select>

说明：1.if标签内有一个必填的属性test,test的值是一个符合OGNL要求的判断表达式，表达式的结果可以认为是ture或者false.
     2.当有多个判断条件时，可以使用and或者or进行搭配。
     3.上面两个if，它们是平级的关系，只要有满足if条件的,if标签内的 and user_x=... 这一句就会接在where语句后面。如果不满足，就不会有。
     4.这里写了一个where 1=1 是为了保证当2个if语句都没有的时候，不会直接以where结束，这样sql语句就会报错。
       这种写法where1=1不美观，后面可以采用where标签来拯救它。

（5）实体类

package com.example.demo.dao;


import java.sql.Date;

public class SysUser {
    /**
     * 用户ID
     */
    private Long id;
    /**
     * 用户名
     */
    private String userName;
    /**
     * 密码
     */
    private String userPassword;
    /**
     * 邮箱
     */
    private String userEmail;
    /**
     * 简介
     */
    private String userInfo;
    /**
     * 头像
     */
    private byte[] headImg;
    /**
     * 创建时间
     */
    private Date createTime;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getUserPassword() {
        return userPassword;
    }

    public void setUserPassword(String userPassword) {
        this.userPassword = userPassword;
    }

    public String getUserEmail() {
        return userEmail;
    }

    public void setUserEmail(String userEmail) {
        this.userEmail = userEmail;
    }

    public String getUserInfo() {
        return userInfo;
    }

    public void setUserInfo(String userInfo) {
        this.userInfo = userInfo;
    }

    public byte[] getHeadImg() {
        return headImg;
    }

    public void setHeadImg(byte[] headImg) {
        this.headImg = headImg;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}

采用postman模拟请求，会得到三条和名字模糊匹配的记录：

[
    {
        "id": 3,
        "userName": "test1",
        "userPassword": "123456",
        "userEmail": "test1@mybatis.tk",
        "userInfo": "test1",
        "headImg": null,
        "createTime": "2020-03-04"
    },
    {
        "id": 1001,
        "userName": "test",
        "userPassword": "123456",
        "userEmail": "test@mybatis.tk",
        "userInfo": "管理员",
        "headImg": null,
        "createTime": "2020-03-19"
    },
    {
        "id": 1002,
        "userName": "test1",
        "userPassword": "123456",
        "userEmail": "test1@mybatis.tk",
        "userInfo": "test1",
        "headImg": null,
        "createTime": "2020-03-25"
    },
    {
        "id": 1003,
        "userName": "test1",
        "userPassword": "123456",
        "userEmail": "test1@mybatis.tk",
        "userInfo": "test1",
        "headImg": null,
        "createTime": "2020-03-29"
    },
    {
        "id": 1004,
        "userName": "test1",
        "userPassword": "123456",
        "userEmail": "test1@mybatis.tk",
        "userInfo": "test1",
        "headImg": null,
        "createTime": "2020-03-29"
    }
]

1.2 在UPDATE更新列中使用if标签

需求：只更新发生变化的字段。

（1）controller

 @PostMapping("/updateBySelective")
    int updateBySelective(SysUser sysUser){
        sysUser.setUserName("hello");
        sysUser.setId(1L);
        return userService.updateBySelective(sysUser);
    }

（2）service实现类

@Override
    public int updateBySelective(SysUser sysUser) {
        return userMapper.updateBySelective(sysUser);
    }

（3）mapper接口

 int updateBySelective(SysUser sysUser);

（4）mapper.xml

<update id="updateBySelective">
        update sys_user
        set
        <if test="userName!=null and userName!=''">
            user_name=#{userName},
        </if>
        <if test="userPassword!=null and userPassword!=''">
            user_password=#{userPassword},
        </if>
        <if test="userEmail!=null and userEmail!=''">
            user_email=#{userEmail},
        </if>
        <if test="userInfo!=null and userInfo!=''">
            user_info=#{userInfo},
        </if>
        <if test="headImg!=null">
            head_img=#{headImg,jdbcType=BLOB},
        </if>
        <if test="createTime!=null">
            created_time=#{createTime,jdbcType=TIMESTAMP},
        </if>
        id=#{id}
        where id=#{id}
    </update>

说明：1.这里 id=#{id}是为了防止所有if都不满足的时候语法错误。即使if中有个别满足的，也不能省去，否则sql语法错误。
       这种写法不美观，仍然然可以通过where标签和set标签来解决。

 1.3 在INSERT动态插入列中使用if标签

需求：如果某一列的参数值不为空，就使用传入的值；如果传入参数为空，就使用数据库中默认的值（通常为空），而不使用传入的空值。

（1）controller

@PostMapping("/insertUser")
    public int insertUser(){

       SysUser sysUser=new SysUser();
       sysUser.setUserName("Tom");
       sysUser.setUserEmail("aa.@qq.com");
       sysUser.setUserInfo("作家");
       return userService.insertUser(sysUser);
    }

（2）service实现类

@Override
    public int insertUser(SysUser sysUser) {
        return userMapper.insertUser(sysUser);
    }

（3）mapper接口

int insertUser(SysUser sysUser);

（4）mapper.xml

<insert id="insertUser">
    insert into sys_user(
    user_name,user_password,user_email,
    <if test="userInfo!=null and userInfo!=''">
        user_info,
    </if>
    head_img,created_time)
    values(
    #{userName},#{userPassword},#{userEmail},
    <if test="userInfo!=null and userInfo!=''">
        #{userInfo},
    </if>
    #{headImg,jdbcType=BLOB},#{createTime,jdbcType=TIMESTAMP})
</insert>

 二. choose(when、otherwise）

if标签只能实现if功能，没有else功能。于是可以通过本节的组合来实现if..else的功能。choose中农包含when和otherwise两个标签，一个choose中至少有一个when，有0个或1个otherwise.  

我的理解：when就相当于java中的else if，而otherwise就相当于java中的else。

需求：准备如下表。当ID有值的时候就优先采用ID进行查询匹配用户；如果ID没有值，那就采用用户名进行查询匹配的用户。

 （1）controller

@PostMapping("/selectByIdOrName")
    SysUser selectByIdOrName(){
        SysUser sysUser=new SysUser();
        sysUser.setId(1L);
        sysUser.setUserName("test3");
        return userService.selectByIdOrName(sysUser);
    }

（2）service实现类

@Override
    public SysUser selectByIdOrName(SysUser sysUser) {
        return userMapper.selectByIdOrName(sysUser);
    }

（3）mapper接口

SysUser selectByIdOrName(SysUser sysUser);

（4）mapper.xml

<select id="selectByIdOrName" resultType="com.example.demo.dao.SysUser">
    select id,
    user_name userName,
    user_password userPassword,
    user_email userEmail,
    user_info userInfo,
    head_img headImg,
    created_time createTime
    from sys_user
    where 1=1
    <choose>
        <when test="id!=null">
            and id=#{id}
        </when>
        <when test="userName!=null and userName!=''">
            and user_name=#{userName}
        </when>
        <otherwise>
            and 1=2
        </otherwise>
    </choose>
</select>

{
    "id": 1,
    "userName": "test1",
    "userPassword": "123456",
    "userEmail": "admin@mybatis.tk",
    "userInfo": "管理员",
    "headImg": null,
    "createTime": "2020-03-01"
}

三. where、set、trim

 3.1 where标签

修改之前的where 1=1例子，姓名模糊匹配，邮箱完全匹配查询。

修改之前：

<select id="selectByUser" resultType="com.example.demo.dao.SysUser">
        select id,
        user_name userName,
        user_password userPassword,
        user_email userEmail,
        user_info userInfo,
        head_img headImg,
        created_time createTime
        from sys_user
        where 1=1
        <if test="userName!=null and userName!=''">
            and user_name like concat('%',#{userName},'%')
        </if>
        <if test="userEmail!=null and userEmail!=''">
            and user_email=#{userEmail}
        </if>
    </select>

直接将xml文件改为如下：

<select id="selectByUser" resultType="com.example.demo.dao.SysUser">
        select id,
        user_name userName,
        user_password userPassword,
        user_email userEmail,
        user_info userInfo,
        head_img headImg,
        created_time createTime
        from sys_user
        <where>
            <if test="userName!=null and userName!=''">
                and user_name like concat('%',#{userName},'%')
            </if>
            <if test="userEmail!=null and userEmail!=''">
                and user_email=#{userEmail}
            </if>
        </where>

    </select>
说明：当if都不满足的时候，where中就没有元素，就不会存在之前缺少where 1=1造成sql错误的问题。

3.2 set用法

还是之前的例子：

修改之前：

<update id="updateBySelective">
        update sys_user
        set
        <if test="userName!=null and userName!=''">
            user_name=#{userName},
        </if>
        <if test="userPassword!=null and userPassword!=''">
            user_password=#{userPassword},
        </if>
        <if test="userEmail!=null and userEmail!=''">
            user_email=#{userEmail},
        </if>
        <if test="userInfo!=null and userInfo!=''">
            user_info=#{userInfo},
        </if>
        <if test="headImg!=null">
            head_img=#{headImg,jdbcType=BLOB},
        </if>
        <if test="createTime!=null">
            created_time=#{createTime,jdbcType=TIMESTAMP},
        </if>
        id=#{id}
        where id=#{id}
    </update>

修改之后：

<update id="updateUser">
        update sys_user
        set
        <foreach collection="_parameter" item="val" index="key" separator=",">
            ${key}=#{val}
        </foreach>
        where id=#{id}
    </update>

    <update id="updateBySelective">
        update sys_user
        <set>
            <if test="userName!=null and userName!=''">
                user_name=#{userName},
            </if>
            <if test="userPassword!=null and userPassword!=''">
                user_password=#{userPassword},
            </if>
            <if test="userEmail!=null and userEmail!=''">
                user_email=#{userEmail},
            </if>
            <if test="userInfo!=null and userInfo!=''">
                user_info=#{userInfo},
            </if>
            <if test="headImg!=null">
                head_img=#{headImg,jdbcType=BLOB},
            </if>
            <if test="createTime!=null">
                created_time=#{createTime,jdbcType=TIMESTAMP},
            </if>
            id=#{id}
        </set>
        where id=#{id}
    </update>

这种只解决了逗号问题，不是很全面的解决问题，仍然需要

id=#{id}

3.3 trim标签

where和set标签的功能都能通过trim标签实现。

 举例：

（1）还是之前的用户名模糊匹配，邮箱完全匹配的例子：（使用trim标签去除多余的and关键字）

修改mapper.xml文件：

<select id="selectByUser" resultType="com.example.demo.dao.SysUser">
        select id,
        user_name userName,
        user_password userPassword,
        user_email userEmail,
        user_info userInfo,
        head_img headImg,
        created_time createTime
        from sys_user
        <trim prefix="where" prefixOverrides="and">
            <if test="userName!=null and userName!=''">
                and user_name like concat('%',#{userName},'%')
            </if>
            <if test="userEmail!=null and userEmail!=''">
                and user_email=#{userEmail}
            </if>
        </trim>

    </select>

效果一样的。但是就不会多写where1=1，并且指定了prefix为where。