Mybatis-Plus（新旧版本的实现与区别）
MyBatisPlus
MyBatisPlus概述
MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 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_Plus。 - 创建user表
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)
);
-- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified是必须有的
-- 阿里巴巴规范
插入数据
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]');
- 编写项目，使用springboot初始化项目
- 导入项目依赖
mysql
mysql-connector-java
org.projectlombok
lombok
com.baomidou
mybatis-plus-boot-starter
3.0.5
说明：使用mybatis-plus可以节省大量的代码，尽量不要同时导入mybatis-plus和mybatis，可能会存在版本差异！
- 连接数据库
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT&&useSSL=true&&useUnicode=true&&characterEncoding=UTF-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
-
传统方式pojo-dao（连接mybatis，配置mapper.xml文件）-service-controller
-
使用mybatis-plus之后
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private int id; private String name; private int age; private String email; } -
mapper接口
/** * 再对应的mapper上面继承基本的类 BaseMapper */ @Repository //代表持久层 public interface UserMapper extends BaseMapper<User> { }在主类上添加@MapperScan注解扫描mapper
@MapperScan("com.xjy.mapper")至此，所有的CRUD操作都已经完成了，你不需要像往常一样配置一大堆文件。
-
在测试类中测试
@SpringBootTest class MybatisplusApplicationTests { @Autowired UserMapper userMapper; @Test void contextLoads() { //查询全部用户，参数是一个Wrapper，条件构造器，这里先不用 List<User> users = userMapper.selectList(null); users.forEach(System.out::println); } }
-
配置日志
我们现在所有的sql都是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完日志之后，后面的学习就需要注意这个自动生成的SQL。
插入测试及雪花算法（crud扩展）
测试插入
@Test
public void testInsert() {
User user = new User();
user.setName("徐甲一");
user.setAge(18);
user.setEmail("[email protected]");
//他可以自动帮我们生成id
int result = userMapper.insert(user);
//受影响的行数
System.out.println(result);
//发现，id会自动回填
System.out.println(user);
}
数据库插入的id默认值为：全局的唯一id
雪花算法（snowflake）
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生4096个ID），最后还有一个符号位，永远是0.可以保证几乎全球唯一。
@TableId（type = ）
默认ID_WORKER全局唯一id
主键自增
配置主键自增：
- 实体类字段上
@TableId（type = IdType.AUTO） - 数组库字段一定要自增
- 再次测试即可
注意：在设置数据库id自增的时候一定要保证数据库中id没有为0的
其他的源码解释
/**
*
* 生成ID类型枚举类
*
*
* @author hubin
* @since 2015-11-10
*/
@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 testUpdate() {
User user = new User();
//通过条件自动拼接动态SQL
user.setId(7);
user.setName("xu");
int i = userMapper.updateById(user);
System.out.println(i);
}
自动填充
创建时间、修改时间，这些操作一般都是自动化完成的。
阿里巴巴开发手册：所有的数据库表：gmt_create（创建时间）、gmt_modified（修改时间）几乎所有的表都要配置，而且要自动化！（全球标准）
方式一：数据库级别（工作中不允许修改数据库，但是可以这么做）
- 在表中新增字段create_time、update_time.
- 把实体类同步，再次测试插入方法
private Date createTime;
private Date updateTime;
- 再次更新即可查看
方式二：代码级别
- 删除数据库的默认值、更新操作
- 实体类的字段属性上增加注解
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
- 编写处理器来处理这个注解
/**
* 一定不要忘了把处理器加到IOC容器中！
*/
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* 插入时的填充策略
* @param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill....");
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
/**
* 更新时的填充策略
* @param metaObject
*/
@Override
public void updateFill(MetaObject metaObject) {
log.info("start insert fill....");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
- 测试即可
乐观锁（OptimisticLockerInnerInterceptor）
在面试过程中，我们经常会被问到乐观锁、悲观锁！
乐观锁：顾名思义十分乐观，它总是认为不会出现问题，无论干什么都不去上锁！如果出现了问题，再次更新值测试。
悲观锁：顾名思义十分悲观，它总是认为总会出现问题，无论干什么都会上锁！再去操作！
这里主要理解乐观锁机制。 当要更新一条记录的时候，希望这条记录没有被别人更新 ，这里就需要用到乐观锁
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
乐观锁：先查询，会获得版本号version = 1
-- A线程
update user set name = "xusan", version = version +1
where id = 2 and version =1
-- B线程：如果b线程抢险完成的话，version = 2，就会导致A修改失败
update user set name = "xusan", version = version +1
where id = 2 and version =1
测试一下MP（mybatis-plus）的乐观锁插件
- 给数据库增加version字段
- 在实体类添加对应的字段
- 在实体类上添加乐观锁的注解
@version
@Version
private Integer version;
- 注册组件
// Spring Boot 方式
@Configuration
@MapperScan("按需修改")
public class MybatisPlusConfig {
/**
* 旧版
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
/**
* 新版
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mybatisPlusInterceptor;
}
}
这里因为用的是3.0.3版本，所以用的是旧版本
- 测试乐观锁
成功的情况（单线程，没有其他用户干扰）
@Test
public void testOptimisticLocker() {
//1、查询用户信息
User user = userMapper.selectById(1L);
//2、修改用户信息
user.setName("grace");
user.setEmail("[email protected]");
//3、执行更新操作
userMapper.updateById(user);
}
失败的情况（多线程，被其他用户进行插队操作）
@Test
public void testOptimisticLocker2() {
//1、查询用户信息
User user = userMapper.selectById(1L);
//2、修改用户信息(线程1)
user.setName("grace");
user.setEmail("[email protected]");
//模拟另外一个线程执行了插队
User user2 = userMapper.selectById(1L);
//2、修改用户信息(线程2)
user2.setName("sunday");
user2.setEmail("[email protected]");
userMapper.updateById(user2);
//3、执行更新操作
userMapper.updateById(user);
}
运行结果是sunday，如果没有乐观锁的话就会覆盖插队线程的值
查询操作
批量查询ArrasList、按条件查询map
分页查询
分页在网站使用的十分之多
- 原始的limit进行分页
- pageHelper第三方插件
- MP也有内置的分页插件
如何使用MP内置的分页插件
- 配置拦截器组件即可
//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;
}
}
因为版本问题，这里依旧用旧版的
/**
* 分页插件的配置文件
* @return
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
- 可以直接使用
@Test
public void testPagination() {
//参数一：当前页；参数二：页面大小
Page<User> page = new Page<>(1, 5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
}
删除操作
- 根据id删除数据
userMapper.deleteById(id). - 批量删除
userMapper.deleteBatchIds(Arrays.asList(id1,id2))。 - 通过map删除（增加条件）
userMapper.deleteByMap(map)。
逻辑删除
物理删除：从数据库中直接移除
逻辑删除：在数据库中没有被移除，而是通过一个变量来让他失效！delete=0 =>delete=1
例如管理员可以查看被删除的记录
这样可以方式数据的丢失，类似于回收站！（只对自动注入的SQL起效）
- 在数据库中增加一个
deleted字段 - 在实体类中增加字段并添加一个逻辑删除的注解
@TableLogic.
@TableLogic
private Integer deleted;
- 配置组件（老版）
/**
* 逻辑删除组件
* @return
*/
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
#配置逻辑删除
#删除的值
mybatis-plus.global-config.db-config.logic-delete-value=1
#没有删除的值
mybatis-plus.global-config.db-config.logic-not-delete-value=0
逻辑删除其实走的是更新操作（改变deleted的值），并不是删除操作。再查询的时候会自动过滤掉逻辑删除的字段。
新版使用方法
步骤一：配置（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)
步骤二：实体类字段上加上注解@TableLogic(同上)
常见问题
- 如何insert？
- 字段在数据库定义默认值(推荐)
- insert 前自己 set 值
- 使用自动填充功能
- 删除接口自动填充功能失效
- 使用
update方法并:UpdateWrapper.set(column, value)(推荐)- 使用
update方法并:UpdateWrapper.setSql("column=value")- 使用Sql注入器注入
com.baomidou.mybatisplus.extension.injector.methods.LogicDeleteByIdWithFill并使用(推荐)
性能分析插件
在平时的开发中，有时候会遇到一些慢sql。一般通过一些测试、druid来解决。
MP也提供了性能分析插件，如果超过这个时间就停止运行。
作用：性能分析拦截器，用于输出每条SQL语句及其执行时间。
该插件
3.2.0以上版本移除。官方推荐使用第三方扩展，执行SQL分析打印的功能
- 导入插件
/**
* sql执行效率插件
* @return
*/
@Bean
@Profile({"dev", "test"})
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
//设置SQL执行的最大时间，如果超过了则不执行
performanceInterceptor.setMaxTime(100);
//是否开启格式化支持
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
- 配置springboot环境为dev或者test环境！
#设置开发环境
spring.profiles.active=dev
- 测试使用即可（超出规定的时间会抛出异常）！
条件查询器（wrapper）
我们写一写复杂的sql的话可以使用它来代替
测试一：
@Test
void contextLoads() {
//查询name不为空的用户，并且邮箱不为空，年龄大于等于12岁
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age", 18);
userMapper.selectList(wrapper).forEach(System.out::println);
}
测试二：
@Test
void test2() {
//查询名字为石门的人,查询一个数据，出现多个结果使用List或者Map
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "Tom");
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
测试三：
@Test
void test3() {
//查询年龄在18在24岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 18, 24);
Integer count = userMapper.selectCount(wrapper);
System.out.println(count);
}
测试四：
@Test
void test4() {
//模糊查询
QueryWrapper<User> wrapper = new QueryWrapper<>();
//%门%
wrapper.notLike("name", "门")
//左：%xujiayi111 ；右：xujiayi111%
.likeRight("email", "xujiayi111");
final List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
测试五：inSql（column， inValue）
测试六：升序排序orderByAsc,降序排序orderByDESC。
代码自动生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
- 添加依赖
MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：
- 添加代码生成器依赖
com.baomidou
mybatis-plus-generator
3.4.1
- 添加模板引擎依赖， MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。
Velocity（默认）：
org.apache.velocity
velocity-engine-core
2.3
Freemarker：
org.freemarker
freemarker
latest-freemarker-version
Beetl：
com.ibeetl
beetl
latest-beetl-version
注意！如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。
AutoGenerator generator = new AutoGenerator();
// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());
// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());
// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());
// other config
...
- 编写配置
/**
* 代码自动生成器
*/
public class XjyCode {
public static void main(String[] args) {
//需要构建一个代码自动生成器 对象
AutoGenerator mpg = new AutoGenerator();
//配置策略
//1、全局配置
GlobalConfig gc = new GlobalConfig();
//获取用户的目录
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("徐先生");
gc.setOpen(false);
//是否覆盖原来生成的
gc.setFileOverride(false);
//去掉service的I前缀
gc.setServiceName("%sService");
gc.setIdType(IdType.ID_WORKER);
//日期的类型
gc.setDateType(DateType.ONLY_DATE);
//配置swagger
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
//设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT&&useSSL=true&&useUnicode=true&&characterEncoding=UTF-8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
//设置数据库的类型
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//包的配置
PackageConfig pc = new PackageConfig();
//设置模块名
pc.setModuleName("User");
//设置放在那个包下
pc.setParent("com.xjy");
//设置包的名字
pc.setEntity("pojo");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//策略配置
StrategyConfig sc = new StrategyConfig();
//设置要映射的表名(可以同时写多张表名)
sc.setInclude("user");
//下划线改驼峰命名
sc.setNaming(NamingStrategy.underline_to_camel);
sc.setColumnNaming(NamingStrategy.underline_to_camel);
//开启Lombok
sc.setEntityLombokModel(true);
//逻辑删除
sc.setLogicDeleteFieldName("deleted");
//设置自动填充策略
TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
sc.setTableFillList(tableFills);
//乐观锁
sc.setVersionFieldName("version");
//驼峰命名格式
sc.setRestControllerStyle(true);
//转换url格式:localhost:8080/hello_id_2
sc.setControllerMappingHyphenStyle(true);
mpg.setStrategy(sc);
mpg.execute();
}
}
高版本扩展： 第三方扩展执行SQL分析打印功能
该功能依赖 p6spy 组件，完美的输出打印 SQL 及执行时长，对于开发时研究sql语句很有用途。
- 添加依赖
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.8.1</version>
</dependency>
- 修改数据库连接配置为p6spy的配置（只需要改动driver和url即可）
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
spring.datasource.url=jdbc:p6spy:mysql://127.0.0.1:3306/database?useUnicode=true&characterEncoding=utf-8
- 添加p6spy的配置文件spy.properties
module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,batch,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2