mybatis-plus-使用mybatis-plus

一、简介

官网：http://mp.baomidou.com/
参考教程：http://mp.baomidou.com/guide/
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化
开发、提高效率而生。

二、特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持多种数据库：支持MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer等多种数据库
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML启动
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 支持关键词自动转义：支持数据库关键词（order、key…）自动转义，还可自定义关键词
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
• 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

三、快速入门

快速开始 http://mp.baomidou.com/guide/quick-start.html

<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>
		<exclusions>
			<exclusion>
				<groupId>org.junit.vintage</groupId>
				<artifactId>junit-vintage-engine</artifactId>
			</exclusion>
		</exclusions>
	</dependency>
	<!--mybatis-plus-->
	<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
		<version>3.0.5</version>
	</dependency>
	<!--mysql-->
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
	</dependency>
	<!--lombok用来简化实体类-->
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
	</dependency>
</dependencies>

四、配置

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?
serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

五、编写代码

5.1 主类

5.2 实体类

5.3 mapper

5.4 使用

六、配置日志

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

七、主键生成策略

@TableId(type = IdType.AUTO)
private Long id;

要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略
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;
	}
}

八、自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。
我们可以使用 MyBatis Plus 的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段
在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

@Data
public class User {
	......
	@TableField(fill = FieldFill.INSERT)
	private Date createTime;
	
	//@TableField(fill = FieldFill.UPDATE)
	@TableField(fill = FieldFill.INSERT_UPDATE)
	private Date updateTime;
}

（3）实现元对象处理器接口

package com.atguigu.mybatisplus.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
	private static final Logger LOGGER =
	
	LoggerFactory.getLogger(MyMetaObjectHandler.class);
	@Override
	public void insertFill(MetaObject metaObject) {
		LOGGER.info("start insert fill ....");
		this.setFieldValByName("createTime", new Date(), metaObject);
		this.setFieldValByName("updateTime", new Date(), metaObject);
	}
	
	@Override
	public void updateFill(MetaObject metaObject) {
		LOGGER.info("start update fill ....");
		this.setFieldValByName("updateTime", new Date(), metaObject);
	}
}

九、乐观锁

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

（1）数据库中添加version字段

（2）实体类添加version字段

并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;

（3）元对象处理器接口添加version的insert默认值

@Override
public void insertFill(MetaObject metaObject) {
	......
	this.setFieldValByName("version", 1, metaObject);
}

特别说明:

• 支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime
• 整数类型下 newVersion = oldVersion + 1
• newVersion会回写到 entity中
• 仅支持updateById(id) 与 update(entity, wrapper) 方法
• 在 update(entity, wrapper) 方法下, wrapper 不能复用!

（4）在 MybatisPlusConfig 中注册 Bean

创建配置类

