MyBatis-Plus笔记(一)
一、MyBatis-Plus
1.简介
该笔记主要参考尚硅谷教程:
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 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.支持数据库
任何能使用
MyBatis
进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下,如果不在下列表查看分页部分教程 PR 您的支持。
- MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb
- 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库
4.框架结构
5.官方地址
二、入门案例
开发环境
- IDE:IDEA 2019.3.5
- JDK:JDK8+
- 构建工具:Maven 3.5.4
- MySQL:MySQL 8.0.24
- Navicat:Navicat Premium 15
- Spring Boot:2.6.7
- MyBatis-Plus:3.5.1
准备数据
打开Navicat运行以下SQL脚本进行建库建表
1
2
3
4
5
6
7
8
9CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主键ID',
`name` varchar(30) DEFAULT NULL COMMENT '姓名',
`age` int(11) DEFAULT NULL COMMENT '年龄',
`email` varchar(50) DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;插入几条测试数据
1
2
3
4
5
6INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
创建工程
使用
Spring Initializer
快速初始化一个 Spring Boot 工程引入
MyBatis-Plus
的依赖1
2
3
4
5<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>安装
Lombok
插件
配置编码
配置
application.yml
文件1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#配置端口
server:
port: 80
spring:
#配置数据源
datasource:
#配置数据源类型
type: com.zaxxer.hikari.HikariDataSource
#配置连接数据库的信息
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
username: {username}
password: {password}
#MyBatis-Plus相关配置
mybatis-plus:
configuration:
#配置日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl在 Spring Boot 启动类中添加
@MapperScan
注解,扫描 Mapper 文件夹1
2
3
4
5
6
7
public class MybatisPlusDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusDemoApplication.class, args);
}
}编写实体类
User.java
(此处使用了 Lombok 简化代码)1
2
3
4
5
6
7
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}编写 Mapper 包下的
UserMapper
接口1
public interface UserMapper extends BaseMapper<User> {}
测试查询
编写一个测试类
MyBatisPlusTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public class MyBatisPlusTest {
private UserMapper userMapper;
/**
* 测试查询所有数据
*/
void testSelectList(){
//通过条件构造器查询一个list集合,若没有条件,则可以设置null为参数
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}控制台打印查询结果
三、增删改查
1.BaseMapper<T>
说明:
- 通用 CRUD 封装BaseMapper 接口,为
Mybatis-Plus
启动时自动解析实体表关系映射转换为Mybatis
内部对象注入容器- 泛型
T
为任意实体对象- 参数
Serializable
为任意类型主键Mybatis-Plus
不推荐使用复合主键约定每一张表都有自己的唯一id
主键- 对象
Wrapper
为条件构造器
MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现,因此我们继承该接口以后可以直接使用。
BaseMapper中提供的CRUD方法:
增加:Insert
1
2// 插入一条记录
int insert(T entity);删除:Delete
1
2
3
4
5
6
7
8// 根据 entity 条件,删除记录
int delete(; Wrapper<T> wrapper)
// 删除(根据ID 批量删除)
int deleteBatchIds(; Collection<? extends Serializable> idList)
// 根据 ID 删除
int deleteById(Serializable id);
// 根据 columnMap 条件,删除记录
int deleteByMap(; Map<String, Object> columnMap)修改:Update
1
2
3
4// 根据 whereWrapper 条件,更新记录
int update(; T updateEntity, Wrapper<T> whereWrapper)
// 根据 ID 修改
int updateById(; T entity)查询:Selete
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22// 根据 ID 查询
T selectById(Serializable id);
// 根据 entity 条件,查询一条记录
T selectOne(; Wrapper<T> queryWrapper)
// 查询(根据ID 批量查询)
List<T> selectBatchIds(; Collection<? extends Serializable> idList)
// 根据 entity 条件,查询全部记录
List<T> selectList(; Wrapper<T> queryWrapper)
// 查询(根据 columnMap 条件)
List<T> selectByMap(; Map<String, Object> columnMap)
// 根据 Wrapper 条件,查询全部记录
List<Map<String, Object>> selectMaps(; Wrapper<T> queryWrapper)
// 根据 Wrapper 条件,查询全部记录。注意: 只返回第一个字段的值
List<Object> selectObjs(; Wrapper<T> queryWrapper)
// 根据 entity 条件,查询全部记录(并翻页)
IPage<T> selectPage(IPage<T> page, ; Wrapper<T> queryWrapper)
// 根据 Wrapper 条件,查询全部记录(并翻页)
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, ; Wrapper<T> queryWrapper)
// 根据 Wrapper 条件,查询总记录数
Integer selectCount(; Wrapper<T> queryWrapper)
2.调用Mapper层实现CRUD
最终执行的结果,所获取的id为1527206783590903810
这是因为MyBatis-Plus在实现插入数据时,会默认基于雪花算法的策略生成id
1 | /** |
根据ID删除数据
调用方法:int deleteById(Serializable id);
1 | /** |
根据ID批量删除数据
调用方法:int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
1 | /** |
根据Map条件删除数据
调用方法:int deleteByMap(@Param(Constants.COLUMN_MAP) Map
columnMap);
1 | /** |
调用方法:int updateById(@Param(Constants.ENTITY) T entity);
1 | /** |
根据ID查询用户信息
调用方法:T selectById(Serializable id);
1 | /** |
根据多个ID查询多个用户信息
调用方法:List
selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
1 | /** |
根据Map条件查询用户信息
调用方法:List
selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
1 | /** |
查询所有用户信息
调用方法:List
selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
1 | /** |
3.通用Service
说明:
- 通用 Service CRUD 封装
IService
接口,进一步封装 CRUD 采用get 查询单行
remove 删除
list 查询集合
page 分页
前缀命名方式区分Mapper
层避免混淆,- 泛型
T
为任意实体对象- 建议如果存在自定义通用 Service 方法的可能,请创建自己的
IBaseService
继承Mybatis-Plus
提供的基类- 对象
Wrapper
为 条件构造器
MyBatis-Plus中有一个接口 IService
和其实现类 ServiceImpl
,封装了常见的业务层逻辑,详情查看源码IService和ServiceImpl
因此我们在使用的时候仅需在自己定义的Service
接口中继承IService
接口,在自己的实现类中实现自己的Service并继承ServiceImpl
即可
IService中的CRUD方法
增加:Save、SaveOrUpdate
1 | // 插入一条记录(选择字段,策略插入) |
删除:Remove
1 | // 根据 entity 条件,删除记录 |
修改:Update
1 | // 根据 UpdateWrapper 条件,更新记录 需要设置sqlset |
查询:Get、List、Count
1 | // 根据 ID 查询 |
分页:Page
1 | // 根据 ID 查询 |
4.调用Service层操作数据
我们在自己的Service接口中通过继承MyBatis-Plus提供的IService接口,不仅可以获得其提供的CRUD方法,而且还可以使用自身定义的方法。
创建
UserService
并继承IService
1
2
3
4/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User> {}创建
UserService
的实现类并继承ServiceImpl
1
2
3
4
5
6/**
* ServiceImpl实现了IService,提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求,则可以使用自定的UserService定义方法,并在实现类中实现
*/
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService{}测试查询记录数
调用方法:int count();
1
2
3
4
5
6
7
public void testGetCount(){
//查询总记录数
//执行的SQL为:SELECT COUNT( * ) FROM user
long count = userService.count();
System.out.println("总记录数:" + count);
}测试批量插入数据
调用方法:boolean saveBatch(Collection
entityList); 1
2
3
4
5
6
7
8
9
10
11
12
public void test(){
List<User> list = new ArrayList<>();
for (int i = 1; i <= 10; i++) {
User user = new User();
user.setName("Vz"+i);
user.setAge(20+i);
list.add(user);
}
boolean b = userService.saveBatch(list);
System.out.println(b ? "添加成功!" : "添加失败!");
}
四、常用注解
MyBatis-Plus提供的注解可以帮我们解决一些数据库与实体之间相互映射的问题。
1.@TableName
经过以上的测试,在使用MyBatis-Plus实现基本的CRUD时,我们并没有指定要操作的表,只是在Mapper接口继承BaseMapper时,设置了泛型User,而操作的表为user表,由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致。
引出问题
若实体类类型的类名和要操作的表的表名不一致,会出现什么问题?
我们将表
user
更名为t_user
,测试查询功能程序抛出异常,Table ‘mybatis_plus.user’ doesn’t exist,因为现在的表名为
t_user
,而默认操作的表名和实体类型的类名一致,即user
表
解决问题
使用注解解决问题
在实体类类型上添加
@TableName("t_user")
,标识实体类对应的表,即可成功执行SQL语句
1 |
|
使用全局配置解决问题
在开发的过程中,我们经常遇到以上的问题,即实体类所对应的表都有固定的前缀,例如
t_
或tbl_
此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就不需要在每个实体类上通过@TableName标识实体类对应的表
1 | mybatis-plus: |
2.@TableId
经过以上的测试,MyBatis-Plus在实现CRUD时,会默认将id作为主键列,并在插入数据时,默认基于雪花算法的策略生成id
引出问题
若实体类和表中表示主键的不是id,而是其他字段,例如uid,MyBatis-Plus会自动识别uid为主键列吗?
我们实体类中的属性
id
改为uid
,将表中的字段id
也改为uid
,测试添加功能程序抛出异常,Field ‘uid’ doesn’t have a default value,说明MyBatis-Plus没有将
uid
作为主键赋值
解决问题
在实体类中uid属性上通过
@TableId
将其标识为主键,即可成功执行SQL语句
1 |
|
@TableId的value属性
若实体类中主键对应的属性为id,而表中表示主键的字段为uid,此时若只在属性id上添加注解@TableId,则抛出异常Unknown column ‘id’ in ‘field list’,即MyBatis-Plus仍然会将id作为表的主键操作,而表中表示主键的是字段uid此时需要通过@TableId注解的value属性,指定表中的主键字段,
@TableId("uid")
或@TableId(value="uid")
@TableId的type属性
type属性用来定义主键策略:默认雪花算法
常用的主键策略:
值 | 描述 |
---|---|
IdType.ASSIGN_ID(默认) | 基于雪花算法的策略生成数据id,与数据库id是否设置自增无关 |
IdType.AUTO | 使用数据库的自增策略,注意,该类型请确保数据库设置了id自增, |
配置全局主键策略:
1 | #MyBatis-Plus相关配置 |
3.@TbaleField
经过以上的测试,我们可以发现,MyBatis-Plus在执行SQL语句时,要保证实体类中的属性名和表中的字段名一致
如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?
情况一
若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格
例如实体类属性userName
,表中字段user_name
此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格
相当于在MyBatis中配置
情况二
若实体类中的属性和表中的字段不满足情况1
例如实体类属性
name
,表中字段username
此时需要在实体类属性上使用
@TableField("username")
设置属性所对应的字段名
1 | public class User { |
4.@TableLogic
逻辑删除
物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除的数据
逻辑删除:假删除,将对应数据中代表是否被删除字段的状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录
使用场景:可以进行数据恢复
实现逻辑删除
数据库中创建逻辑删除状态列,设置默认值为0
实体类中添加逻辑删除属性
测试删除功能,真正执行的是修改
1
2
3
4
5public void testDeleteById(){
int result = userMapper.deleteById(1527472864163348482L);
System.out.println(result > 0 ? "删除成功!" : "删除失败!");
System.out.println("受影响的行数为:" + result);
}此时执行查询方法,查询的结果为自动添加条件
is_deleted=0