MyBatisPlus
1、MyBatisPlus概述
- 润物无声:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑。
- 效率至上:只需简单配置,即可快速进行单表 CRUD 操作,从而节省大量时间。
- 丰富功能:代码生成、物理分页、性能分析等功能一应俱全。
JPA、tk-mapper、MyBatisPlus都可以用来偷懒的!
简介
官网:MyBatisPlus ,MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作,BaseMapper
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求,以后简单的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 操作智能分析阻断,也可自定义拦截规则,预防误操作
2、快速入门
地址:快速开始
使用第三方组件:
1、导入对应的依赖
2、研究依赖如何配置
3、代码如何编写
4、提高扩展技术能力!
步骤
1、创建数据库 mybatis_plus
2、创建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)
);
DELETE FROM USER;
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');
3、编写项目,初始化项目!使用SpringBoot 初始化
4、导入依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.0</version>
</dependency>
说明:使用Mybatis-plus可以节省大量的代码,尽量不要同时导入 mybatis 和 mybatis-plus!版本的差异!
5、连接数据库!这一步和mybatis相同!
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同com.mysql.cj.jdbc.Driver、需要增加时区的配置 serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=rootroot
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
6、传统方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller
6、使用了mybatis-plus 之后
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
package com.king.mapper;
@ResponseBody
public interface UserMapper extends BaseMapper<User> {
}
- 注意点,我们需要再主启动类上去扫描的mapper包下的所有接口
@MapperScan("com.king.mapper") - 测试类中测试
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
- 结果
3、配置日志
所有的sql现在是不可见的,希望知道他是怎么执行的,所以必须要看日志!在 application.properties 配置文件中进行配置。
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完毕日志之后,便于开发测试。
4、CRUD扩展
4.1、插入操作
Insert插入
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired(required=false)
private UserMapper userMapper;
@Test
public void testInsert(){
User user = new User();
user.setName("张三");
user.setAge(23);
user.setEmail("1622840727@qq.com");
int result = userMapper.insert(user);
System.out.println(result);
System.out.println(user);
}
}
数据库插入的id默认值为:全局的唯一id
4.2、主键生成策略
默认:ID_WORKER全局唯一id
分布式系统唯一id生成方案:https://blog.csdn.net/weixin_35099248/article/details/121214802
雪花算法:
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。可以保证几乎全球唯一!
主键自增
我们需要配置主键自增:
1、实体类字段上@TableId(type = IdType.AUTO)
2、数据库字段一定要是自增的!
3、再次测试插入即可!
其他的源码解释
public enum IdType {
AUTO(0),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
ID_WORKER_STR(5);
}
4.3、更新操作
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired(required=false)
private UserMapper userMapper;
@Test
public void testUpdate(){
User user = new User();
user.setId(5L);
user.setName("陈伟");
user.setAge(20);
user.setEmail("1277077741@qq.com");
int i = userMapper.updateById(user);
System.out.println(i);
}
}
所有的SQL都是自动帮你动态配置的!
4.4、自动填充
创建时间、修改时间!这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create、gmr_modified、几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中不允许修改数据库)
1、在表中新增字段 这里就用create_time, update_time来表示gmt_create、gmr_modified
2、再次测试插入方法,我们需要先把实体类同步!
package com.king.pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private int age;
private String email;
private Date createTime;
private Date updateTime;
}
3、再次更新查看结果即可
方式二:代码级别
1、删除数据库的默认值,更新操作!
2、实体类的字段属性上需要增加注解
package com.king.pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private int age;
private String email;
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
}
3、编写处理器处理注解即可!
package com.king.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ......");
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ......");
this.setUpdateFieldValByName("updateTime", new Date(), metaObject);
}
}
4、测试插入
5、测试更新、观察时间即可!
4.5、乐观锁
乐观锁:顾名思义十分乐观,他总是认为不会出现问题,无论干什么不去上锁!如果出现了问题,再次更新值测试!
悲观锁:顾名思义十分悲观,他总是任务总是出现问题,无论干什么都会上锁!再去操作!
这里主要讲解,乐观锁机制!
乐观锁实现方式:
- 取出记录,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = new version where version = oldversion
- 如果version不对,就更新失败
乐观锁:1、先查询,获得版本号 version = 1
update user set name = "ChanV", version = version + 1
where id = 2 and version = 1
update user set name = "ChanV", version = version + 1
where id = 2 and version = 1
测试一下MP的乐观锁插件
1、给数据库中增加version字段!
2、我们实体类加对应的字段
package com.king.pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private int age;
private String email;
@Version
private Integer version;
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
}
3、注册组件
package com.king.config;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
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;
@MapperScan("com.king.mapper")
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {
@Bean
public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor(){
return new OptimisticLockerInnerInterceptor();
}
}
4、测试一下!
@Test
public void testOptimisticLocker(){
User user = userMapper.selectById(1330080433207046145L);
user.setName("king");
user.setEmail("123456@qq.com");
userMapper.updateById(user);
}
@Test
public void testOptimisticLocker2(){
User user = userMapper.selectById(5L);
user.setName("king111");
user.setEmail("123456@qq.com");
User user2 = userMapper.selectById(5L);
user2.setName("king222");
user2.setEmail("123456@qq.com");
userMapper.updateById(user2);
userMapper.updateById(user);
}
}
4.6、查询操作
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
@Test
public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
@Test
public void testSelectBatchIds(){
HashMap<String,Object> map = new HashMap<>();
map.put("name","Tom");
map.put("age",28);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
4.7、分页查询
分页在网站使用的十分之多!
1、原始的 limit 进行分页
2、一般使用pageHelper 第三方插件
3、MP其实也内置了分页插件,就不要去导入pageHelper 第三方插件依赖,直接使用MP内置的了
1、配置拦截器组件即可
package com.king.config;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
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;
@MapperScan("con.king.mapper")
@Configuration
@EnableTransactionManagement
public class MyBatisPlusConfig {
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor;
}
}
2、直接使用Page对象即可!
@Test
public void testPage(){
Page<User> page = new Page<>(2, 5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
}
4.8、删除操作
基本的删除操作
@Test
public void testDeleteById(){
userMapper.deleteById(1L);
}
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(2, 3, 4));
}
@Test
public void testDeleteMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name", "king");
userMapper.deleteByMap(map);
}
在工作中会遇到一些问题:逻辑删除(非真实删除)!
4.9、逻辑删除
物理删除:从数据库中直接移除
逻辑删除:在数据库中没有被移除,而是通过一个变量来让它失效!deleted = 0 => deleted = 1
管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!
测试一下:
1、在数据表中增加一个deleted字段
2、实体类中增加属性
package com.king.pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private int age;
private String email;
@TableLogic
private Integer deleted;
@Version
private Integer version;
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
}
3、配置! application.properties 配置文件:
spring.datasource.username=root
spring.datasource.password=rootroot
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4、测试一下删除!
@Test
public void testDeleteById(){
userMapper.deleteById(1L);
}
记录依旧在数据库,但是值确已经变化了!
5、测试一下查找
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
以上的所有CRUD操作及其扩展操作,都必须精通掌握!会大大提高工作和写项目的效率!
4.10、性能分析插件
我们在平时的开发中,会遇到一些慢sql。测试!druid…
作用:性能分析拦截器,用用于输出每条SQL语句及其执行时间
MP也提供性能分析插件,如果超过这个时间就停止运行
1、导入插件
2、测试使用!
(新版本不提供这个插件了)
4.11、 条件构造器
十分重要:Wappper, 官方文档:https://mp.baomidou.com/guide/wrapper.html#abstractwrapper
AbstractWrapper说明: AbstractWrapper 是QueryWrapper (LambdaQueryWrapper ) 和UpdateWrapper (LambdaUpdateWrapper) 的父类用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件。 注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为
写一些复杂的SQL就可以使用它来替代! 1、测试一,记住查看输出的SQL进行分析
@Test
void contextLoads() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age", 12);
userMapper.selectList(wrapper).forEach(System.out::println);
}
2、测试二,记住查看输出的SQL进行分析
@Test
void test2(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "king");
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
3、测试三
@Test
void test3(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 19, 30);
Integer count = userMapper.selectCount(wrapper);
System.out.println(count);
}
4、测试四,记住查看输出的SQL进行分析
@Test
void test4(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name", "b")
.likeRight("email", "t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
5、测试五
@Test
void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id", "select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
6、测试六
@Test
void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
更多的条件查询可以查看官方文档。
4.12、代码自动生成器
dao、pojo、service、controller都给AutoGenerator进行生成完成!
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
// 注意!!当前包未传递依赖 mp 包,需要自己引入
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
测试:
public class Code {
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator();
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("king");
gc.setOpen(false);
gc.setFileOverride(false);
gc.setServiceName("IService");
gc.setIdType(IdType.ID_WORKER);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("rootroot");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
PackageConfig pc = new PackageConfig();
pc.setParent("com.king");
pc.setModuleName("member");
pc.setEntity("pojo");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user","user_info","user_info2","user_info3","user_info4");
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setLogicDeleteFieldName("deleted");
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
mpg.setStrategy(strategy);
mpg.execute();
}
}
代码生成器(3.5.1+版本)请点击此处查看。
|