mybatis-plus

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

一、MyBatis-Plus简介

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

二、入门案例

2.1创建数据库及表

CREATE 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;

INSERT 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');

2.2.创建Spring Boot工程并引入依赖

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId>
		<scope>test</scope>
	</dependency>
	<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
		<version>3.5.1</version>
	</dependency>
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<optional>true</optional>
	</dependency>
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
		<scope>runtime</scope>
	</dependency>
</dependencies>

注意：我们无法在创建项目时自动导入mysql-plus的依赖需要手动导入

2.3.idea中安装lombok插件

2.4.配置application.yml

spring:
# 配置数据源信息
	datasource:
# 配置数据源类型
		type: com.zaxxer.hikari.HikariDataSource
# 配置连接数据库信息
		driver-class-name: com.mysql.jdbc.Driver
		url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
		username: root
		password: 123456

2.5.配置启动类

在Spring Boot启动类中添加@MapperScan注解，扫描mapper包
配置之后会帮你生成接口的代理类并放在容器中

@SpringBootApplication
@MapperScan("com.atguigu.mybatisplus.mapper")
	public class MybatisplusApplication {
	public static void main(String[] args) {
	SpringApplication.run(MybatisplusApplication.class, args);
}
}

2.6.添加实体类

lombok中@Data作用
@Data 注解的主要作用是提高代码的简洁，使用这个注解可以省去代码中大量的get()、 set()、 toString()等方法
@Data ：注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法

@Data //lombok注解
public class User {
	private Long id;
	private String name;
	private Integer age;
	private String email;
}

2.7.添加mapper

BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型

public interface UserMapper extends BaseMapper<User> {

}

2.8.测试

注意
1.springboot的测试类都要统一加上@SpringBootTest注解
2.这里自动装配了userMapper 所以在启动类中的@MapperScan注解必不可少

@SpringBootTest
public class MybatisPlusTest {
	@Autowired
	private UserMapper userMapper;
	@Test
	public void testSelectList(){
	//selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
	userMapper.selectList(null).forEach(System.out::println);
}
}

2.9.添加日志

在application.yml中配置日志输出

# 配置MyBatis日志
mybatis-plus:
	configuration:
		log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

三、基本CRUD

BaseMapper
MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，接口如下：

1.传入一个实体类对象进行插入操作

int insert(T entity);

例子

 @Test
    public void testInsert()
    {
        user user =new user();
        user.setAge(23);
        user.setName("王少");
        user.setEmail("wangshao@qq.com");
        //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
        int result = userMapper.insert(user);
        System.out.println("受影响行数："+result);
    }

这样就把一个user对象插入到了表中

2.根据id删除某条记录

int deleteById(Serializable id);

例子

 @Test
    public void testDeleteById(){
        //通过id删除用户信息
        //DELETE FROM user WHERE id=?
        int result = userMapper.deleteById(1662034821079191553L);
        System.out.println("受影响行数："+result);
    }

3.传入一个实体类，根据实体类的id进行删除

int deleteById(T entity);

4.传入一个map对象，根据 columnMap 条件，删除记录

int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

例子

@Test
public void testDeleteByMap(){
	//根据map集合中所设置的条件删除记录
	//DELETE FROM user WHERE name = ? AND age = ?
	Map<String, Object> map = new HashMap<>();
	map.put("age", 23);
	map.put("name", "张三");
	int result = userMapper.deleteByMap(map);
	System.out.println("受影响行数："+result);
}

这样就会删除年龄为23 名字为张三的行
5.根据id进行批量删除 传入的是一个集合类型

int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extendsSerializable> idList);

@Test
public void testDeleteBatchIds(){
	//通过多个id批量删除
	//DELETE FROM user WHERE id IN ( ? , ? , ? )
	List<Long> idList = Arrays.asList(1L, 2L, 3L);
	int result = userMapper.deleteBatchIds(idList);
	System.out.println("受影响行数："+result);
}

6.传入一个实体对象，根据对象id进行修改操作

int updateById(@Param(Constants.ENTITY) T entity);

