MybatisPlus学习笔记

本篇MybatisPlus笔记总结自 MybatisPlus最新入门到精通完整教程，快速上手Mybatis-Plus

Mybatis-Plus

Dao层工具，Mybatis的增强工具，只在其基础上增强不做改变

特点

无侵入：只做增强不做改变，引入它不会对现有工程产生影响

损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

依赖

引入Mybatis依赖

mybatis‐plus

 <!‐‐ https://mvnrepository.com/artifact/com.baomidou/mybatis‐plus ‐‐> 

引入mybatis-plus在spring boot中的场景启动器

mybatis‐plus‐boot‐starter

<!‐‐ https://mvnrepository.com/artifact/com.baomidou/mybatis‐plus‐boot‐starter ‐‐>

注意：引入Mybatis-plus相关依赖后不可再引入mybatis与mybatis-spring的依赖

BaseMapper

Mybatis-plus核心操作类，利用Mybatis接口编程的实现机制，默认提供CURD基础方法

定义Mapper时继承该接口后，不需要编写mapper.xml文件，就可以获得CURD功能

常用注解

@TableName：表名注解

@Tableld：主键注解

@TableField：字段注解

@TableName：对数据表名注解

@TableId：表主键标识
@TableId(value = "id", type = IdType.AUTO)：自增
@TableId(value = "id", type = IdType.INPUT)：自行输入
@TableId(value = "id", type = IdType.ID_WORKER_STR)：分布式全局唯一ID字符串类型
@TableId(value = "id", type = IdType.ID_WORKER)：分布式全局唯一ID 长整型类型
@TableId(value = "id", type = IdType.UUID)：32位UUID字符串
@TableId(value = "id", type = IdType.NONE)：无状态

@TableField：表字段标识
@TableField(exist = false)：表示该属性不为数据库表字段，但又是必须使用的。
@TableField(exist = true)：表示该属性为数据库表字段。
@TableField(condition = SqlCondition.LIKE)：表示该属性可以模糊搜索。
@TableField(fill = FieldFill.INSERT)：注解填充字段 ，生成器策略部分也可以配置！

@FieldStrategy：

@FieldFill

@Version：乐观锁注解、标记

@EnumValue：通枚举类注解

@TableLogic：表字段逻辑处理注解（逻辑删除）

@SqlParser：租户注解

@KeySequence：序列主键策略

官网：https://mybatis.plus/guide/annotation.html

CRUD

插入

// 插入一条记录
int insert(T entity);

entity没有赋值的字段取默认值

修改

// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

Mybatis-plus做了非空判断，空值的字段默认不更新

查询

// 根据 ID 查询
T selectById(Serializable id);

// 查询（根据ID 批量查询）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 底层使用in关键字拼接id作为查询条件

// 查询（根据 columnMap 条件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

删除

// 根据 ID 删除
int deleteById(Serializable id);

// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

// 根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

Wrapper

Wrapper

条件构造抽象类，最顶端父类，抽象类AbstractWrapper中提供3个方法和其他方法

AbstractWrapper

用于查询条件封装，生成 sql 的 where 条件,QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件

AbstractWrapper中的常用方法如下

AbstractLambdaWrapper

Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。

LambdaQueryWrapper

看名称也能明白就是用于Lambda语法使用的查询Wrapper

LambdaUpdateWrapper

Lambda 更新封装Wrapper

QueryWrapper

Entity 对象封装操作类，不是用lambda语法,自身的内部属性 entity 也用于生成 where 条件

select(String... sqlSelect)

select(Predicate<TableFieldInfo> predicate)

select(Class<T> entityClass, Predicate<TableFieldInfo> predicate) 

/*
例: select("id", "name", "age") 
例: select(i ‐> i.getProperty().startsWith("test"))
*/

UpdateWrapper

Update 条件封装，用于Entity对象更新操作.

set(String column, Object val)

set(boolean condition, String column, Object val)

/*
SQL SET 字段
例: set("name", "老李头")
例: set("name", "")‐‐‐>数据库字段值变为空字符串
例: set("name", null)‐‐‐>数据库字段值变为null 8 
说明:boolean condition为控制该字段是否拼接到最终的sql语句中
*/

setSql(String sql)

/*
设置 SET 部分 SQL
例: setSql("name = '老李头'")
*/

带条件的CRUD

带条件的查询

// 根据 Wrapper 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper); 

// 根据 Wrapper 条件，查询全部记录
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询全部Map类型的记录
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); 

// 根据 Wrapper 条件，查询全部Map类型的记录（并翻页）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWr apper); 

// 根据 Wrapper 条件，查询数据总条数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

带条件的更新

int update(Entity entity , UpdateWrapper)

带条件的删除

// 根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper); 

// 根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

全局配置

全局ID生成策略

在全局配置文件中： 就不需要再每个Pojo主键上配置了

mybatis‐plus:

global‐config:

db‐config: 

id‐type: auto

全局逻辑删除

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)

SQL分析打印

p6spy

百度Mybatis-plus如何配置p6spy

数据安全保护

1、得到16位随机秘钥

@Test
void test(){// 生成 16 位随机 AES 密钥

	String randomKey = AES.generateRandomKey();
	System.out.println(randomKey);

} 
da12166c7db8a58f

2、根据秘钥加密 数据库连接信息

@Test 
void test(){

	String url = AES.encrypt("jdbc:mysql://localhost:3306/mybatisplus?characterEncoding=utf8&useSSL=false &serverTimezone=UTC&" , "da12166c7db8a58f");
	String uname = AES.encrypt("root" , "da12166c7db8a58f");
	String pwd = AES.encrypt("123456" , "da12166c7db8a58f");

	System.out.println(url);
	System.out.println(uname);
	System.out.println(pwd);
}

3、修改配置文件 注意要mpw:开头

username: mpw:0Cj49ihj1Q6UbkRfixFdVg==

password: mpw:yp192XvO1C0jq67MeCvlIg==

url: mpw:nIh0E63gBfvpFbz2tXDyWDN2kFpD+apc9JaRYosGY5sKL3zyNwalK3OfGo27p8AM8BL0llHGFwpfdELaf79NIxm8kfOMh UdOFLNy7g85BTCrEzbYEHqp3THf7KOz80Ka

4、在部署的时候需要解密

java ‐jar xxxx.jar ‐‐mpw.key=你的16位随机秘钥， 越少人知道越好

乐观锁

乐观锁使用MyBatisPlus的解决方式

1、数据库表格加字段”version”进行版本控制

2、在类中加个属性

@Version //这就是控制版本的
@TableField(fill = FieldFill.INSERT) //这个方便在添加的时候设置版本初始为1
private Integer version; //版本的字段

3、实现MetaObjectHandler

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
	@Override
	public void insertFill(MetaObject metaObject) {
		//这里的“version”就是指定的字段，设置初始值为1，之后每修改一次+1
		this.setFieldValByName("version",1,metaObject);
	}

	@Override
	public void updateFill(MetaObject metaObject) {
	}
}

4、在MyBatis中存在一个乐观锁插件: OptimisticLockerInnerInterceptor

@Configuration
@MapperScan("com.lzz.mapper")
public class MyConfig {
	//乐观锁插件
	@Bean
	public OptimisticLockerInterceptor optimisticLockerInterceptor(){
		return new OptimisticLockerInterceptor();
	} 
}

5、直接调用insert方法插入数据即可

代码生成器