动态SQL 语句-更复杂的查询业务需求
动态SQL-官方文档
文档地址: https://mybatis.org/mybatis-3/zh/dynamic-sql.html
为什么需要动态SQL
1、动态SQL 是MyBatis 的强大特性之一。
2、使用JDBC 或其它类似的框架,根据不同条件拼接SQL 语句非常麻烦,例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号等。
3、SQL 映射语句中的强大的动态SQL 语言, 可以很好的解决这个问题。
动态SQL-基本介绍
基本介绍
- 在一个实际的项目中,sql 语句往往是比较复杂的
- 为了满足更加复杂的业务需求,MyBatis 的设计者,提供了动态生成SQL 的功能。
动态SQL 必要性
- 比如我们查询Monster 时,如果程序员输入的age 不大于0, 我们的sql 语句就不带age 。
- 更新Monster 对象时,没有设置的新的属性值,就保持原来的值,设置了新的值,才更新.
解决方案分析
- 从上面的需求我们可以看出,有时我们在生成sql 语句时,在同一个方法中,还要根据
不同的情况生成不同的sql 语句. - 解决方案: MyBatis 提供的动态SQL 机制.
动态SQL 常用标签
动态SQL 提供了如下几种常用的标签,类似我们Java 的控制语句:
if [判断]
where [拼接where 子句]
choose/when/otherwise [类似java 的switch 语句, 注意是单分支]
foreach [类似in ]
trim [替换关键字/定制元素的功能]
set [在update 的set 中,可以保证进入set 标签的属性被修改,而没有进入set 的,保持原来的值]
动态SQL-案例演示
新建Module dynamic-sql。
1、在原来的项目中,新建dynamic-sql 项目演示动态SQL 的使用
2、新建 Module 后,先创建需要的包,再将需要的文件/资源拷贝过来(这里我们拷贝Monster.java、resources/jdbc.properties 和 mybatis-config.xml)
3、创建 MonsterMapper.java MonsterMapper.xml 和 MonsterMapperTest.java 。
if 标签应用实例
需求:请查询age 大于10 的所有妖怪,如果程序员输入的age 不大于0, 则输出所有的妖怪!
- 修改MonsterMapper.java
/** * 1. 这是一个接口 * 2. 该接口用于声明操作monster表的方法 * 3. 这些方法可以通过注解或者xml文件来实现 */ public interface MonsterMapper { //根据age查询结果 public List<Monster> findMonsterByAge(@Param(value = "age") Integer age); }
修改MonsterMapper.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"> <!--解读 1. 这是一个mapper xml 文件 2. 该文件可以去实现对应的接口的方法 3. namespace 指定该xml文件和哪个接口对应!!! --> <mapper namespace="com.nlc.mapper.MonsterMapper"> <!-- 1. 配置方法public List<Monster> findMonsterByAge(@Param(value="age") Integer age); 2. 请查询age 大于 10 的所有妖怪,如果程序员输入的age 不大于 0, 则输出所有的妖怪 3. 按照以前方式来配置->问题? 如果使用原来的#{age} 在test表达式是取不出入参值 4. 解决方案是使用@Param --> <select id="findMonsterByAge" resultType="Monster" parameterType="Integer"> SELECT * FROM `monster` WHERE 1 = 1 <if test="age >= 0"> AND age > #{age} </if> </select> </mapper>
不确定输出SQL语句可以用日志输出查看。
- 修改MonsterMapperTest.java 并完成测试
public class MonsterMapperTest { //属性 private SqlSession sqlSession; private MonsterMapper monsterMapper; //初始化 @Before public void init() { sqlSession = MyBatisUtils.getSqlSession(); monsterMapper = sqlSession.getMapper(MonsterMapper.class); } @Test public void findMonsterByAge() { List<Monster> monsters = monsterMapper.findMonsterByAge(-1); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); } }
where 标签应用实例
需求:查询id 大于20 的,并且名字是"牛魔王" 的所有妖怪, 注意,如果名字为空,
或者输入的id 小于0, 则不拼接sql 语句(如果名字为空, 就不带名字条件,
如果输入的id 小于0, 就不带id 的条件)
- 修改MonsterMapper.java
//根据id 和名字来查询结果 public List<Monster> findMonsterByIdAndName(Monster monster);
- 修改MonsterMapper.xml
<!-- 1、配置public List<Monster> findMonsterByIdAndName(Monster monster); 2、查询id 大于 20的,并且名字是 "牛魔王" 的所有妖怪, 注意,如果名字为空, 或者输入的id 小于 0, 则不拼接 sql语句(如果名字为空 , 就不带名字条件,如果输入的id 小于 0, 就不带id的条件) 3、where + if : WHERE `id` > #{id} AND `name` = #{name} 4. 如果我们入参是对象,test表达式中, 直接使用对象的属性名即可 5. where标签,会在组织动态sql时,加上where 6. mybatis底层自动的去掉多余的AND --> <select id="findMonsterByIdAndName" parameterType="Monster" resultType="Monster"> SELECT * FROM `monster` <where> <if test="id >= 0"> AND `id` > #{id} </if> <if test="name != null and name != ''"> AND `name` = #{name} </if> </where> </select>
修改MonsterMapperTest.java 并完成测试
@Test public void findMonsterByIdAndName() { Monster monster = new Monster(); monster.setId(1); monster.setName("牛魔王-100"); List<Monster> monsters = monsterMapper.findMonsterByIdAndName(monster); for (Monster m : monsters) { System.out.println("m--" + m); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
choose/when/otherwise 应用实例
需求:如果给的name 不为空,就按名字查询妖怪,如果指定的id>0,就按id 来查询妖怪,
要求使用choose/when/otherwise 标签实现, 传入参数要求使用Map。
- 修改MonsterMapper.java
//测试choose标签的使用 public List<Monster> findMonsterByIdOrName_choose(Map<String, Object> map);
- 修改MonsterMapper.xml
<!-- 1、配置/实现public List<Monster> findMonsterByIdOrName_choose(Map<String, Object> map) 2、 1) 如果给的name不为空,就按名字查询妖怪, 2) 如果指定的id>0,就按id来查询妖怪 3) 如果前面两个条件都不满足, 就默认查询 salary > 100的 4) 使用mybatis 提供choose-when-otherwise --> <select id="findMonsterByIdOrName_choose" parameterType="map" resultType="Monster"> SELECT * FROM `monster` <choose> <when test="name != null and name != ''"> WHERE `name` = #{name} </when> <when test="id > 0"> WHERE `id` > #{id} </when> <otherwise> WHERE `salary` > 100 </otherwise> </choose> </select>
修改MonsterMapperTest.java 并完成测试
@Test public void findMonsterByIdOrName_choose() { Map<String, Object> map = new HashMap<>(); //map.put("name", "牛魔王-100"); map.put("id", -1); List<Monster> monsters = monsterMapper.findMonsterByIdOrName_choose(map); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
forEach 标签应用实例
需求:查询monster_id 为20, 22, 34 的妖怪
- 修改MonsterMapper.java
//测试foreach的标签使用 public List<Monster> findMonsterById_forEach(Map<String, Object> map);
修改MonsterMapper.xml
<!-- 1、配置/实现public List<Monster> findMonsterById_forEach(Map<String, Object> map); 2、查询id 为 10, 12, 14 的妖怪 3、是foreach标签 4. 入参map 中 会如何传入id值 k-v ids - [集合,比如List 10,12,14], 即 map 入参中应当有 ids-[10,12,14] --> <select id="findMonsterById_forEach" parameterType="map" resultType="Monster"> SELECT * FROM `monster` <!--解读 1、 where标签 2. 再写入相应的处理代码,比如判断ids 是否为空.. if 3. 如果ids不为空,则使用foreach标签进行遍历 4. collection="ids" 对应你的入参map的 key - ids 5. item="id" 在遍历ids集合时,每次取出的值,对应的变量id 6. open="(" 对应的就是sql (10,12,14) 的第一 ( 7. separator="," 遍历出来的多个值的 分隔符号 8. close=")" 对应的就是sql (10,12,14) 的最后 ) 9. #{id} 对应的就是 item="id" --> <if test="ids != null and ids !=''"> <where> id IN <foreach collection="ids" item="id" open="(" separator="," close=")"> #{id} </foreach> </where> </if> </select>
- 修改MonsterMapperTest.java 并完成测试
@Test public void findMonsterById_forEach() { Map<String, Object> map = new HashMap<>(); map.put("ids", Arrays.asList(10, 12, 14)); List<Monster> monsters = monsterMapper.findMonsterById_forEach(map); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
trim 标签应用实例
trim 可以替换一些关键字.要求:按名字查询妖怪,如果sql 语句有and | or 就替换成where。
- 修改MonsterMapper.java
//trim标签的使用 public List<Monster> findMonsterByName_Trim(Map<String, Object> map);
- 修改MonsterMapper.xml
<!-- 1. 配置/实现 public List<Monster> findMonsterByName_Trim(Map<String, Object> map); 2. 按名字和年龄 查询妖怪,如果sql语句开头有 and | or 就替换成 where 3. 分析,如果要实现这个功能,其实使用where标签 [加入where 同时会去掉多余的and] 4. trim prefix="WHERE" prefixOverrides="and|or|xxx" 若子句的开头为 “AND” 或 “OR 或"nlc" , 就去除 --> <select id="findMonsterByName_Trim" parameterType="map" resultType="Monster"> SELECT * FROM `monster` <trim prefix="WHERE" prefixOverrides="and|or|xxx"> <if test="name != null and name != ''"> AND `name` = #{name} </if> <if test="age != null and age != ''"> AND `age` > #{age} </if> </trim> </select>
修改MonsterMapperTest.java 并完成测试
@Test public void findMonsterByName_Trim() { Map<String, Object> map = new HashMap<>(); map.put("name", "牛魔王-100"); map.put("age", 10); List<Monster> monsters = monsterMapper.findMonsterByName_Trim(map); for (Monster monster : monsters) { System.out.println("monster--" + monster); } if (sqlSession != null) { sqlSession.close(); } System.out.println("操作成功~"); }
set 标签应用实例[重点]
需求: 请对指定id 的妖怪进行修改,如果没有设置新的属性,则保持原来的值
- 修改MonsterMapper.java
//测试Set 标签 public void updateMonster_set(Map<String, Object> map);
- 修改MonsterMapper.xml
<!-- 1. 配置/实现 public void updateMonster_set(Map<String, Object> map); 2. 请对指定id 的妖怪进行 修改,如果没有设置新的属性,则保持原来的值 3. 入参要根据sql语句来配合 map [age-10, email-'xx@sohu.com'...] 4. set标签会处理多余的 属性 --> <update id="updateMonster_set" parameterType="map"> UPDATE `monster` <set> <if test="age != null and age != ''"> `age` = #{age} , </if> <if test="email != null and email != ''"> `email` = #{email} , </if> <if test="name != null and name != ''"> `name` = #{name} , </if> <if test="birthday != null and birthday != ''"> `birthday` = #{birthday} , </if> <if test="salary != null and salary != ''"> `salary` = #{salary} , </if> <if test="gender != null and gender != ''"> `gender` = #{gender} , </if> </set> WHERE id = #{id} </update>
修改MonsterMapperTest.java 并完成测试
@Test public void updateMonster_set() { Map<String, Object> map = new HashMap<>(); map.put("id", 3); map.put("name", "牛魔王5-100"); map.put("age", 76); map.put("email", "hsp@qq.com"); monsterMapper.updateMonster_set(map); //修改需要有commit if (sqlSession != null) { sqlSession.commit(); sqlSession.close(); } System.out.println("操作成功~"); }