例子

 @Test
    public void testUpdateById(){
        user user = new user();
        user.setId(4L);
        user.setAge(19);
        user.setName("将少");
        user.setEmail("将shao@qq.com");
        //UPDATE user SET name=?, age=? WHERE id=?
        int result = userMapper.updateById(user);
        System.out.println("受影响行数："+result);
    }

7.根据id查询某条数据

T selectById(Serializable id);

8.根据id进行批量查询 传入的是一个集合

List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extendsSerializable> idList);

9.传入一个map集合 根据根据 columnMap 条件，查询记录

List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object>columnMap);

四、通用Service

除了内置的mapper以外 mybatis-plus还提供了内置的Service
说明:
通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承Mybatis-Plus 提供的基类

4.1.IService

MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑

创建Service接口和实现类

/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User> {
}

ServiceImpl实现了IService，提供了IService中基础功能的实现
若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements
UserService {
}

测试查询记录数

@Autowired
private UserService userService;
@Test
public void testGetCount(){
	long count = userService.count();
	System.out.println("总记录数：" + count);
}

测试批量插入

SQL长度有限制，海量数据插入单条SQL无法实行，
因此MP将批量插入放在了通用Service中实现，而不是通用Mapper

@Test
public void testSaveBatch(){
	ArrayList<User> users = new ArrayList<>();
	for (int i = 0; i < 5; i++) {
	User user = new User();
	user.setName("ybc" + i);
	user.setAge(20 + i);
	users.add(user);
}
//SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? )
userService.saveBatch(users);
}

五、常用注解

4.1.@TableName

在之前的测试中我们并没有特地的指定某一张表为我们操作的表，只是在Mapper接口继承BaseMapper时，设置了泛型User，而操作的表为user表。
由此得出结论，MyBatis-Plus在确定操作的表时，由BaseMapper的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致

问题：若实体类类型的类名和要操作的表的表名不一致，该怎么办

1.通过@TableName便可以解决问题了
在实体类类型上添加@TableName(“xxxr”)，标识实体类对应的表，即可成功执行SQL语句
2.通过全局配置也可以解决问题
如果实体类所对应的表都有固定的前缀，例如t_或tbl_此时，可以使用MyBatis-Plus提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过@TableName标识实体类对应的表

mybatis-plus:
	configuration:
	# 配置MyBatis日志
	log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
 global-config:
	db-config:
	# 配置MyBatis-Plus操作表的默认前缀
	 table-prefix: t_

4.2、@TableId

经过以上的测试，MyBatis-Plus在实现CRUD时，会默认将id作为主键列，并在插入数据时，默认基于雪花算法的策略生成id

问题若实体类和表中表示主键的不是id，而是其他字段，例如uid，MyBatis-Plus会自动识别uid为主键列吗？

肯定是不会的 这是我们就可以在实体类中uid属性上通过@TableId将其标识为主键，即可成功执行SQL语句

@TableId的type属性

type属性用来定义主键策略
tpye=IdType.ASSIGN_ID（默认） 基于雪花算法的策略生成数据id，与数据库id是否设置自增无关
tpye=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-typ

4.3.@TableField

经过以上的测试，我们可以发现，MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致
如果实体类中的属性名和字段名不一致我们就可以加上@TableField注解来解决

4.5.@TableLogic

物理删除

真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据

逻辑删除

假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
使用场景：可以进行数据恢复

实现逻辑删除步骤

1.数据库中创建逻辑删除状态列，设置默认值为0

就是在表中加一个字段设置默认值为0

2.在实体类中添加字段并加上@TableLogic注解

3.测试

测试删除功能，真正执行的是修改
UPDATE t_user SET is_deleted=1 WHERE id=? AND is_deleted=0
测试查询功能，被逻辑删除的数据默认不会被查询
SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0

五.条件构造器和常用接口

5.1.wapper介绍

Wrapper ： 条件构造抽象类，最顶端父类
–AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件
----QueryWrapper ： 查询条件封装
----UpdateWrapper ： Update 条件封装
----AbstractLambdaWrapper ： 使用Lambda 语法
--------LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapper
--------LambdaUpdateWrapper ： Lambda 更新封装Wrapper

5.2.QueryWrapper

组装查询条件

