Mybatis动态sql中的where标签的使用

y_bccl27

已于 2024-08-22 11:45:25 修改

阅读量3.3k

点赞数 2

分类专栏： MyBatis 文章标签： mybatis

于 2020-03-10 12:44:35 首次发布

本文链接：https://blog.csdn.net/y_bccl27/article/details/104771965

版权

MyBatis 专栏收录该内容

11 篇文章 1 订阅

订阅专栏

特别说明：下述测试案例全部都是基于MyBatis Plus

1、业务背景

有时我们可能在项目代码中看到了下述mapper的xml文件：

<?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.entity.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>

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

2、错误的改造方式

既然是去掉 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.entity.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 查询报错。

UserMapper.xml对应的mapper接口如下：

import com.example.demo.entity.User;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UserMapper {

    List<User> list(User user);
}

对应的实体类如下：

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

import java.util.Date;

@Data
@TableName("user")
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;

    @TableField(value = "name")
    private String name;

    @TableField(value = "password")
    private String password;

    @TableField(value = "create_time")
    private Date createTime;
}

Controller接口访问类如下：

import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @PostMapping("/list")
    public List<User> list(@RequestBody User user){
        return userMapper.list(user);
    }
}

再次回来正题上面，真的像上面这样优化就没问题了吗？我们直接来看结果，当包含参数 name 查询时，结果如下：

一切顺理成章，完美的一塌糊涂。然而，当省略name 参数时（因为 name 为非必要参数，所以可以省略），竟然引发了以下异常：

又或者只有 password 查询时，结果也是一样：

都是报错信息，那肿么办呢？难不成把1=1 恢复回去？

3、正确的改进方式

其实不用，在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.entity.User">
        select * from user
        <where>
            <if test="name!=null">
                and name=#{name}
            </if>
            <if test="password!=null">
                and password=#{password}
            </if>
        </where>
    </select>
</mapper>

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