package com.atguigu.mybatisplus.config;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@EnableTransactionManagement
@Configuration
@MapperScan("com.atguigu.mybatis_plus.mapper")
public class MybatisPlusConfig {
	/**
	* 乐观锁插件
	*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
	return new OptimisticLockerInterceptor();
	}
}

十、分页插件

创建配置类

//Spring boot方式
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    // 旧版
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
    
    // 最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }
    
}

测试

@Test
public void testSelectPage() {
	Page<User> 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());
}

十一、逻辑删除

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
• 逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

（1）数据库中添加 deleted字段

ALTER TABLE `user` ADD COLUMN `deleted` boolean

（2）insert方式

（3）我们选择自动填充

• 实体类添加deleted 字段
  并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

@TableLogic
@TableField(fill = FieldFill.INSERT)
private Integer deleted;

• 元对象处理器接口添加deleted的insert默认值

@Override
public void insertFill(MetaObject metaObject) {
	......
	this.setFieldValByName("deleted", 0, metaObject);
}

（4）application.properties 加入配置
此为默认值，如果你的默认值和 mp 默认的一样 , 该配置可无

properties

# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
mybatis-plus.global-config.db-config.logic-delete-field=flag  

# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1 

# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0

yml

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

（5）在 MybatisPlusConfig 中注册 Bean

@Bean
public ISqlInjector sqlInjector() {
	return new LogicSqlInjector();
}

（6）测试逻辑删除

• 测试后发现，数据并没有被删除，deleted字段的值由0变成了1
• 测试后分析打印的sql语句，是一条update
• 注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作
  

十二、性能分析

性能分析拦截器，用于输出每条 SQL 语句及其执行时间
SQL 性能执行分析,开发环境使用，超过指定时间，停止运行。有助于发现问题

12.1 配置插件

（1）参数说明
参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。
参数：format： SQL是否格式化，默认false。
（2）在 MybatisPlusConfig 中配置

/**
* SQL 执行性能分析插件
* 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
	PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
	performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
	performanceInterceptor.setFormat(true);
	return performanceInterceptor;
}

（3）Spring Boot 中设置dev环境

#环境设置：dev、test、prod
spring.profiles.active=dev

十三、wapper介绍

13.1 条件构造器

13.2 AbstractWrapper

1、ge、gt、le、lt、isNull、isNotNull

@Test
public void testDelete() {
		QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper
		.isNull("name")
		.ge("age", 12)
		.isNotNull("email");
	int result = userMapper.delete(queryWrapper);
	System.out.println("delete return count = " + result);
}

2、eq、ne

@Test
public void testSelectOne() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper.eq("name", "Tom");
	User user = userMapper.selectOne(queryWrapper);
	System.out.println(user);
}

3、between、notBetween

包含大小边界，在20-30之间

@Test
public void testSelectCount() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper.between("age", 20, 30);
	Integer count = userMapper.selectCount(queryWrapper);
	System.out.println(count);
}

4、allEq

@Test
public void testSelectList() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	Map<String, Object> map = new HashMap<>();
	map.put("id", 2);
	map.put("name", "Jack");
	map.put("age", 20);
	queryWrapper.allEq(map);
	List<User> users = userMapper.selectList(queryWrapper);
	users.forEach(System.out::println);
}

5、like、notLike、likeLeft、likeRight

selectMaps返回Map集合列表

@Test
public void testSelectMaps() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper
		.notLike("name", "e")
		.likeRight("email", "t");
	List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);//返回值是Map列表
	maps.forEach(System.out::println);
}

6、in、notIn、inSql、notinSql、exists、notExists

@Test
public void testSelectObjs() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	//queryWrapper.in("id", 1, 2, 3);
	queryWrapper.inSql("id", "select id from user where id < 3");
	List<Object> objects = userMapper.selectObjs(queryWrapper);//返回值是Object列表
	objects.forEach(System.out::println);
}

7、or、and

@Test
public void testUpdate1() {
	//修改值
	User user = new User();
	user.setAge(99);
	user.setName("Andy");
	//修改条件
	UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
	userUpdateWrapper
	.like("name", "h")
	.or()
	.between("age", 20, 30);
	int result = userMapper.update(user, userUpdateWrapper);
	System.out.println(result);
}

8、嵌套or、嵌套and

@Test
public void testUpdate2() {
	//修改值
	User user = new User();
	user.setAge(99);
	user.setName("Andy");
	//修改条件
	UpdateWrapper<User> 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);
}

9、orderBy、orderByDesc、orderByAsc

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

10、last

@Test
public void testSelectListLast() {
	QueryWrapper<User> queryWrapper = new QueryWrapper<>();
	queryWrapper.last("limit 1");
	List<User> users = userMapper.selectList(queryWrapper);
	users.forEach(System.out::println);
}

11、指定要查询的列

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

12、set、setSql

@Test
public void testUpdateSet() {
	//修改值
	User user = new User();
	user.setAge(99);
	//修改条件
	UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
	userUpdateWrapper
	.like("name", "h")
	.set("name", "老李头")//除了可以查询还可以使用set设置修改的字段
	.setSql(" email = '123@qq.com'");//可以有子查询
	int result = userMapper.update(user, userUpdateWrapper);
}