MyBatisPlus总结

MyBatis-Plus时Mybatis的Best Partner

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

特性

• 无侵入
• 损耗小
• 强大的 CRUD 操作
• 支持 Lambda 形式调用
• 支持主键自动生成
• 支持 ActiveRecord 模式
• 支持自定义全局通用操作
• 内置代码生成器
• 内置分页插件
• 分页插件支持多种数据库
• 内置性能分析插件
• 内置全局拦截插件

#支持数据库

框架结构

引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 mybatis-spring-boot-starter和MyBatis-Spring，以避免因版本差异导致的问题

注解

@TableName

描述：表名注解，标识实体类对应的表

使用位置：实体类

注意: 默认是以对象名为表名，可以配置全局配置名字增加前缀，

也可以用@TableName进行注释表名，如下（同时配置，注解生效）

。@TableName("sys_user") public class User { private Long id; private String name; private Integer age; private String email; }

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMap	String	否	""	xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludeProperty	String[]	否	{}	需要排除的属性名 @since 3.3.1

关于 autoResultMap 的说明：

MP 会自动构建一个 resultMap 并注入到 MyBatis 里（一般用不上），请注意以下内容：

因为 MP 底层是 MyBatis，所以 MP 只是帮您注入了常用 CRUD 到 MyBatis 里，注入之前是动态的（根据您的 Entity 字段以及注解变化而变化），但是注入之后是静态的（等于 XML 配置中的内容）。

而对于 typeHandler 属性，MyBatis 只支持写在 2 个地方:

1. 定义在 resultMap 里，作用于查询结果的封装
2. 定义在 insert  update  #{property}  property #{property,typehandler=xxx.xxx.xxx} 设置值

除了以上两种直接指定 typeHandler 的形式，MyBatis 有一个全局扫描自定义 typeHandler 包的配置，原理是根据您的 property 类型去找其对应的 typeHandler 并使用。

@TableId

描述：主键注解

使用位置：实体类主键字段

@TableName("sys_user") public class User { @TableId private Long id; private String name; private Integer age; private String email; }

属性	类型	必须指定	默认值	描述
value	String	否	""	主键字段名
type	Enum	否	IdType.NONE	指定主键类型（在不写type类型的时候默认为雪花算法）

IdType

需要提前设置数据库自增

如果需要自己写主键，可以自己配置全局的主键生成策略

值	描述
AUTO	数据库 ID 自增（需要设置数据库的递增）
NONE	无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）
INPUT	insert 前自行 set 主键值
ASSIGN_ID	分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口 IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID	分配 UUID,主键类型为 String(since 3.3.0),使用接口 IdentifierGenerator的方法nextUUID (默认 default 方法)
ID_WORKER	分布式全局唯一 ID 长整型类型(pleaseuseASSIGN_ID)
UUID	32 位 UUID 字符串(please use ASSIGN_UUID )
ID_WORKER_STR	分布式全局唯一 ID 字符串类型(please use ASSIGN_ID )

@TableField

描述：字段注解（非主键）

@TableName("sys_user") public class User { @TableId private Long id; @TableField("nickname") private String name; private Integer age; private String email; }

属性	类型	必须指定	默认值	描述
value	String	否	""	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s} ， 参考

@Version

描述：乐观锁注解，标记@version在字段上

@EnumValue

描述：普通枚举类注解(标注在枚举字段上)

@TableLogic

描述：表字段逻辑处理注解(逻辑删除)

属性	类型	必须指定	默认值	描述
value	String	否	""	逻辑未删除值
delval	String	否	""	逻辑删除值

@OrderBy

描述：内置Sql默认指定排序，优先级低于wrapper条件查询

属性	类型	必须指定	默认值	描述
asc	boolean	否	true	是否倒序查询
sort	short	否	Short.MAX_VALUE	数字越小越靠前

@Mapper

写在Dao类上，将类注入Spring容器中

@MapperScan()

@MapperScan(value = {"com.aqiuo.dao"})

写在启动类上，将需要扫描的包写在value中

CRUD接口

Service CRUD 接口

说明: 通用 Service CRUD 封装IService (opens new window)

• get 查询单行 remove 删除
• list 查询集合
• page 分页
• Mapper 泛型 T 为任意实体对象 建议如果存在自定义通用 Service 方法的可能，
• 请创建自己的 IBaseService 基础 Mybatis-Plus 的基类 对象 Wrapper 为 条件构造器

save

// 插入一条记录（选择字段，策略插入） boolean save(T entity); // 插入（批量） boolean saveBatch(Collection entityList); // 插入（批量） boolean saveBatch(Collection entityList, int batchSize);

参数说明

类型	参数名	描述
T	entity	实体对象
Collection	entityList	实体对象集合
int	batchSize	插入批次数量

SaveOrUpdate

// TableId 注解存在更新记录，否插入一条记录，
//如果有这个记录，则修改记录，如果没有就插入记录
//如果没有id就是插入，有就是修改
boolean saveOrUpdate(T entity);
// 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList, int batchSize);

参数说明

类型	参数名	描述
T	entity	实体对象
Wrapper	updateWrapper	实体对象封装操作类 UpdateWrapper
Collection	entityList	实体对象集合
int	batchSize	插入批次数量

Remove

// 根据 queryWrapper 设置的条件，删除记录
boolean remove(Wrapper queryWrapper);
// 根据 ID 删除
boolean removeById(Serializable id);
// 根据 columnMap 条件，删除记录（map存的条件）
boolean removeByMap(Map columnMap);
// 删除（根据ID 批量删除）
boolean removeByIds(Collection idList);

参数说明

类型	参数名	描述
Wrapper	queryWrapper	实体包装类 QueryWrapper
Serializable	id	主键 ID
Map	columnMap	表字段 map 对象
Collection	idList	主键 ID 列表

Update

（注意updateById才能根据id修改内容，其他的要用wrapper）

// 根据 UpdateWrapper 条件，更新记录 需要设置sqlset
boolean update(Wrapper updateWrapper);
// 根据 whereWrapper 条件，更新记录
boolean update(T updateEntity, Wrapper whereWrapper);
// 根据 ID 选择修改
boolean updateById(T entity);
// 根据ID 批量更新
boolean updateBatchById(Collection entityList);
// 根据ID 批量更新
boolean updateBatchById(Collection entityList, int batchSize);

参数说明

类型	参数名	描述
Wrapper	updateWrapper	实体对象封装操作类 UpdateWrapper
T	entity	实体对象
Collection	entityList	实体对象集合
int	batchSize	更新批次数量

Get

// 根据 ID 查询
T getById(Serializable id);
// 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1")
T getOne(Wrapper queryWrapper);
// 根据 Wrapper，查询一条记录
T getOne(Wrapper queryWrapper, boolean throwEx);
// 根据 Wrapper，查询一条记录
Map getMap(Wrapper queryWrapper);
// 根据 Wrapper，查询一条记录
 V getObj(Wrapper queryWrapper, Function mapper);

参数说明

类型	参数名	描述
Serializable	id	主键 ID
Wrapper	queryWrapper	实体对象封装操作类 QueryWrapper
boolean	throwEx	有多个 result 是否抛出异常
T	entity	实体对象
Function	mapper	转换函数

List

// 查询所有
List list();
// 查询列表
List list(Wrapper queryWrapper);
// 查询（根据ID 批量查询）
Collection listByIds(Collection idList);
// 查询（根据 columnMap 条件）
Collection listByMap(Map columnMap);
// 查询所有列表
List> listMaps();
// 查询列表
List> listMaps(Wrapper queryWrapper);
// 查询全部记录
List