HelloWorld
登录

MyBatis动态SQL（认真看看， 以后写SQL就爽多了）

Stella981

2021-10-11

1280 0 0

作者：阿进的写字台 cnblogs.com/homejim/p/9909657.html

温馨提示：文中代码看不全可左右滑动 MyBatis 令人喜欢的一大特性就是动态 SQL。 在使用 JDBC 的过程中， 根据条件进行 SQL 的拼接是很麻烦且很容易出错的。 MyBatis 动态 SQL 的出现， 解决了这个麻烦。

MyBatis通过 OGNL 来进行动态 SQL 的使用的。目前， 动态 SQL 支持以下几种标签：

1 数据准备

为了后面的演示， 创建了一个 Maven 项目 mybatis-dynamic, 创建了对应的数据库和表

1DROP TABLE IF EXISTS `student`;
2
3CREATE TABLE `student` (
4  `student_id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '编号',
5  `name` varchar(20) DEFAULT NULL COMMENT '姓名',
6  `phone` varchar(20) DEFAULT NULL COMMENT '电话',
7  `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
8  `sex` tinyint(4) DEFAULT NULL COMMENT '性别',
9  `locked` tinyint(4) DEFAULT NULL COMMENT '状态(0:正常,1:锁定)',
10  `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '存入数据库的时间',
11  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改的时间',
12  `delete` int(11) DEFAULT NULL,
13  PRIMARY KEY (`student_id`)
14) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='学生表';
15对应的项目结构

2 if 标签

if 标签是我们最常使用的。 在查询、删除、更新的时候很可能会使用到。 必须结合 test 属性联合使用。

2.1 在 WHERE 条件中使用 if 标签

这是常见的一种现象， 我们在进行按条件查询的时候， 可能会有多种情况。

2.1.1 查询条件

根据输入的学生信息进行条件检索

当只输入用户名时， 使用用户名进行模糊检索； 当只输入性别时， 使用性别进行完全匹配 当用户名和性别都存在时， 用这两个条件进行查询匹配查询 2.1.2 动态 SQL

接口函数

1/**
2 * 根据输入的学生信息进行条件检索
3 * 1. 当只输入用户名时， 使用用户名进行模糊检索；
4 * 2. 当只输入邮箱时， 使用性别进行完全匹配
5 * 3. 当用户名和性别都存在时， 用这两个条件进行查询匹配的用
6 * [@param](https://my.oschina.net/u/2303379) student
7 * [@return](https://my.oschina.net/u/556800)
8 */
9    List<Student> selectByStudentSelective(Student student);

对应的动态 SQL

1<select id="selectByStudentSelective" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
2    select
3    <include refid="Base_Column_List" />
4    from student
5    where 1=1
6    <if test="name != null and name !=''">
7      and name like concat('%', #{name}, '%')
8    </if>
9    <if test="sex != null">
10      and sex=#{sex}
11    </if>
12  </select>

在此 SQL 语句中， where 1=1 是多条件拼接时的小技巧， 后面的条件查询就可以都用 and 了。

同时， 我们添加了 if 标签来处理动态 SQL

1<if test="name != null and name !=''">
2  and name like concat('%', #{name}, '%')
3</if>
4<if test="sex != null">
5  and sex=#{sex}
6</if>

此 if 标签的 test 属性值是一个符合 OGNL 的表达式， 表达式可以是 true 或 false。 如果表达式返回的是数值， 则0为 false, 非 0 为 true;

2.1.3 测试

1 @Test
2public void selectByStudent() {
3    SqlSession sqlSession = null;
4    sqlSession = sqlSessionFactory.openSession();
5    StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
6
7    Student search = new Student();
8    search.setName("明");
9
10    System.out.println("只有名字时的查询");
11    List<Student> studentsByName = studentMapper.selectByStudentSelective(search);
12    for (int i = 0; i < studentsByName.size(); i++) {
13        System.out.println(ToStringBuilder.reflectionToString(studentsByName.get(i), ToStringStyle.MULTI_LINE_STYLE));
14    }
15
16    search.setName(null);
17    search.setSex((byte) 1);
18    System.out.println("只有性别时的查询");
19    List<Student> studentsBySex = studentMapper.selectByStudentSelective(search);
20    for (int i = 0; i < studentsBySex.size(); i++) {
21        System.out.println(ToStringBuilder.reflectionToString(studentsBySex.get(i), ToStringStyle.MULTI_LINE_STYLE));
22    }
23
24    System.out.println("姓名和性别同时存在的查询");
25    search.setName("明");
26    List<Student> studentsByNameAndSex = studentMapper.selectByStudentSelective(search);
27    for (int i = 0; i < studentsByNameAndSex.size(); i++) {
28        System.out.println(ToStringBuilder.reflectionToString(studentsByNameAndSex.get(i), ToStringStyle.MULTI_LINE_STYLE));
29    }
30
31    sqlSession.commit();
32    sqlSession.close();
33}

只有名字时的查询， 发送的语句和结果

查询的条件只发送了

where 1=1 and name like concat('%', ?, '%') 只有性别时的查询， 发送的语句和结果

查询的条件只发送了

where 1=1 and sex=? 姓名和性别同时存在的查询， 发送的语句和结果

查询条件

where 1=1 and name like concat('%', ?, '%') and sex=? 2.2 在 UPDATE 更新列中使用 if 标签

有时候我们不希望更新所有的字段， 只更新有变化的字段。

2.2.1 更新条件

只更新有变化的字段， 空值不更新。

2.2.1 动态 SQL

接口方法

1/**
2 * 更新非空属性
3 */
4int updateByPrimaryKeySelective(Student record);

对应的 SQL

1  <update id="updateByPrimaryKeySelective" parameterType="com.homejim.mybatis.entity.Student">
2    update student
3    <set>
4      <if test="name != null">
5        `name` = #{name,jdbcType=VARCHAR},
6      </if>
7      <if test="phone != null">
8        phone = #{phone,jdbcType=VARCHAR},
9      </if>
10      <if test="email != null">
11        email = #{email,jdbcType=VARCHAR},
12      </if>
13      <if test="sex != null">
14        sex = #{sex,jdbcType=TINYINT},
15      </if>
16      <if test="locked != null">
17        locked = #{locked,jdbcType=TINYINT},
18      </if>
19      <if test="gmtCreated != null">
20        gmt_created = #{gmtCreated,jdbcType=TIMESTAMP},
21      </if>
22      <if test="gmtModified != null">
23        gmt_modified = #{gmtModified,jdbcType=TIMESTAMP},
24      </if>
25    </set>
26    where student_id = #{studentId,jdbcType=INTEGER}

2.2.3 测试

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

我们插入数据库中的一条记录， 不是每一个字段都有值的， 而是动态变化的。 在这时候使用 if 标签， 可帮我们解决这个问题。

2.3.1 插入条件

只有非空属性才插入。

2.3.2 动态SQL

接口方法

1/**
2 * 非空字段才进行插入
3 */
4int insertSelective(Student record);

对应的SQL

1<insert id="insertSelective" parameterType="com.homejim.mybatis.entity.Student">
2    insert into student
3    <trim prefix="(" suffix=")" suffixOverrides=",">
4      <if test="studentId != null">
5        student_id,
6      </if>
7      <if test="name != null">
8        `name`,
9      </if>
10      <if test="phone != null">
11        phone,
12      </if>
13      <if test="email != null">
14        email,
15      </if>
16      <if test="sex != null">
17        sex,
18      </if>
19      <if test="locked != null">
20        locked,
21      </if>
22      <if test="gmtCreated != null">
23        gmt_created,
24      </if>
25      <if test="gmtModified != null">
26        gmt_modified,
27      </if>
28    </trim>
29    <trim prefix="values (" suffix=")" suffixOverrides=",">
30      <if test="studentId != null">
31        #{studentId,jdbcType=INTEGER},
32      </if>
33      <if test="name != null">
34        #{name,jdbcType=VARCHAR},
35      </if>
36      <if test="phone != null">
37        #{phone,jdbcType=VARCHAR},
38      </if>
39      <if test="email != null">
40        #{email,jdbcType=VARCHAR},
41      </if>
42      <if test="sex != null">
43        #{sex,jdbcType=TINYINT},
44      </if>
45      <if test="locked != null">
46        #{locked,jdbcType=TINYINT},
47      </if>
48      <if test="gmtCreated != null">
49        #{gmtCreated,jdbcType=TIMESTAMP},
50      </if>
51      <if test="gmtModified != null">
52        #{gmtModified,jdbcType=TIMESTAMP},
53      </if>
54    </trim>
55  </insert>

这个 SQL 大家应该很熟悉， 毕竟是自动生成的。

2.3.3 测试

1[@Test](https://my.oschina.net/azibug)
2public void insertByStudentSelective() {
3    SqlSession sqlSession = null;
4    sqlSession = sqlSessionFactory.openSession();
5    StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
6
7    Student student = new Student();
8    student.setName("小飞机");
9    student.setPhone("13838438899");
10    student.setEmail("xiaofeiji@qq.com");
11    student.setLocked((byte) 0);
12
13    System.out.println(studentMapper.insertSelective(student));
14
15    sqlSession.commit();
16    sqlSession.close();
17}

对应的结果

SQL 中， 只有非空的字段才进行了插入。

3 choose 标签

choose when otherwise 标签可以帮我们实现 if else 的逻辑。一个 choose 标签至少有一个 when, 最多一个otherwise。

下面是一个查询的例子。

3.1 查询条件

假设 name 具有唯一性， 查询一个学生

当 studen_id 有值时， 使用 studen_id 进行查询； 当 studen_id 没有值时， 使用 name 进行查询； 否则返回空 3.2 动态SQL

接口方法

1/**
2 * - 当 studen_id 有值时， 使用 studen_id 进行查询；
3 * - 当 studen_id 没有值时， 使用 name 进行查询；
4 * - 否则返回空
5 */
6Student selectByIdOrName(Student record);

对应的SQL

1  <select id="selectByIdOrName" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
2    select
3    <include refid="Base_Column_List" />
4    from student
5    where 1=1
6    <choose>
7      <when test="studentId != null">
8        and student_id=#{studentId}
9      </when>
10      <when test="name != null and name != ''">
11        and name=#{name}
12      </when>
13      <otherwise>
14        and 1=2
15      </otherwise>
16    </choose>
17  </select>

3.3 测试

1 @Test
2    public void selectByIdOrName() {
3        SqlSession sqlSession = null;
4        sqlSession = sqlSessionFactory.openSession();
5        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
6
7
8	  Student student = new Student();
9    student.setName("小飞机");
10    student.setStudentId(1);
11
12    Student studentById = studentMapper.selectByIdOrName(student);
13    System.out.println("有 ID 则根据 ID 获取");
14    System.out.println(ToStringBuilder.reflectionToString(studentById, ToStringStyle.MULTI_LINE_STYLE));
15
16    student.setStudentId(null);
17    Student studentByName = studentMapper.selectByIdOrName(student);
18    System.out.println("没有 ID 则根据 name 获取");
19    System.out.println(ToStringBuilder.reflectionToString(studentByName, ToStringStyle.MULTI_LINE_STYLE));
20
21    student.setName(null);
22    Student studentNull = studentMapper.selectByIdOrName(student);
23    System.out.println("没有 ID 和 name, 返回 null");
24    Assert.assertNull(studentNull);
25
26    sqlSession.commit();
27    sqlSession.close();
28}

有 ID 则根据 ID 获取， 结果

没有 ID 则根据 name 获取

没有 ID 和 name, 返回 null

4 trim(set、where)

这三个其实解决的是类似的问题。 如我们在写前面的[在 WHERE 条件中使用 if 标签] SQL 的时候， where 1=1 这个条件我们是不希望存在的。

4.1 where

4.1.1 查询条件

根据输入的学生信息进行条件检索。

当只输入用户名时， 使用用户名进行模糊检索； 当只输入性别时， 使用性别进行完全匹配 当用户名和性别都存在时， 用这两个条件进行查询匹配查询 不使用 where 1=1。

4.1.2 动态 SQL

很显然， 我们要解决这几个问题

当条件都不满足时： 此时 SQL 中应该要不能有 where ， 否则导致出错 当 if 有条件满足时： SQL 中需要有 where， 且第一个成立的 if 标签下的 and | or 等要去掉 这时候， 我们可以使用 where 标签。

接口方法

1/**
2 * 根据输入的学生信息进行条件检索
3 * 1. 当只输入用户名时， 使用用户名进行模糊检索；
4 * 2. 当只输入邮箱时， 使用性别进行完全匹配
5 * 3. 当用户名和性别都存在时， 用这两个条件进行查询匹配的用
6 */
7List<Student> selectByStudentSelectiveWhereTag(Student student);

对应的 SQL

1  <select id="selectByStudentSelectiveWhereTag" resultMap="BaseResultMap" parameterType="com.homejim.mybatis.entity.Student">
2    select
3    <include refid="Base_Column_List" />
4    from student
5   <where>
6    <if test="name != null and name !=''">
7      and name like concat('%', #{name}, '%')
8    </if>
9    <if test="sex != null">
10      and sex=#{sex}
11    </if>
12   </where>
13  </select>

4.1.3 测试

1[@Test](https://my.oschina.net/azibug)
2public void selectByStudentWhereTag() {
3    SqlSession sqlSession = null;
4    sqlSession = sqlSessionFactory.openSession();
5    StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
6
7    Student search = new Student();
8    search.setName("明");
9
10    System.out.println("只有名字时的查询");
11    List<Student> studentsByName = studentMapper.selectByStudentSelectiveWhereTag(search);
12    for (int i = 0; i < studentsByName.size(); i++) {
13        System.out.println(ToStringBuilder.reflectionToString(studentsByName.get(i), ToStringStyle.MULTI_LINE_STYLE));
14    }
15
16    search.setSex((byte) 1);
17    System.out.println("姓名和性别同时存在的查询");
18    List<Student> studentsBySex = studentMapper.selectByStudentSelectiveWhereTag(search);
19    for (int i = 0; i < studentsBySex.size(); i++) {
20        System.out.println(ToStringBuilder.reflectionToString(studentsBySex.get(i), ToStringStyle.MULTI_LINE_STYLE));
21    }
22
23    System.out.println("姓名和性别都不存在时查询");
24    search.setName(null);
25    search.setSex(null);
26    List<Student> studentsByNameAndSex = studentMapper.selectByStudentSelectiveWhereTag(search);
27    for (int i = 0; i < studentsByNameAndSex.size(); i++) {
28        System.out.println(ToStringBuilder.reflectionToString(studentsByNameAndSex.get(i), ToStringStyle.MULTI_LINE_STYLE));
29    }
30
31    sqlSession.commit();
32    sqlSession.close();
33}

只有名字时的查询, 有 where

姓名和性别同时存在的查询， 有 where

姓名和性别都不存在时查询, 此时， where 不会再出现了。

4.2 set

set 标签也类似， 在 [2.2 在 UPDATE 更新列中使用 if 标签] 中， 如果我们的方法 updateByPrimaryKeySelective 没有使用

4.3 trim

set 和 where 其实都是 trim 标签的一种类型， 该两种功能都可以使用 trim 标签进行实现。

4.3.1 trim 来表示 where

如以上的 where 标签， 我们也可以写成

<trim prefix="where" prefixOverrides="AND |OR"> </trim> 表示当 trim 中含有内容时， 添加 where， 且第一个为 and 或 or 时， 会将其去掉。 而如果没有内容， 则不添加 where。

4.3.2 trim 来表示 set

相应的， set 标签可以如下表示

<trim prefix="SET" suffixOverrides=","> </trim> 表示当 trim 中含有内容时， 添加 set， 且最后的内容为 , 时， 会将其去掉。 而没有内容， 不添加 set

4.3.3 trim 的几个属性

prefix: 当 trim 元素包含有内容时， 增加 prefix 所指定的前缀 prefixOverrides: 当 trim 元素包含有内容时， 去除 prefixOverrides 指定的 前缀 suffix: 当 trim 元素包含有内容时， 增加 suffix 所指定的后缀 suffixOverrides： 当 trim 元素包含有内容时， 去除 suffixOverrides 指定的后缀 5 foreach 标签

foreach 标签可以对数组， Map 或实现 Iterable 接口。

foreach 中有以下几个属性：

collection: 必填， 集合/数组/Map的名称. item: 变量名。 即从迭代的对象中取出的每一个值 index: 索引的属性名。 当迭代的对象为 Map 时， 该值为 Map 中的 Key. open: 循环开头的字符串 close: 循环结束的字符串 separator: 每次循环的分隔符 其他的比较好理解， collection 中的值应该怎么设定呢？

跟接口方法中的参数相关。

  1. 只有一个数组参数或集合参数

默认情况： 集合collection=list， 数组是collection=array

推荐： 使用 @Param 来指定参数的名称， 如我们在参数前@Param("ids")， 则就填写 collection=ids

  1. 多参数

多参数请使用 @Param 来指定， 否则SQL中会很不方便

  1. 参数是Map

指定为 Map 中的对应的 Key 即可。 其实上面的 @Param 最后也是转化为 Map 的。

  1. 参数是对象

使用属性.属性即可。

5.1 在 where 中使用 foreach

在 where条件中使用， 如按id集合查询， 按id集合删除等。

5.1.1 查询条件

我们希望查询用户 id 集合中的所有用户信息。

5.1.2 动态 SQL

函数接口

1/**
2 * 获取 id 集合中的用户信息
3 * @param ids
4 * @return
5 */
6List<Student> selectByStudentIdList(List<Integer> ids);

对应 SQL

1<select id="selectByStudentIdList" resultMap="BaseResultMap">
2    select
3    <include refid="Base_Column_List" />
4    from student
5    where student_id in
6    <foreach collection="list" item="id" open="(" close=")" separator="," index="i">
7      #{id}
8    </foreach>
9  </select>

5.1.3 测试

1@Test
2public void selectByStudentIdList() {
3    SqlSession sqlSession = null;
4    sqlSession = sqlSessionFactory.openSession();
5    StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
6
7    List<Integer> ids = new LinkedList<>();
8    ids.add(1);
9    ids.add(3);
10
11    List<Student> students = studentMapper.selectByStudentIdList(ids);
12    for (int i = 0; i < students.size(); i++) {
13        System.out.println(ToStringBuilder.reflectionToString(students.get(i), ToStringStyle.MULTI_LINE_STYLE));
14    }
15
16    sqlSession.commit();
17    sqlSession.close();
18}

结果

5.2 foreach 实现批量插入

可以通过foreach来实现批量插入。

5.2.1 动态SQL

接口方法

1/**
2 * 批量插入学生
3 */
4int insertList(List<Student> students);

对应的SQL

1<insert id="insertList">
2    insert into student(name, phone, email, sex, locked)
3    values
4    <foreach collection="list" item="student" separator=",">
5      (
6      #{student.name}, #{student.phone},#{student.email},
7      #{student.sex},#{student.locked}
8      )
9    </foreach>
10  </insert>
115.2.2 测试
12
135.2.2 测试
14
15    @Test
16    public void insertList() {
17        SqlSession sqlSession = null;
18        sqlSession = sqlSessionFactory.openSession();
19        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
20    
21        List<Student> students = new LinkedList<>();
22        Student stu1 = new Student();
23        stu1.setName("批量01");
24        stu1.setPhone("13888888881");
25        stu1.setLocked((byte) 0);
26        stu1.setEmail("13888888881@138.com");
27        stu1.setSex((byte) 1);
28        students.add(stu1);
29    
30        Student stu2 = new Student();
31        stu2.setName("批量02");
32        stu2.setPhone("13888888882");
33        stu2.setLocked((byte) 0);
34        stu2.setEmail("13888888882@138.com");
35        stu2.setSex((byte) 0);
36        students.add(stu2);
37    
38        System.out.println(studentMapper.insertList(students));
39        sqlSession.commit();
40        sqlSession.close();
41    }
42
43结果
44
45
46
476 bind 标签
48
49bind 标签是通过 OGNL 表达式去定义一个上下文的变量， 这样方便我们使用。
50
51如在 selectByStudentSelective 方法中， 有如下
52

<if test="name != null and name !=''"> and name like concat('%', #{name}, '%') </if> 在 MySQL 中， 该函数支持多参数， 但在 Oracle 中只支持两个参数。 那么我们可以使用 bind 来让该 SQL 达到支持两个数据库的作用

<if test="name != null and name !=''"> <bind name="nameLike" value="'%'+name+'%'"/> and name like #{nameLike} </if> 更改后的查询结果如下 ```

7 代码

使用示例：

https://github.com/homejim/mybatis-examples

关注公众号:java宝典 pic222

点赞
收藏

评论区

加载中...

相关推荐

MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1

文章目录问题用navicat导入数据时，报错：原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等，这样可以更容易地在不同的环境中使用MySQL。全局s

Oracle 分组与拼接字符串同时使用

SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(

手写Java HashMap源码

HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22

2020年前端实用代码段，为你的工作保驾护航

有空的时候，自己总结了几个代码段，在开发中也经常使用，谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )

SpringBoot整合Mybatis

MyBatis的动态SQL是最令人喜欢的功能在了解动态SQL之前，你首先得知道一个表达式OGNL，这个是基础！!在这里插入图片描述(https://p3juejin.byteimg.com/toscnik3u1fbpfcp/71e4f99be1254c7

Mabatis中#{}和${}的区别

动态sql是mybatis的主要特性之一，在mapper中定义的参数传到xml中之后，在查询之前mybatis会对其进行动态解析。mybatis为我们提供了两种支持动态sql的语法：{}以及${}。　　在下面的语句中，如果username的值为zhangsan，则两种方式无任何区别：selectfr