动态 SQL 是 MyBatis 的强大特性之一。在 JDBC 或其它类似的框架中,开发人员通常需要手动拼接 SQL 语句。根据不同的条件拼接 SQL 语句是一件极其痛苦的工作。例如,拼接时要确保添加了必要的空格,还要注意去掉列表最后一个列名的逗号。而动态 SQL 恰好解决了这一问题,可以根据场景动态的构建查询。
动态SQL(code that is executed dynamically),它一般是根据用户输入或外部条件动态组合的SQL语句块。 动态SQL能灵活的发挥SQL强大的功能、方便的解决一些其它方法难以解决的问题。 相信使用过动态SQL的人都能体会到它带来的便利,然而动态SQL有时候在执行性能 (效率)上面不如静态SQL,而且使用不恰当,往往会在安全方面存在隐患 (SQL 注入式攻击)。
Mybatis 动态 sql 可以让我们在 Xml 映射文件内,以标签的形式编写动态 sql,完成逻辑判断和动态拼接 sql 的功能。
元素
|
作用
|
备注
|
if
|
判断语句
|
单条件分支判断
|
choose(when、otherwise)
|
相当于 Java 中的 switch case 语句
|
多条件分支判断
|
trim,where
|
辅助元素
|
用于处理一些SQL拼装问题
|
foreach
|
循环语句
|
在in语句等列举条件常用
|
bind
|
辅助元素
|
拼接参数
|
原理为:使用 OGNL 从 sql 参数对象中计算表达式的值,根据表达式的值动态拼接 sql,以此来完成动态 sql 的功能。
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
-
项目地址:https://github.com/YunaiV/ruoyi-vue-pro
-
视频教程:https://doc.iocoder.cn/video/
MyBatis if 类似于 Java 中的 if 语句,是 MyBatis 中最常用的判断语句。使用 if 标签可以节省许多拼接 SQL 的工作,把精力集中在 XML 的维护上。
1)不使用动态sql
<select id="selectUserByUsernameAndSex"
resultType="user" parameterType="com.ys.po.User">
-- 这里和普通的sql 查询语句差不多,对于只有一个参数,后面的 #{id}表示占位符,里面 不一定要写id,
写啥都可以,但是不要空着,如果有多个参数则必须写pojo类里面的属性 -->
select * from user where username=#{username} and sex=#{sex}
select>
if 语句使用方法简单,常常与 test 属性联合使用。语法如下:
SQL语句
2)使用动态sql
上面的查询语句,我们可以发现,如果
#{username}
为空,那么查询结果也是空,如何解决这个问题呢?使用 if 来判断,可多个 if 语句同时使用。
以下语句表示为可以按照网站名称(name)或者网址(url)进行模糊查询。如果您不输入名称或网址,则返回所有的网站记录。但是,如果你传递了任意一个参数,它就会返回与给定参数相匹配的记录。
<select id="selectAllWebsite" resultMap="myResult">
select id,name,url from website
where 1=1
<if test="name != null">
AND name like #{name}
if>
<if test="url!= null">
AND url like #{url}
if>
select>
where、if同时使用可以进行查询、模糊查询
注意,
失败后,
关键字只会去掉库表字段赋值前面的and,不会去掉语句后面的and关键字,即注意,
只会去掉
语句中的最开始的and关键字。所以下面的形式是不可取的
<select id="findQuery" resultType="Student">
<include refid="selectvp"/>
<where>
<if test="sacc != null">
sacc like concat('%' #{sacc} '%')
if>
<if test="sname != null">
AND sname like concat('%' #{sname} '%')
if>
<if test="sex != null">
AND sex=#{sex}
if>
<if test="phone != null">
AND
phone=#{phone}
if>
where>
select>
这个“where”标签会知道如果它包含的标签中有返回值的话,它就插入一个‘where’。此外,如果标签返回的内容是以AND 或OR 开头的,则它会剔除掉。
set可以用来修改
<update id="upd">
update student
<set>
<if test="sname != null">sname=#{sname},
<if test="spwd != null">spwd=#{spwd},
<if test="sex != null">sex=#{sex},
<if test="phone != null">phone=#{phone}
sid=#{sid}
set>
where sid=#{sid}
update>
有时候,我们不想用到所有的查询条件,只想选择其中的一个,查询条件有一个满足即可,使用 choose 标签可以解决此类问题,类似于 Java 的 switch 语句
<select id="selectUserByChoose" resultType="com.ys.po.User" parameterType="com.ys.po.User">
select * from user
<where>
<choose>
<when test="id !='' and id != null">
id=#{id}
when>
<when test="username !='' and username != null">
and username=#{username}
when>
and sex=#{sex}
choose>
where>
select>
也就是说,这里我们有三个条件,id、username、sex,只能选择一个作为查询条件
-
如果 id 不为空,那么查询语句为:
select * from user where id=?
-
如果 id 为空,那么看username 是否为空,如果不为空,那么语句为
select * from user where username=?;
-
如果 username 为空,那么查询语句为
select * from user where sex=?
trim标记是一个格式化的标记,可以完成set或者是where标记的功能
①、用 trim 改写上面第二点的 if+where 语句
<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
select * from user
--
<if test="username != null">
username=#{username}
if>
<if test="username != null">
and sex=#{sex}
if>
where> -->
<trim prefix="where" prefixOverrides="and | or">
<if test="username != null">
and username=#{username}
if>
<if test="sex != null">
and sex=#{sex}
if>
trim>
select>
-
-
prefixoverride:去掉第一个and或者是or
②、用 trim 改写上面第三点的 if+set 语句
-- 根据 id 更新 user 表的数据 -->
<update id="updateUserById" parameterType="com.ys.po.User">
update user u
--
<if test="username != null and username != ''">
u.username = #{username},
if>
<if test="sex != null and sex != ''">
u.sex = #{sex}
if>
set> -->
<trim prefix="set" suffixOverrides=",">
<if test="username != null and username != ''">
u.username = #{username},
if>
<if test="sex != null and sex != ''">
u.sex = #{sex},
if>
trim>
where id=#{id}
update>
-
-
suffixoverride:去掉最后一个逗号(也可以是其他的标记,就像是上面前缀中的and一样)
③、trim+if同时使用可以添加
<insert
id="add">
insert into student
<trim prefix="(" suffix=")" suffixOverrides=",">
<if test="sname != null">sname,if>
<if test="spwd != null">spwd,if>
<if test="sex != null">sex,if>
<if test="phone != null">phone,if>
trim>
<trim prefix="values (" suffix=")" suffixOverrides=",">
<if test="sname != null">#{sname},
<if test="spwd != null">#{spwd},
<if test="sex != null">#{sex},
<if test="phone != null">#{phone}
trim>
insert>
foreach是用来对集合的遍历,这个和Java中的功能很类似。通常处理SQL中的in语句。
foreach 元素的功能非常强大,它允许你指定一个集合,声明可以在元素体内使用的集合项(item)和索引(index)变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符
你可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时,index 是当前迭代的序号,item 的值是本次迭代获取到的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值。
//批量查询
<select id="findAll" resultType="Student" parameterType="Integer">
<include refid="selectvp"/> WHERE sid in
"ids" collection="array" open="(" separator="," close=")">
#{ids}
select>
//批量删除
<delete id="del" parameterType="Integer">
delete from student where sid in
"ids" collection="array" open="(" separator="," close=")">
#{ids}
delete>
整合案例
xml
mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
select * from student
sql>
<select id="find" resultType="Student">
<include refid="selectvp"/>
select>
<select id="findbyid" resultType="student">
<include refid="selectvp"/>
WHERE 1=1
<if test="sid != null">
AND sid like #{sid}
if>
select>
<select id="findQuery" resultType="Student">
<include refid="selectvp"/>
<where>
<if test="sacc != null">
sacc like concat('%' #{sacc} '%')
if>
<if test="sname != null">
AND sname like concat('%' #{sname} '%')
if>
<if test="sex != null">
AND sex=#{sex}
if>
<if test="phone != null">
AND phone=#{phone}
if>
where>
select>
<update id="upd">
update student
<set>
<if test="sname != null">sname=#{sname},
<if test="spwd != null">spwd=#{spwd},
<if test="sex != null">sex=#{sex},
<if test="phone != null">phone=#{phone}
sid=#{sid}
set>
where sid=#{sid}
update>
<insert id="add">
insert into student
<trim prefix="(" suffix=")" suffixOverrides=",">
<if test="sname != null">sname,if>
<if test="spwd != null">spwd,if>
<if test="sex != null">sex,if>
<if test="phone != null">phone,if>
trim>
<trim prefix="values (" suffix=")" suffixOverrides=",">
<if test="sname != null">#{sname},
<if test="spwd != null">#{spwd},
<if test="sex != null">#{sex},
<if test="phone != null">#{phone}
trim>
insert>
<select id="findAll" resultType="Student" parameterType="Integer">
<include refid="selectvp"/> WHERE sid in
"ids" collection="array" open="(" separator="," close=")">
#{ids}
select>
<delete id="del" parameterType="Integer">
delete from student where sid in
"ids" collection="array" open="(" separator="," close=")">
#{ids}
delete>
测试类:
package com.yzx.test;
import com.yzx.entity.Student;
import com.yzx.mapper.StuMapper;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class StuTest {
SqlSession sqlSession=null;
InputStream is=null;
@Before
public void before() throws IOException {
//1.读取核心配置文件
is= Resources.getResourceAsStream("sqlMapperConfig.xml");
//2.拿到工厂构建类
SqlSessionFactoryBuilder sqlSessionFactoryBuilder=new SqlSessionFactoryBuilder();
//3.拿到具体工厂
SqlSessionFactory build=sqlSessionFactoryBuilder.build(is);
//4.拿到session
sqlSession = build.openSession();
}
@After
public void after(){
//7,提交事务
sqlSession.commit();
//8.关闭资源
sqlSession.close();
if(is!=null){
try {
is.close();
} catch (IOException e) {
e.printStackTrace();
}
};
}
//查询所有
@Test
public void find(){
//5.获取具体的mapper接口
StuMapper mapper=sqlSession.getMapper(StuMapper.class);
//6.调用执行
List list=mapper.find();
list.forEach(a-> System.out.println(a));
}
//查询单个
@Test
public void findbyid(){
StuMapper mapper=sqlSession.getMapper(StuMapper.class);
List list=mapper.findbyid(2);
list.forEach(a-> System.out.println(a));
}
//模糊查询
@Test
public void findQuery(){
StuMapper mapper=sqlSession.getMapper(StuMapper.class);
Student stu=new Student();
stu.setSname("小");
stu.setSex("男");
List list=mapper.findQuery(stu);
list.forEach(a-> System.out.println(a));
}
//修改
@Test
public void