当查询的条件不是简单的根据id或者其它字段等，我们就可以使用QueryWrapper 来自定义条件进行查询
例如 查询用户名包含a，年龄在20到30之间，并且邮箱不为null的用户信息

@Test
public void test01(){
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
		queryWrapper.like("username", "a")
		.between("age", 20, 30)
		.isNotNull("email");
		List<User> list = userMapper.selectList(queryWrapper);
		list.forEach(System.out::println);
}

创建queryWrapper对象后就可以通过queryWrapper.方法的方式来设定查询的条件
最后把 queryWrapper传入selectList方法便可

组装排序条件

按年龄降序查询用户，如果年龄相同则按id升序排列
同理

@Test
public void test02(){
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
		queryWrapper
		.orderByDesc("age")
		.orderByAsc("id");
		List<User> users = userMapper.selectList(queryWrapper);
		users.forEach(System.out::println);
}

组装删除条件

删除email为空的用户
同理 条件构造器也可以构建删除语句的条件

@Test
public void test03(){
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper.isNull("email");
	int result = userMapper.delete(queryWrapper);
	System.out.println("受影响的行数：" + result);
}

组装select子句

如果我们只需要查询用户的部分信息我们也可以用条件构造器来构条件
查询用户信息的username和age字段

@Test
public void test05() {
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
		queryWrapper.select("username", "age");
		List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
		maps.forEach(System.out::println);
}

实现子查询

通过条件构造器中的insql方法实现
//查询id小于等于3的用户信息

@Test
public void test06() {
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
		queryWrapper.inSql("id", "select id from t_user where id <= 3");
		List<User> list = userMapper.selectList(queryWrapper);
		list.forEach(System.out::println);
}

5.3.UpdateWrapper

与QueryWrapper基本相似 UpdateWrapper便是可以构建更新的条件
//将（年龄大于20或邮箱为null）并且用户名中包含有a的用户信息修改

