一、引言
Good Good Study，Day Day Up，童鞋点个关注，不迷路，么么哒～～～
MP自带的条件构造器虽然很强大，有时候也避免不了写稍微复杂一点业务的sql，那么那么今天说说MP怎么自定义sql语句吧。
二、配置
自定义的sql当然是写在XML文件中的啦，那么首先来定义xml文件的位置，在yml配置文件如下
mybatis-plus:
# 如果是放在src/main/java目录下 classpath:/com/*/*/mapper/*Mapper.xml
# 如果是放在resource目录 classpath:/mapper/**.xml
mapper-locations: classpath:/mapper/**.xml
三、具体实现
使用注解实现：
在我们Mapper接口中定义自定义方法即可。
/**
* @Auther: IT贱男
* @Date: 2019/6/10 14:40
* @Description: User对象持久层
*/
public interface UserMapper extends BaseMapper {
/**
*
* 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法
*
* @param userWrapper
* @return
*/
@Select("SELECT * FROM user ${ew.customSqlSegment}")
List selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper userWrapper);
/**
* 和Mybatis使用方法一致
* @param name
* @return
*/
@Select("SELECT * FROM user where name = #{name}")
List selectByName(@Param("name") String name);
}
使用xml文件实现：
使用xml一定要指定xml文件所在位置
/**
* @Auther: IT贱男
* @Date: 2019/6/10 14:40
* @Description: User对象持久层
*/
public interface UserMapper extends BaseMapper {
/**
*
* 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法
*
* @param userWrapper
* @return
*/
List selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper userWrapper);
/**
* 和Mybatis使用方法一致
* @param name
* @return
*/
List selectByName(@Param("name") String name);
}
测试测试：
/**
* 自定义sql查询语句
*/
@Test
public void selectByMySelect() {
List users = userMapper.selectByName("王天风");
users.forEach(System.out::println);
}
/**
* 自定义sql使用Wrapper
*/
@Test
public void selectByMyWrapper() {
QueryWrapper wrapper = new QueryWrapper();
wrapper.like("name", "雨").lt("age", 40);
List users = userMapper.selectByMyWrapper(wrapper);
users.forEach(System.out::println);
}
四、回答评论区提问
提问一：能否提供自定义Update语句与Wrapper的整合使用呢？
/**
*
* 用户 Mapper 接口
*
*
* @author IT贱男
* @since 2019-06-14
*/
public interface UserMapper extends BaseMapper {
/**
* 自定Wrapper修改
*
* @param userWrapper 条件构造器
* @param user 修改的对象参数
* @return
*/
int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper userWrapper, @Param("user") User user);
}
UPDATE user SET email = #{user.email} ${ew.customSqlSegment}
@Test
public void updateByMyWrapper() {
// 条件构造器
QueryWrapper wrapper = new QueryWrapper();
wrapper.eq("name", "admin");
// 修改后的对象
User user = new User();
user.setEmail("[email protected]");
userMapper.updateByMyWrapper(wrapper, user);
}
接口方法的参数中，会出现各种 Wrapper，比如 queryWrapper、updateWrapper 等。Wrapper 的作用就是用于定义各种各样的条件（where）。所以不管是查询、更新、删除都会用到Wrapper。
Wrapper官方文档。
MyBatis-Plus系列推荐阅读顺序:
- MyBatis-Plus快速上手
- MyBatis-Plus 条件构造器（Wrapper）
- Mybatis-Plus 常用操作
一、Wrapper的继承关系：
Wrapper 条件构造抽象类
-- AbstractWrapper 查询条件封装，用于生成 sql 中的 where 语句。
-- QueryWrapper Entity 对象封装操作类，用于查询。
-- UpdateWrapper Update 条件封装操作类，用于更新。
-- AbstractLambdaWrapper 使用 Lambda 表达式封装 wrapper
-- LambdaQueryWrapper 使用 Lambda 语法封装条件，用于查询。
-- LambdaUpdateWrapper 使用 Lambda 语法封装条件，用于更新。
image
说明：很多文章提到MybatisPlus的
EntityWrapper，在3.0版本以上就没了，改为了QueryWrapper。
二、常用条件
【比较大小： ( =, <>, >, >=, <, <= )】
eq(R column, Object val); // 等价于 =，例: eq("name", "老王") ---> name = '老王'
ne(R column, Object val); // 等价于 <>，例: ne("name", "老王") ---> name <> '老王'
gt(R column, Object val); // 等价于 >，例: gt("name", "老王") ---> name > '老王'
ge(R column, Object val); // 等价于 >=，例: ge("name", "老王") ---> name >= '老王'
lt(R column, Object val); // 等价于 <，例: lt("name", "老王") ---> name < '老王'
le(R column, Object val); // 等价于 <=，例: le("name", "老王") ---> name <= '老王'
【范围：（between、not between、in、not in）】
between(R column, Object val1, Object val2); // 等价于 between a and b, 例： between("age", 18, 30) ---> age between 18 and 30
notBetween(R column, Object val1, Object val2); // 等价于 not between a and b, 例： notBetween("age", 18, 30) ---> age not between 18 and 30
in(R column, Object... values); // 等价于 字段 IN (v0, v1, ...),例: in("age",{1,2,3}) ---> age in (1,2,3)
notIn(R column, Object... values); // 等价于 字段 NOT IN (v0, v1, ...), 例: notIn("age",{1,2,3}) ---> age not in (1,2,3)
inSql(R column, Object... values); // 等价于 字段 IN (sql 语句), 例: inSql("id", "select id from table where id < 3") ---> id in (select id from table where id < 3)
notInSql(R column, Object... values); // 等价于 字段 NOT IN (sql 语句)
【模糊匹配：（like）】
like(R column, Object val); // 等价于 LIKE '%值%'，例: like("name", "王") ---> name like '%王%'
notLike(R column, Object val); // 等价于 NOT LIKE '%值%'，例: notLike("name", "王") ---> name not like '%王%'
likeLeft(R column, Object val); // 等价于 LIKE '%值'，例: likeLeft("name", "王") ---> name like '%王'
likeRight(R column, Object val); // 等价于 LIKE '值%'，例: likeRight("name", "王") ---> name like '王%'
【空值比较：（isNull、isNotNull）】
isNull(R column); // 等价于 IS NULL，例: isNull("name") ---> name is null
isNotNull(R column); // 等价于 IS NOT NULL，例: isNotNull("name") ---> name is not null
【分组、排序：（group、having、order）】
groupBy(R... columns); // 等价于 GROUP BY 字段, ...， 例: groupBy("id", "name") ---> group by id,name
orderByAsc(R... columns); // 等价于 ORDER BY 字段, ... ASC， 例: orderByAsc("id", "name") ---> order by id ASC,name ASC
orderByDesc(R... columns); // 等价于 ORDER BY 字段, ... DESC， 例: orderByDesc("id", "name") ---> order by id DESC,name DESC
having(String sqlHaving, Object... params); // 等价于 HAVING ( sql语句 )， 例: having("sum(age) > {0}", 11) ---> having sum(age) > 11
【拼接、嵌套 sql：（or、and、nested、apply）】
or(); // 等价于 a or b， 例：eq("id",1).or().eq("name","老王") ---> id = 1 or name = '老王'
or(Consumer consumer); // 等价于 or(a or/and b)，or 嵌套。例: or(i -> i.eq("name", "李白").ne("status", "活着")) ---> or (name = '李白' and status <> '活着')
and(Consumer consumer); // 等价于 and(a or/and b)，and 嵌套。例: and(i -> i.eq("name", "李白").ne("status", "活着")) ---> and (name = '李白' and status <> '活着')
nested(Consumer consumer); // 等价于 (a or/and b)，普通嵌套。例: nested(i -> i.eq("name", "李白").ne("status", "活着")) ---> (name = '李白' and status <> '活着')
apply(String applySql, Object... params); // 拼接sql（若不使用 params 参数，可能存在 sql 注入），例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08") ---> date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
last(String lastSql); // 无视优化规则直接拼接到 sql 的最后，可能存若在 sql 注入。
exists(String existsSql); // 拼接 exists 语句。例: exists("select id from table where age = 1") ---> exists (select id from table where age = 1)
【QueryWrapper 条件：】
select(String... sqlSelect); // 用于定义需要返回的字段。例： select("id", "name", "age") ---> select id, name, age
select(Predicate predicate); // Lambda 表达式，过滤需要的字段。
lambda(); // 返回一个 LambdaQueryWrapper
【UpdateWrapper 条件：】
set(String column, Object val); // 用于设置 set 字段值。例: set("name", null) ---> set name = null
setSql(String sql); // 用于设置 set 字段值。例: setSql("name = '老李头'") ---> set name = '老李头'
lambda(); // 返回一个 LambdaUpdateWrapper
三、 QueryWrapper
@Test
public void testQueryWrapper() {
// Step1：创建一个 QueryWrapper 对象
QueryWrapper queryWrapper = new QueryWrapper<>();
// Step2： 构造查询条件
queryWrapper
.select("id", "name", "age")
.lt("age", 23)//小于23岁
.like("name", "i");//name包括i字母
// Step3：执行查询
userMapper
.selectList(queryWrapper)
.forEach(System.out::println);
}
image
image
四、UpdateWrapper
4.1基本语法：
set
set(String column, Object val)
set(boolean condition, String column, Object val)
- SQL SET 字段
- 例:
set("name", "老李头") - 例:
set("name", "")--->数据库字段值变为空字符串 - 例:
set("name", null)--->数据库字段值变为null
setSql
setSql(String sql)
- 设置 SET 部分 SQL
- 例:
setSql("name = '老李头'")
4.2 测试
4.2.1 测试代码
@Test
public void testUpdateWrapper() {
int reduceAge = 2;
User user = new User();
// 更新用户数据的wrapper
UpdateWrapper updateWrapper = new UpdateWrapper();
//修改数据的语句
updateWrapper.set("email", "[email protected]");//使email字段的值更新为“[email protected]”
updateWrapper.setSql("age = age - " + reduceAge);//自定义的sql语句
//条件
updateWrapper.eq("id", 4);
userMapper.update(user, updateWrapper);
}
4.2.2 更新前的第4条数据：
image
4.2.3 执行测试代码：
image
4.2.4 更新后的第4条数据：
image
4.3 其他更新方法
仿照JPA更新过程，在JPA里面更新一般是先select取出数据，然后通过set方法修改entity的值，再save到数据库。
MP也提供类似的方式，见代码：
@Test
public void testUpdateById() {
User user = userMapper.selectById(4);
user.setAge(88);
userMapper.updateById(user);
}
4.3.1 执行测试代码：
==> Preparing: UPDATE user SET name=?, age=?, email=? WHERE id=?
==> Parameters: Oliver(String), 88(Integer), [email protected](String), 4(Long)
<== Updates: 1
4.3.2 更新后的第4条数据：
image