参考教程:http://mp.baomidou.com/guide/
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
mybatis_plus
,注意字符集选择utf8mb4
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
使用 Spring Initializr
快速初始化一个Spring Boot
工程
Group:com.atguigu
Artifact:mybatis_plus
版本:2.0.7.RELEASE
这里都不勾选,后面直接把依赖引入进来,点击next
点击finish
spring-boot-starter
、spring-boot-starter-test
添加:mybatis-plus-boot-starter
、MySQL
、lombok
、
在项目中使用Lombok
可以减少很多重复代码的书写。比如说getter/setter/toString
等方法的编写
注意:引入 MyBatis-Plus
之后请不要再次引入 MyBatis
以及 MyBatis-Spring
,以避免因版本差异导致的问题。
修改前
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.2.0.RELEASE
com.atguigu
mybatis_plus
0.0.1-SNAPSHOT
mybatis_plus
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
org.junit.vintage
junit-vintage-engine
org.springframework.boot
spring-boot-maven-plugin
修改后
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.0.7.RELEASE
com.atguigu
mybatis_plus
0.0.1-SNAPSHOT
mybatis_plus
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter
org.springframework.boot
spring-boot-starter-test
test
com.baomidou
mybatis-plus-boot-starter
3.0.5
mysql
mysql-connector-java
org.projectlombok
lombok
org.springframework.boot
spring-boot-maven-plugin
在 application.properties
配置文件中添加 MySQL
数据库的相关配置:
本机的mysql
版本:mysql5
#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.1.103:3306/mybatis_plus?useSSL=false
spring.datasource.username=root
spring.datasource.password=000000
mysql8
以上(spring boot 2.1
)
注意:driver
和url
的变化
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.1.103:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=000000
注意:
1、这里的url
使用了 ?serverTimezone=GMT%2B8
后缀,因为Spring Boot 2.1
集成了 8.0
版本的jdbc
驱动,这个版本的 jdbc
驱动需要添加这个后缀,否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more
2、这里的 driver-class-name
使用了 com.mysql.cj.jdbc.Driver
,在 jdbc 8
中 建议使用这个驱动,之前的 com.mysql.jdbc.Driver
已经被废弃,否则运行测试用例的时候会有 WARN
信息
@MapperScan("com.atguigu.mybatis_plus.mapper")
配置扫描mapper
package com.atguigu.mybatis_plus;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.atguigu.mybatis_plus.mapper")
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
创建包entity
编写实体类 User.java
(此处使用了 Lombok 简化代码)
package com.atguigu.mybatis_plus.entity;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
因为使用了lombok
注解,自动生成了get
和set
方法
Lombok使用参考
创建包 mapper
编写Mapper 接口: UserMapper.java
package com.atguigu.mybatis_plus.mapper;
import com.atguigu.mybatis_plus.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface UserMapper extends BaseMapper {
}
package com.atguigu.mybatis_plus;
import com.atguigu.mybatis_plus.entity.User;
import com.atguigu.mybatis_plus.mapper.UserMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.List;
@SpringBootTest
@RunWith(SpringRunner.class)
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
public void testSelectList() {
System.out.println(("----- selectAll method test ------"));
//UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
//所以不填写就是无任何条件
List users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
注意:
IDEA
在 userMapper
处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确的执行。
为了避免报错,可以在 dao
层 的接口上添加 @Repository
注解
输出
修改application.properties
#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.1.103:3306/mybatis_plus?useSSL=false
spring.datasource.username=root
spring.datasource.password=000000
#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
再次查看输出
package com.atguigu.mybatis_plus;
import com.atguigu.mybatis_plus.entity.User;
import com.atguigu.mybatis_plus.mapper.UserMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class CRUDTests {
@Autowired
private UserMapper userMapper;
@Test
public void testInsert(){
User user = new User();
user.setName("Helen");
user.setAge(18);
user.setEmail("[email protected]");
int result = userMapper.insert(user);
//影响的行数
System.out.println(result);
//id自动会填
System.out.println(user);
}
}
注意:数据库插入id
值默认为:全局唯一id
,这里的id
是通过雪花算法生成的19
位
主键策略
ID_WORKER
MyBatis-Plus默认的主键策略是:ID_WORKER
全局唯一ID
参考资料:分布式系统唯一ID生成方案汇总
自增策略
要想主键自增需要配置如下主键策略,需要在创建数据表的时候设置主键自增,同时在实体字段中配置@TableId(type = IdType.AUTO)
如果要想影响所有实体的配置,可以设置全局主键配置,修改配置文件application.properties
,追加
#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto
其它主键策略:分析 IdType
源码可知
@Getter
public enum IdType {
/**
* 数据库ID自增
*/
AUTO(0),
/**
* 该类型为未设置主键类型
*/
NONE(1),
/**
* 用户输入ID
* 该类型可以通过自己注册自动填充插件进行填充
*/
INPUT(2),
/* 以下3种类型、只有当插入对象ID 为空,才自动填充。 */
/**
* 全局唯一ID (idWorker)
*/
ID_WORKER(3),
/**
* 全局唯一ID (UUID)
*/
UUID(4),
/**
* 字符串全局唯一ID (idWorker 的字符串表示)
*/
ID_WORKER_STR(5);
private int key;
IdType(int key) {
this.key = key;
}
}
@Test
public void testDeleteById(){
int result = userMapper.deleteById(8L);
System.out.println(result);
}
@Test
public void testDeleteBatchIds() {
int result = userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
System.out.println(result);
}
@Test
public void testDeleteByMap() {
HashMap map = new HashMap<>();
map.put("name", "Helen");
map.put("age", 18);
int result = userMapper.deleteByMap(map);
System.out.println(result);
}
数据库中添加 deleted字段
也可以采取业务层自动填充方案@TableField(fill = FieldFill.INSERT)
注解
ALTER TABLE `user` ADD COLUMN `deleted` boolean DEFAULT 0
实体类添加deleted 字段
并加上 @TableLogic
注解
修改配置文件application.properties
追加
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
在 MybatisPlusConfig 中注册 Bean
测试逻辑删除
测试后发现,数据并没有被删除,deleted
字段的值由0
变成了1
测试后分析打印的sql语句,是一条update
注意:被删除数据的deleted
字段的值必须是 0
,才能被选取出来执行逻辑删除的操作
/**
* 测试 逻辑删除
*/
@Test
public void testLogicDelete() {
int result = userMapper.deleteById(1L);
System.out.println(result);
}
删除前
删除后
控制台
测试逻辑删除后的查询
MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断
/**
* 测试 逻辑删除后的查询:
* 不包括被逻辑删除的记录
*/
@Test
public void testLogicDeleteSelect() {
User user = new User();
List users = userMapper.selectList(null);
users.forEach(System.out::println);
}
控制台
测试后分析打印的sql
语句,包含 WHERE deleted=0
注意:update
时生成的sql
自动是动态sql
:UPDATE user SET age=? WHERE id=?
@Test
public void testUpdateById(){
User user = new User();
user.setId(1L);
user.setAge(28);
int result = userMapper.updateById(user);
System.out.println(result);
}
项目中经常会遇到一些数据,每次都使用相同的方式填充,例如记录的创建时间,更新时间等。
我们可以使用MyBatis Plus的自动填充功能,完成这些字段的赋值工作:
数据库表中添加自动填充字段
在User
表中添加datetime
类型的新的字段 create_time
、update_time
自动填充方案一、数据级别的自动填充,分别设置默认值:
`create_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
`update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
自动填充方案二、业务层处理:
实体上增加字段并添加注解
编写实现元对象处理器接口
注意:不要忘记添加 @Component
注解
package com.atguigu.mybatis_plus.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ....");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
测试新增
@Test
public void testInsert(){
User user = new User();
user.setName("Helen");
user.setAge(18);
user.setEmail("[email protected]");
int result = userMapper.insert(user);
//影响的行数
System.out.println(result);
//id自动会填
System.out.println(user);
}
新增前
新增后
测试修改
@Test
public void testUpdateById(){
User user = new User();
user.setId(1L);
user.setAge(28);
int result = userMapper.updateById(user);
System.out.println(result);
}
修改前
修改后
主要适用场景:当要更新一条记录的时候,希望这条记录没有被别人更新,也就是说实现线程安全的数据更新
乐观锁实现方式:
取出记录时,获取当前version
:假设取出的version=1
SELECT id,name,age,email,create_time,update_time,version FROM user WHERE id=1
更新时,带上这个version
UPDATE USER SET `name`='helen yao', `version`=`version` + 1 WHERE id=1 AND `version`=1
执行更新时, set version = newVersion where version = oldVersion
如果version
不对,就更新失败
数据库中添加version字段
ALTER TABLE `user` ADD COLUMN `version` INT DEFAULT 1
实体类添加version字段
并添加 @Version
注解
特别说明:
支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime
整数类型下 newVersion = oldVersion + 1
,newVersion
会回写到 entity
中仅支持 updateById(id)
与 update(entity, wrapper)
方法
在 update(entity, wrapper)
方法下, wrapper
不能复用!!!
编写配置文件
创建包config
,创建文件MybatisPlusConfig.java
此时可以删除主类中的 @MapperScan
扫描注解,并注册bean
package com.atguigu.mybatis_plus.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
/**
* 乐观锁插件
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
测试乐观锁
要先查询出实体对象以获得更新前的版本号
/**
* 测试 乐观锁插件
*/
@Test
public void testOptimisticLocker() {
//查询
User user = userMapper.selectById(1L);
//修改数据
user.setName("Helen Yao");
user.setEmail("[email protected]");
//执行更新
userMapper.updateById(user);
}
更新前
更新后
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
完成了动态sql
的foreach
的功能
@Test
public void testSelectBatchIds(){
List users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
通过map
封装查询条件
@Test
public void testSelectByMap(){
HashMap map = new HashMap<>();
map.put("name", "Helen");
map.put("age", 18);
List users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
注意:map
中的key
对应数据库中的列名。如:数据库user_id
,实体类是userId
,这时map
的key
需要填写user_id
MyBatis Plus自带分页插件,只要简单的配置即可实现分页功能
修改配置类
添加分页插件
package com.atguigu.mybatis_plus.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
/**
* 乐观锁插件
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
测试分页查询
测试一
最终通过page
对象获取相关数据
@Test
public void testSelectPage() {
Page page = new Page<>(1,5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getCurrent());
System.out.println(page.getPages());
System.out.println(page.getSize());
System.out.println(page.getTotal());
System.out.println(page.hasNext());
System.out.println(page.hasPrevious());
}
控制台
测试二
@Test
public void testSelectMapsPage() {
Page page = new Page<>(1, 5);
IPage
控制台
Wrapper
: 条件构造抽象类,最顶端父类
AbstractWrapper
: 用于查询条件封装,生成 sql
的 where
条件
QueryWrapper
:Entity
对象封装操作类,不是用lambda
语法UpdateWrapper
: Update
条件封装,用于Entity
对象更新操作AbstractLambdaWrapper
: Lambda
语法使用 Wrapper
统一处理解析 lambda
获取 column
。
LambdaQueryWrapper
:看名称也能明白就是用于Lambda
语法使用的查询Wrapper
LambdaUpdateWrapper
: Lambda
更新封装Wrapper
package com.atguigu.mybatis_plus;
import com.atguigu.mybatis_plus.mapper.UserMapper;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class QueryWrapperTests {
@Autowired
private UserMapper userMapper;
}
注意:以下条件构造器的方法入参中的 column
均表示数据库字段
@Test
public void testDelete() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper
.isNull("name")
.ge("age", 12)
.isNotNull("email");
int result = userMapper.delete(queryWrapper);
System.out.println("delete return count = " + result);
}
控制台
注意:seletOne
返回的是一条实体记录,当出现多条时会报错
@Test
public void testSelectOne() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "Tom");
User user = userMapper.selectOne(queryWrapper);
System.out.println(user);
}
控制台
包含大小边界
@Test
public void testSelectCount() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.between("age", 20, 30);
Integer count = userMapper.selectCount(queryWrapper);
System.out.println(count);
}
控制台
@Test
public void testSelectList() {
QueryWrapper queryWrapper = new QueryWrapper<>();
Map map = new HashMap<>();
map.put("id", 2);
map.put("name", "Jack");
map.put("age", 20);
queryWrapper.allEq(map);
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
控制台
selectMaps
返回Map
集合列表
@Test
public void testSelectMaps() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper
.notLike("name", "e")
.likeRight("email", "t");
List
控制台
@Test
public void testSelectObjs() {
QueryWrapper queryWrapper = new QueryWrapper<>();
//queryWrapper.in("id", 1, 2, 3);
queryWrapper.inSql("id", "select id from user where id < 3");
List
控制台
注意:这里使用的是 UpdateWrapper
不调用or
则默认为使用 and
连
@Test
public void testUpdate1() {
//修改值
User user = new User();
user.setAge(99);
user.setName("Andy");
//修改条件
UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
userUpdateWrapper
.like("name", "h")
.or()
.between("age", 20, 30);
int result = userMapper.update(user, userUpdateWrapper);
System.out.println(result);
}
控制台
这里使用了lambda
表达式,or
中的表达式最后翻译成sql
时会被加上圆括号
@Test
public void testUpdate2() {
//修改值
User user = new User();
user.setAge(99);
user.setName("Andy");
//修改条件
UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
userUpdateWrapper
.like("name", "h")
.or(i -> i.eq("name", "李白").ne("age", 20));
int result = userMapper.update(user, userUpdateWrapper);
System.out.println(result);
}
控制台
@Test
public void testSelectListOrderBy() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.orderByDesc("id");
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
控制台
直接拼接到sql
的最后
注意:只能调用一次,多次调用以最后一次为准 有sql
注入的风险,请谨慎使用
@Test
public void testSelectListLast() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.last("limit 1");
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
控制台
@Test
public void testSelectListColumn() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.select("id", "name", "age");
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
控制台
最终的sql
会合并 user.setAge()
,以及userUpdateWrapper.set()
和 setSql()
中 的字段
@Test
public void testUpdateSet() {
//修改值
User user = new User();
user.setAge(99);
//修改条件
UpdateWrapper userUpdateWrapper = new UpdateWrapper<>();
userUpdateWrapper
.like("name", "h")
.set("name", "老李头")//除了可以查询还可以使用set设置修改的字段
.setSql(" email = '[email protected]'");//可以有子查询
int result = userMapper.update(user, userUpdateWrapper);
}
控制台
性能分析拦截器,用于输出每条SQL
语句及其执行时间
SQL
性能执行分析,开发环境使用,超过指定时间,停止运行。有助于发现问题
参数:maxTime
: SQL
执行最大时长,超过自动停止运行,有助于发现问题。
参数:format
: SQL
是否格式化,默认false
。
修改MybatisPlusConfig.java
/**
* SQL 执行性能分析插件
* 开发环境使用,线上不推荐。 maxTime 指的是 sql 最大执行时长
*/
@Bean
// 设置 dev test 环境开启
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100);//ms,超过此处设置的ms则sql不执行
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
复制application.properties
配置文件,分别为开发、生产、测试环境的配置文件
可以针对各环境新建不同的配置文件application-dev.properties
、application-test.properties
、application-prod.properties
也可以自定义环境名称:如test1
、test2
测试一
/**
* 测试 性能分析插件
*/
@Test
public void testPerformance() {
User user = new User();
user.setName("我是Helen");
user.setEmail("[email protected]");
user.setAge(18);
userMapper.insert(user);
}
控制台
测试二
将maxTime
改小为5
毫秒之后再次进行测试
控制台
执行时间如果超过5
毫秒则会报错,让你优化