1、简介
MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为
简化开发、提高效率而生。
2、特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分
CRUD 操作,更有强大的条件构造器,满足各类使用需求 - 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
- 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由
配置,完美解决主键问题 - 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强
大的 CRUD 操作 - 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
- 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、
Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用 - 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等
同于普通 List 查询
分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、
Postgre、SQLServer 等多种数据库 - 内置性能分析插件:可输出 SQL 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出
慢查询 - 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防
误操作
3、入门案例
3.1、数据库(user1)
3.2、创建一个SpringBoot项目
3.3、导入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
3.4、编写代码
application.yml
spring:
datasource:
type: com.zaxxer.hikari.HikariDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8&useSSL=false
username: root
password: root
# 配置MyBatis日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
注意:
1、驱动类driver-class-name
spring boot 2.0(内置jdbc5驱动),驱动类使用:
driver-class-name: com.mysql.jdbc.Driver
spring boot 2.1及以上(内置jdbc8驱动),驱动类使用:
driver-class-name: com.mysql.cj.jdbc.Driver
否则运行测试用例的时候会有 WARN 信息
2、连接地址url
MySQL5.7版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
MySQL8.0版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or
represents more
- 启动类:
MybaitsPlusApplication.class
@SpringBootApplication
@MapperScan("com.mybaitsplus.mapper")//扫描mapper包
public class MybaitsPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybaitsPlusApplication.class, args);
}
}
- 实体类:
User1.class
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User1 {
private Long id;
private String name;
private int age;
private String email;
}
- 添加mapper:
UserMapper.class
@Repository
/*
BaseMapper是MyBatis-Plus提供的模板mapper,其中包含了基本的CRUD方法,泛型为操作的
实体类型
*/
public interface UserMapper extends BaseMapper<User1> {
}
- 测试类:
Test.class
@SpringBootTest
public class Test {
@Autowired
private UserMapper userMapper;
@Test
public void testSelectList(){
List<User1> list = userMapper.selectList(null);
list.forEach(System.out::println);
}
}
注意:
IDEA在 userMapper 处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确
的执行。
为了避免报错,可以在mapper接口上添加 @Repository 注解
4、基本CRUD
MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现,我们可以直接使用,可自行查看:
public interface BaseMapper<T> extends Mapper<T> {
/**
* 插入一条记录
* @param entity 实体对象
*/
int insert(T entity);
/**
* 根据 ID 删除
* @param id 主键ID
*/
int deleteById(Serializable id);
/**
* 根据实体(ID)删除
* @param entity 实体对象
* @since 3.4.4
*/
int deleteById(T entity);
/**
* 根据 columnMap 条件,删除记录
* @param columnMap 表字段 map 对象
*/
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
/**
* 根据 entity 条件,删除记录
* @param queryWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where
语句)
*/
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
* 删除(根据ID 批量删除)
* @param idList 主键ID列表(不能为 null 以及 empty)
*/
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends
Serializable> idList);
/**
* 根据 ID 修改
* @param entity 实体对象
*/
int updateById(@Param(Constants.ENTITY) T entity);
/**
* 根据 whereEntity 条件,更新记录
* @param entity 实体对象 (set 条件值,可以为 null)
* @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成
where 语句)
*/
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER)
Wrapper<T> updateWrapper);
/**
* 根据 ID 查询
* @param id 主键ID
*/
T selectById(Serializable id);
/**
* 查询(根据ID 批量查询)
* @param idList 主键ID列表(不能为 null 以及 empty)
*/
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends
Serializable> idList);
/**
* 查询(根据 columnMap 条件)
* @param columnMap 表字段 map 对象
*/
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object>
columnMap);
/**
* 根据 entity 条件,查询一条记录
* <p>查询一条记录,例如 qw.last("limit 1") 限制取一条记录, 注意:多条数据会报异常
</p>
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
List<T> ts = this.selectList(queryWrapper);
if (CollectionUtils.isNotEmpty(ts)) {
if (ts.size() != 1) {
throw ExceptionUtils.mpe("One record is expected, but the query
result is multiple records");
}
return ts.get(0);
}
return null;
}
/**
* 根据 Wrapper 条件,查询总记录数
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
* 根据 entity 条件,查询全部记录
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
* 根据 Wrapper 条件,查询全部记录
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T>
queryWrapper);
/**
* 根据 Wrapper 条件,查询全部记录
* <p>注意: 只返回第一个字段的值</p>
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
* 根据 entity 条件,查询全部记录(并翻页)
* @param page 分页查询条件(可以为 RowBounds.DEFAULT)
* @param queryWrapper 实体对象封装操作类(可以为 null)
*/
<P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER)
Wrapper<T> queryWrapper);
/**
* 根据 Wrapper 条件,查询全部记录(并翻页)
* @param page 分页查询条件
* @param queryWrapper 实体对象封装操作类
*/
<P extends IPage<Map<String, Object>>> P selectMapsPage(P page,
@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}
4.1、插入
@Test
public void testInsert(){
User1 user = new User1();
user.setName("pc");
user.setAge(20);
user.setEmail("333@qq.com");
//INSERT INTO user1 ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
int result = userMapper.insert(user);
System.out.println("result:"+result);
System.out.println("id:"+user.getId());//1505851691209162753
// 这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id
}
4.2、删除
@Test
public void testDeleted(){
/*
这里的id后面加L是因为id是long类型的
*/
//通过id删除数据
//DELETE FROM user1 WHERE id=?
// int result = userMapper.deleteById(1505121187740635138L);
//根据map集合中所设置的条件删除用户信息
// Map<String,Object> map =new HashMap<>();
// map.put("name","zhn");
// map.put("age",20);
//DELETE FROM user1 WHERE name = ? AND age = ?
// int result = userMapper.deleteByMap(map);
//通过多个id实现批量删除
List<Long> list = Arrays.asList(1L, 2L, 3L);
//DELETE FROM user1 WHERE id IN ( ? , ? , ? )
int result = userMapper.deleteBatchIds(list);
System.out.println("result:"+result);
}
4.3、修改
@Test
public void testUpdate(){
User1 user = new User1();
//只会修改设置了的属性,未设置的属性不会修改
user.setId(1L);
user.setName("pym");
user.setAge(20);
user.setEmail("1.com");
//UPDATE user1 SET name=?, age=?, email=? WHERE id=?
int result = userMapper.updateById(user);
System.out.println("result:"+result);
}
4.4、查询
@org.junit.jupiter.api.Test
public void testSelect(){
//通过id查询
//SELECT id,name,age,email FROM user1 WHERE id=?
// User1 user = userMapper.selectById(1L);
// System.out.println(user);
//根据多个id查询多个用户查询
//SELECT id,name,age,email FROM user1 WHERE id IN ( ? , ? ,?)
// List<Long> list = Arrays.asList(1L, 2L, 3L);
// List<User1> users = userMapper.selectBatchIds(list);
// users.forEach(System.out::println);
//根据map集合中的条件来查询
//SELECT id,name,age,email FROM user1 WHERE name = ? AND age = ?
// Map<String,Object> map =new HashMap<>();
// map.put("name","pym");
// map.put("age",20);
// List<User1> users = userMapper.selectByMap(map);
// users.forEach(System.out::println);
//查询所有数据
//SELECT id,name,age,email FROM user1
List<User1> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
通过观察BaseMapper中的方法,大多方法中都有Wrapper类型的形参,此为条件构造器,可针
对于SQL语句设置不同的条件,若没有条件,则可以为该形参赋值null,即查询(删除/修改)所
有数据
4.5、通用Service
说明:
通用 Service CRUD 封装IService接口,进一步封装 CRUD 采用 get 查询单行 remove 删
除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆,
泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能,请创建自己的 IBaseService 继承
Mybatis-Plus 提供的基类
MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl,封装了常见的业务层逻辑
详情查看源码IService和ServiceImpl
- 创建Service接口和实现类
/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User1> {
}
/**
* ServiceImpl实现了IService,提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求,则可以使用自定的UserService定义方法,并在实现类中实现
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User1> implements UserService {
}
测试
@Autowired
private UserService userService;
@Test
public void testGetCount(){
//查询总记录数
long count = userService.count();
System.out.println("总记录数:"+count);
}
@Test
public void testInsertMore(){
// SQL长度有限制,海量数据插入单条SQL无法实行,
// 因此MP将批量插入放在了通用Service中实现,而不是通用Mapper
//批量添加
List<User1> list = new ArrayList<>();
for (int i=1;i<10;i++){
User1 user = new User1();
user.setName("pc"+i);
user.setAge(20+i);
list.add(user);
}
//INSERT INTO user1 ( id, name, age ) VALUES ( ?, ?, ? )
boolean b = userService.saveBatch(list);
System.out.println(b);
}
5、常用注解
5.1、@TableName
在使用MyBatis-Plus实现基本的CRUD时,我们并没有指定要操作的表,只是在Mapper接口继承BaseMapper时,设置了泛型User,而操作的表为user表。由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致。
若实体类类型的类名和要操作的表的表名不一致,会出现什么问题?
我将表名由user1改为t_user1:
(一)通过@TableName解决问题
在实体类类型上添加@TableName("t_user1")
,标识实体类对应的表,即可成功执行SQL语句
(二)通过全局配置解决问题
在开发的过程中,我们经常遇到以上的问题,即实体类所对应的表都有固定的前缀,例如t_或tbl_
此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就
不需要在每个实体类上通过@TableName标识实体类对应的表。
在application.yml
中添加以下代码:
# 设置Mybatis-Plus的全局配置
mybatis-plus:
global-config:
db-config:
# 设置实体类所对应的表的统一前缀
table-prefix: t_
5.2、@TableId
MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id。
若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主键列吗?我们实体类中的属性id改为uid,将表中的字段id也改为uid,测试:
(一)通过@TableId解决问题
在实体类中uid属性上通过@TableId将其标识为主键,即可成功执行SQL语句。
(二)@TableId的value属性
要通过@TableId注解的value属性,指定表中的主键字段,@TableId("uid")
或@TableId(value="uid")
补充:
@TableId
的type
属性:type
属性用来定义主键策略。
常用的主键策略:
值 | 描述 |
---|---|
IdType.ASSIGN_ID(默认) | 基于雪花算法的策略生成数据id,与数据库id是否设置自增无关 |
IdType.AUTO | 使用数据库的自增策略,注意,该类型请确保数据库设置了id自增,否则无效 |
配置全局主键策略:
mybatis-plus:
configuration:
# 配置MyBatis日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
db-config:
# 配置MyBatis-Plus操作表的默认前缀
table-prefix: t_
# 配置MyBatis-Plus的主键策略
id-type: auto
5.3、@TableField
我们可以发现,MyBatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名一致.
如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?
a>情况1:
若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格。例如实体类属性userName,表中字段user_name此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格相当于在MyBatis中配置。
b>情况2:
若实体类中的属性和表中的字段不满足情况1,例如实体类属性name,表中字段username
此时需要在实体类属性上使用@TableField(“username”)设置属性所对应的字段名。
5.4、@TableLogic
(一)逻辑删除:
- 物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据
- 逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库
中仍旧能看到此条数据记录 - 使用场景:可以进行数据恢复
(二)实现逻辑删除
数据库中创建逻辑删除状态列,设置默认值为0。
实体类中添加逻辑删除属性
测试:
测试删除功能,真正执行的是修改:
测试查询功能,被逻辑删除的数据默认不会被查询:
但是数据库中还是存在的:
6、条件构造器和常用接口
6.1、wapper介绍
Wrapper
: 条件构造抽象类,最顶端父类AbstractWrapper
: 用于查询条件封装,生成 sql 的 where 条件QueryWrapper
: 查询条件封装UpdateWrapper
: Update 条件封装AbstractLambdaWrapper
: 使用Lambda 语法的条件构造抽象类LambdaQueryWrapper
:用于Lambda语法使用的查询WrapperLambdaUpdateWrapper
: Lambda 更新封装Wrapper
6.2、QueryWrapper
将数据库的数据改变成:
(一)组装查询条件
@Test
public void test01(){
//查询用户名包含a,年龄在20到30之间,邮箱信息不为null的用户信息
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
AND (name LIKE ? AND age BETWEEN ?
AND ? AND email IS NOT NULL)
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.like("name","a")
.between("age",20,30)
.isNotNull("email");
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
(二)组装排序条件
@Test
public void test02(){
//查询用户信息,按年龄降序查询用户,如果年龄相同则按id升序排列
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
ORDER BY age DESC,uid ASC
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByDesc("age")
.orderByAsc("uid");
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
(三)组装删除条件
在此之前,我们往数据库添加一行数据:
@Test
public void test03(){
//删除email为空的用户
/*
因为我们添加了逻辑删除,所以删除功能变成了修改功能
UPDATE t_user1 SET is_deleted=1 WHERE is_deleted=0 AND (email IS NULL)
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("email");
int result = userMapper.delete(queryWrapper);
System.out.println("受影响的行数:"+result);
}
(四)使用QueryWrapper实现修改功能
@Test
public void test04(){
//将(年龄大于20并且用户名中包含有a)或邮箱为null的用户信息修改
/*
UPDATE t_user1 SET name=?, email=? WHERE is_deleted=0
AND (age > ? AND name LIKE ? OR email IS NULL)
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
//两个条件之间的连接默认是and
queryWrapper.gt("age", 20)
.like("name","a")
.or()
.isNull("email");
User1 user =new User1();
user.setName("李白");
user.setEmail("Tang.com");
int result = userMapper.update(user, queryWrapper);
System.out.println("受影响的行数:"+result);
}
(五)条件的优先级
@Test
public void test05(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
//lambda表达式内的逻辑优先运算
//i->i.gt("age",20).or().isNull("email")这个是lambda表达式
/*
UPDATE t_user1 SET name=?, age=?, email=? WHERE is_deleted=0
AND (name LIKE ? AND (age > ? OR email IS NULL))
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.like("name","a")
.and(i->i.gt("age",20).or().isNull("email"));
User1 user =new User1();
user.setName("李白");
user.setEmail("Tang.com");
int result = userMapper.update(user, queryWrapper);
System.out.println("受影响的行数:"+result);
}
(六)组装select子句
之前的查询会默认查询表里面的全部字段,但是我们可以设置我们想查询的字段:
@Test
public void test06(){
//查询用户信息的name和age字段
/*
SELECT name,age,email FROM t_user1 WHERE is_deleted=0
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.select("name","age","email");
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
maps.forEach(System.out::println);
}
(七)实现子查询
@Test
public void test07(){
//查询id小于等于3的用户信息
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
AND (uid IN (select uid from t_user1 where uid<=3))
*/
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.inSql("uid","select uid from t_user1 where uid<=3");
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
6.3、UpdateWrapper
前面用QueryWrapper实现修改功能:
@Test
public void test08(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
/*
UPDATE t_user1 SET name=?,email=? WHERE is_deleted=0
AND (name LIKE ? AND (age > ? OR email IS NULL))
*/
UpdateWrapper<User1> updateWrapper = new UpdateWrapper<>();
updateWrapper.like("name","a")
.and(i-> i.gt("age",20).or().isNull("email"))
.set("name","pc").set("email","1.com");
//这里必须要创建User对象,否则无法应用自动填充。如果没有自动填充,可以设置为null
int result = userMapper.update(null, updateWrapper);
System.out.println("受影响的行数:"+result);
}
6.4、带condition参数的方法
在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,必须先判断用户是否选择了这些条件,若选择则需要组装该条件,若没有选择则一定不能组装,以免影响SQL执行的结果。
思路一:
@Test
public void test09(){
//定义查询条件,有可能为null(用户未输入或未选择)
String name="";
Integer ageBegin=20;
Integer ageEnd=30;
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
if (StringUtils.isNotBlank(name)){
//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
queryWrapper.like("name",name);
}
if (ageBegin !=null){
queryWrapper.ge("age",ageBegin);
}
if (ageEnd != null){
queryWrapper.le("age",ageEnd);
}
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
AND (age >= ? AND age <= ?)
*/
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
思路二:
上面的实现方案没有问题,但是代码比较复杂,我们可以使用带condition参数的重载方法构建查询条件,简化代码的编写。
@Test
public void test010(){
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
AND (age >= ? AND age <= ?)
*/
String name="";
Integer ageBegin=20;
Integer ageEnd=30;
QueryWrapper<User1> queryWrapper = new QueryWrapper<>();
queryWrapper.like(StringUtils.isNotBlank(name),"name",name)
.ge(ageBegin != null,"age",ageBegin)
.le(ageEnd != null,"age",ageEnd);
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
6.5、LambdaQueryWrapper
可以防止我们手动输入参数时敲错单词。
@Test
public void test011(){
/*
SELECT uid,name,age,email,is_deleted FROM t_user1 WHERE is_deleted=0
AND (name LIKE ? AND age >= ?)
*/
String name="a";
Integer ageBegin=null;
Integer ageEnd=30;
LambdaQueryWrapper<User1> queryWrapper = new LambdaQueryWrapper<>();
//避免使用字符串表示字段,防止运行时错误
queryWrapper.like(StringUtils.isNotBlank(name),User1::getName,name)
.ge(ageBegin != null,User1::getAge,ageBegin)
.ge(ageEnd != null,User1::getAge,ageEnd);
List<User1> list = userMapper.selectList(queryWrapper);
list.forEach(System.out::println);
}
6.6、LambdaUpdateWrapper(和LambdaQueryWrapper一样)
使用之前的例子:
@Test
public void test012(){
/*
UPDATE t_user1 SET name=?,email=? WHERE is_deleted=0
AND (name LIKE ? AND (age > ? OR email IS NULL))
*/
String name="a";
Integer ageBegin=null;
Integer ageEnd=30;
LambdaUpdateWrapper<User1> updateWrapper = new LambdaUpdateWrapper<>();
updateWrapper.like(User1::getName,"a")
.and(i-> i.gt(User1::getAge,20).or().isNull(User1::getEmail));
updateWrapper.set(User1::getName,"pc").set(User1::getEmail,"1.com");
int result = userMapper.update(null, updateWrapper);
System.out.println("受影响的行数:"+result);
}
7、插件
7.1、分页插件
MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能。
- 创建一个config包,添加配置类:
MybatisPlusConfig.java
@Configuration
@MapperScan("com.mybaitsplus.mapper")//可以将主类中扫描包的注解移到此处
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor interceptor= new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
- 测试:
MybatisPlusPluginsTest.java
@SpringBootTest
public class MybatisPlusPluginsTest {
@Autowired
private UserMapper userMapper;
@Test
public void testPage(){
//设置分页参数
Page<User1> page= new Page<>(1,3);
userMapper.selectPage(page,null);
//获取分页数据
List<User1> list = page.getRecords();//获取当前页的数据
list.forEach(System.out::println);
System.out.println("当前页:"+page.getCurrent());
System.out.println("每页显示的条数:"+page.getSize());
System.out.println("总记录数:"+page.getTotal());
System.out.println("总页数:"+page.getPages());
System.out.println("是否有上一页:"+page.hasPrevious());
System.out.println("是否有下一页:"+page.hasNext());
}
}
7.2、xml自定义分页
- 在UserMapper接口中定义抽象方法
/**
* 通过年龄查询用户信息并分页
* @param page Mybatis-Plus所提供的分页对象,必须位于第一个参数的位置
* @param age
* @return
*/
Page<User1> selectPageVo(@Param("page") Page<User1> page, @Param("age") Integer age);
UserMapper.xml
中编写SQL
<select id="selectPageVo" resultType="User1">
select uid,name,age,email from t_user1 where age > #{age}
</select>
- 测试:
@Test
public void testPageVo(){
Page<User1> page = new Page<>(1,3);
//查询年龄大于20的用户并分页
userMapper.selectPageVo(page,20);
List<User1> list = page.getRecords();//获取当前页的数据
list.forEach(System.out::println);
System.out.println("当前页:"+page.getCurrent());
System.out.println("每页显示的条数:"+page.getSize());
System.out.println("总记录数:"+page.getTotal());
System.out.println("总页数:"+page.getPages());
System.out.println("是否有上一页:"+page.hasPrevious());
System.out.println("是否有下一页:"+page.hasNext());
}
7.3、乐观锁插件
(一)场景:
一件商品,成本价是80元,售价是100元。老板先是通知小李,说你去把商品价格增加50元。小李正在玩游戏,耽搁了一个小时。正好一个小时后,老板觉得商品价格增加到150元,价格太高,可能会影响销量。又通知小王,你把商品价格降低30元。此时,小李和小王同时操作商品后台系统。小李操作的时候,系统先取出商品价格100元;小王也在操作,取出的商品价格也是100元。小李将价格加了50元,并将100+50=150元存入了数据库;小王将商品减了30元,并将100-30=70元存入了数据库。是的,如果没有锁,小李的操作就完全被小王的覆盖了。现在商品价格是70元,比成本价低10元。几分钟后,这个商品很快出售了1千多件商品,老板亏1万多。
(二)乐观锁与悲观锁
上面的故事,如果是乐观锁,小王保存价格前,会检查下价格是否被人修改过了。如果被修改过了,则重新取出的被修改后的价格,150元,这样他会将120元存入数据库。
如果是悲观锁,小李取出数据后,小王只能等小李操作完之后,才能对价格进行操作,也会保证最终的价格是120元。
(三)模拟修改冲突
- 数据库中增加商品表
t_product
和数据
CREATE TABLE t_product
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称',
price INT(11) DEFAULT 0 COMMENT '价格',
VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号',
PRIMARY KEY (id)
);
INSERT INTO t_product (id, NAME, price) VALUES (1, '外星人笔记本', 100);
- 添加实体类
Product.java
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
private Long id;
private String name;
private Integer price;
private Integer version;
}
- 添加mapper:
ProductMapper.java
@Repository
public interface ProductMapper extends BaseMapper<Product> {
}
- 测试
@Test
public void testProduct01(){
//小李查询商品价格
Product productLi = productMapper.selectById(1);
System.out.println("小李查询的商品价格:"+productLi.getPrice());
//小李查询商品价格
Product productWang = productMapper.selectById(1);
System.out.println("小王查询的商品价格:"+productWang.getPrice());
//小李将商品价格+50
productLi.setPrice(productLi.getPrice()+50);
productMapper.updateById(productLi);
//小王将商品价格-30
productWang.setPrice(productWang.getPrice()-30);
productMapper.updateById(productWang);
//老板查询商品价格
Product productBoss = productMapper.selectById(1);
System.out.println("老板查询的商品价格:"+productBoss.getPrice());
}
(四)乐观锁实现流程
数据库中添加version字段,取出记录时,获取当前version
SELECT id,`name`,price,`version` FROM product WHERE id=1
更新时,version + 1,如果where语句中的version版本不对,则更新失败
UPDATE product SET price=price+50, `version`=`version` + 1 WHERE id=1 AND
`version`=1
(五)Mybatis-Plus实现乐观锁
- 修改实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Product {
private Long id;
private String name;
private Integer price;
@Version//标识乐观锁版本号字段
private Integer version;
}
- 添加乐观锁插件配置
MybatisPlusConfig.java
@Configuration
@MapperScan("com.mybaitsplus.mapper")
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor interceptor= new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
//添加乐观锁插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
用刚才的测试方法测试:
小李查询商品信息:
SELECT id,name,price,version FROM t_product WHERE id=?
小王查询商品信息:
SELECT id,name,price,version FROM t_product WHERE id=?
小李修改商品价格,自动将version+1
UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer)
小王修改商品价格,此时version已更新,条件不成立,修改失败
UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer)
最终,小王修改失败,查询价格:150
SELECT id,name,price,version FROM t_product WHERE id=?
优化流程:
@Test
public void testProduct01(){
//小李查询商品价格
Product productLi = productMapper.selectById(1);
System.out.println("小李查询的商品价格:"+productLi.getPrice());
//小李查询商品价格
Product productWang = productMapper.selectById(1);
System.out.println("小王查询的商品价格:"+productWang.getPrice());
//小李将商品价格+50
productLi.setPrice(productLi.getPrice()+50);
productMapper.updateById(productLi);
//小王将商品价格-30
//优化
productWang.setPrice(productWang.getPrice()-30);
int result = productMapper.updateById(productWang);
if (result==0){
//操作失败,重试
//重新查询商品(小李修改后的商品,versio已经+1)
Product productNew = productMapper.selectById(1);
productNew.setPrice(productNew.getPrice()-30);
productMapper.updateById(productNew);
}
//老板查询商品价格
Product productBoss = productMapper.selectById(1);
System.out.println("老板查询的商品价格:"+productBoss.getPrice());
}
8、通用枚举
表中的有些字段值是固定的,例如性别(男或女),此时我们可以使用MyBatis-Plus的通用枚举来实现。
(一)数据库表添加字段sex
(二)创建通用枚举类型
SexEnum.java
:
package com.mybaitsplus.enums;
import com.baomidou.mybatisplus.annotation.EnumValue;
import lombok.Getter;
@Getter
public enum SexEnum {
MALE(1,"男"),
FEMALE(2,"女");
@EnumValue//将注解锁标识的属性的值存储到数据库中
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
(三)配置扫描通用枚举
# 配置MyBatis日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
# 设置Mybatis-Plus的全局配置
global-config:
db-config:
# 设置实体类所对应的表的统一前缀
table-prefix: t_
#配置类型别名所对应的包
type-aliases-package: com/mybaitsplus/pojo
#扫描通用枚举的包
type-enums-package: com/mybaitsplus/enums
(四)测试
@SpringBootTest
public class MybatisPlusEnumTest {
@Autowired
private UserMapper userMapper;
@Test
public void test(){
User1 user = new User1();
user.setName("admin");
user.setAge(22);
//设置性别信息为枚举项,会将@EnumValue注解所标识的属性值存储到数据库
user.setSex(SexEnum.MALE);
//INSERT INTO t_user1 ( name, age, sex ) VALUES ( ?, ?, ? )
//Parameters: admin(String), 22(Integer), 1(Integer)
int result = userMapper.insert(user);
System.out.println("result:"+result);
}
}
9、代码生成器
(一)引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
(二)快速生成
直接创建一个测试类:FastAutoGeneratorTest.java
public class FastAutoGeneratorTest {
public static void main(String[] args) {
FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis?characterEncoding=utf-8&userSSL=false", "root", "root")
.globalConfig(builder -> {
builder.author("Serein") // 设置作者
// .enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D:\\IDEA\\Project\\MybatisPlusTest"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com") // 设置父包名
.moduleName("mybatisplus") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D:\\IDEA\\Project\\MybatisPlusTest"));// 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("t_user1") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}
在设置的路径下会生成如下:
10、多数据源
适用于多种场景:纯粹多库、 读写分离、 一主多从、 混合模式等
目前我们就来模拟一个纯粹多库的一个场景,其他场景类似
场景说明:
我们创建两个库,分别为:mybatis(以前的库不动)与mybatis_plus_1(新建),
将mybatis库的product表移动到mybatis_plus_1库,这样每个库一张表,通过一个测试用例
分别获取用户数据与商品数据,如果获取到说明多库模拟成功
和刚开始一样创建一个新的project,并导入需要的依赖,创建各种包和类(以下只列出和之前相比有改动的地方,其他参考上文)
(一)创建数据库及表
将之前数据库(mybatis)中的product表删除,然后创建一个新的数据库
CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus_1`;
CREATE TABLE product
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称',
price INT(11) DEFAULT 0 COMMENT '价格',
version INT(11) DEFAULT 0 COMMENT '乐观锁版本号',
PRIMARY KEY (id)
);
INSERT INTO product (id, NAME, price) VALUES (1, '外星人笔记本', 100);
(二)引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
(三)配置多数据源
说明:注释掉之前的数据库连接,添加新配置
spring:
# 配置数据源信息
datasource:
dynamic:
# 设置默认的数据源或者数据源组,默认值即为master
primary: master
# 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源
strict: false
datasource:
master:
url: jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: root
slave_1:
url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: root
(四)创建用户service
public interface UserService extends IService<User1> {
}
@DS("master") //指定所操作的数据源
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements
UserService {
}
(五)创建商品service
public interface ProductService extends IService<Product> {
}
@DS("slave_1")
@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapper, Product>
implements ProductService {
}
(六)测试
@Autowired
private UserService userService;
@Autowired
private ProductService productService;
@Test
public void testDynamicDataSource(){
System.out.println(userService.getById(1L));
System.out.println(productService.getById(1L));
}
11、MyBatisX插件
MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率,但是在真正开发过程中,MyBatis-Plus并不能为我们解决所有问题,例如一些复杂的SQL,多表
联查,我们就需要自己去编写代码和SQL语句,我们该如何快速的解决这个问题呢,这个时候可,以使用MyBatisX插件,MyBatisX一款基于 IDEA 的快速开发插件,为效率而生。
MyBatisX插件用法