@Test
public void test07() {
		UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
		updateWrapper
		.set("age", 18)
		.set("email", "user@atguigu.com")
		.like("username", "a")
		.and(i -> i.gt("age", 20).or().isNull("email"));
		int result = userMapper.update(null, updateWrapper);
		System.out.println(result);

通过set方法来设置需要修改的字段名
再通过其它方法在设置条件
最后调用updata方法将构造器传入便可

5.4.condition

在真正开发的过程中，组装条件是常见的功能，而这些条件数据来源于用户输入，是可选的，因此我们在组装这些条件时，必须先判断用户是否选择了这些条件，若选择则需要组装该条件，若没有选择则一定不能组装，以免影响SQL执行的结果

使用带condition参数的重载方法构建查询条件，简化代码的编写
StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 返回值是一个boolean类型

@Test
public void test08UseCondition() {
		//定义查询条件，有可能为null（用户未输入或未选择）
		String username = null;
		Integer ageBegin = 10;
		Integer ageEnd = 24;
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
		queryWrapper
		.like(StringUtils.isNotBlank(username), "username", "a")
		.ge(ageBegin != null, "age", ageBegin)
		.le(ageEnd != null, "age", ageEnd);
		List<User> users = userMapper.selectList(queryWrapper);
		users.forEach(System.out::println);
}

5.5.LambdaQueryWrapper与LambdaUpdateWrapper

有时我们会写错实体类中的字段名 例如把age打成agc这样肯定会报错 用LambdaQueryWrapper与LambdaUpdateWrapper可以直接用一个函数式接口来访问实体类中属性的字段名 这样就可以很好的避免写错的问题

@Test
public void test09() {
		//定义查询条件，有可能为null（用户未输入）
		String username = "a";
		Integer ageBegin = 10;
		Integer ageEnd = 24;
		LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
		//避免使用字符串表示字段，防止运行时错误
		queryWrapper
		.like(StringUtils.isNotBlank(username), User::getName, username)
		.ge(ageBegin != null, User::getAge, ageBegin)
		.le(ageEnd != null, User::getAge, ageEnd);
		List<User> users = userMapper.selectList(queryWrapper);
		users.forEach(System.out::println);
}

@Test
public void test10() {
		//组装set子句
		LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
		updateWrapper
		.set(User::getAge, 18)
		.set(User::getEmail, "user@atguigu.com")
		.like(User::getName, "a")
		.and(i -> i.lt(User::getAge, 24).or().isNull(User::getEmail)); //lambda
		表达式内的逻辑优先运算
		User user = new User();
		int result = userMapper.update(user, updateWrapper);
		System.out.println("受影响的行数：" + result);
}

六、插件

6.1.分页插件

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

添加配置类

@Configuration
//扫描Mapper接口所在的包 让这个类变成UserMapper接口的实现类 可以在这里写也可以在启动类中写
@MapperScan("com.atuguigu.mapper.UserMapper")
public class MyBatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor()
    {
        MybatisPlusInterceptor interceptor=new MybatisPlusInterceptor();
        //添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

测试

@Test
public void testPage(){
		//设置分页参数
		Page<User> page = new Page<>(1, 5);
		userMapper.selectPage(page, null);
		//获取分页数据
		List<User> 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.乐观锁

场景模拟
一件商品，成本价是80元，售价是100元。老板先是通知小李，说你去把商品价格增加50元。小
李正在玩游戏，耽搁了一个小时。正好一个小时后，老板觉得商品价格增加到150元，价格太
高，可能会影响销量。又通知小王，你把商品价格降低30元。
此时，小李和小王同时操作商品后台系统。小李操作的时候，系统先取出商品价格100元；小王
也在操作，取出的商品价格也是100元。小李将价格加了50元，并将100+50=150元存入了数据
库；小王将商品减了30元，并将100-30=70元存入了数据库。是的，如果没有锁，小李的操作就
完全被小王的覆盖了。
现在商品价格是70元，比成本价低10元。几分钟后，这个商品很快出售了1千多件商品，老板亏1
万多。

乐观锁与悲观锁

上面的故事，如果是乐观锁，小王保存价格前，会检查下价格是否被人修改过了。如果被修改过
了，则重新取出的被修改后的价格，150元，这样他会将120元存入数据库。
如果是悲观锁，小李取出数据后，小王只能等小李操作完之后，才能对价格进行操作，也会保证
最终的价格是120元。

Mybatis-Plus实现乐观锁

数据库中添加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

修改实体类

@Data
public class Product {
		private Long id;
		private String name;
		private Integer price;
		@Version
		private Integer version;
}

添加乐观锁插件配置

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
		MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
		//添加分页插件
		interceptor.addInnerInterceptor(new
		PaginationInnerInterceptor(DbType.MYSQL));
		//添加乐观锁插件
		interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
		return interceptor;
}

优化流程

如果因为版本号导致失败，则重新获取version并更新

if(result2 == 0){
		//失败重试，重新获取version并更新
		p2 = productMapper.selectById(1L);
		p2.setPrice(p2.getPrice() - 30);
		result2 = productMapper.updateById(p2);
}

八.通用枚举

表中的有些字段值是固定的，例如性别（男或女），此时我们可以使用MyBatis-Plus的通用枚举来实现

流程

1.数据库表添加字段sex

2.创建通用枚举类型

package com.atguigu.mp.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;
	}
}

3.配置扫描通用枚举

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
	# 配置扫描通用枚举
	type-enums-package: com.atguigu.mybatisplus.enums

测试

@Test
public void testSexEnum(){
		User user = new User();
		user.setName("Enum");
		user.setAge(20);
		//设置性别信息为枚举项，会将@EnumValue注解所标识的属性值存储到数据库
		user.setSex(SexEnum.MALE);
		//INSERT INTO t_user ( username, age, sex ) VALUES ( ?, ?, ? )
		//Parameters: Enum(String), 20(Integer), 1(Integer)
		userMapper.insert(user);
}

九.MyBatisX插件

MyBatis-Plus为我们提供了强大的mapper和service模板，能够大大的提高开发效率
但是在真正开发过程中，MyBatis-Plus并不能为我们解决所有问题，例如一些复杂的SQL，多表
联查，我们就需要自己去编写代码和SQL语句，我们该如何快速的解决这个问题呢，这个时候可
以使用MyBatisX插件
MyBatisX一款基于 IDEA 的快速开发插件，为效率而生
MyBatisX插件用法：https://baomidou.com/pages/ba5b24/