一、简介
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
安装
导入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
application.properties
# 数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=666666
# 日志配置
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
mapper
package com.kk.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.kk.pojo.Teacher;
import org.springframework.stereotype.Repository;
@Repository
public interface UserMapper extends BaseMapper<Teacher> {
}
MapperScan
package com.kk.mybatisplus;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("com.kk.mapper")
@SpringBootApplication
public class MybatisplusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisplusApplication.class, args);
}
}
测试
package com.kk.mybatisplus;
import com.kk.mapper.UserMapper;
import com.kk.pojo.Teacher;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class MybatisplusApplicationTests {
@Autowired
private UserMapper userMapper;
/**
* 查询
*/
@Test
void contextLoads() {
List list = userMapper.selectList(null);
System.out.println(list);
}
/**
* 插入
*/
@Test
void testInsert() {
Teacher teacher = new Teacher();
teacher.setTname("小柯");
int insert = userMapper.insert(teacher);
}
/**
* 更新
*/
@Test
void testUpdate() {
Teacher teacher = new Teacher();
teacher.setTid(5);
teacher.setTname("小南");
userMapper.updateById(teacher);
}
}
二、CRUD扩展
雪花算法
可以保证id几乎全球唯一
自动填充
创建时间、修改时间需要自动化完成，我们不希望手动更新！
1.实体类属性上增加注解
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
2.编写处理器，处理这个注解
package com.kk.handle;
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;
@Slf4j
@Component //为当前类注册组件，并加入到IoC容器
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill......");
this.setFieldValByName("createTime",new Date(),metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill......");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
（这个测试失败......）
乐观锁处理
乐观锁：永远乐观，无论做什么都不上锁，出了问题就重头再来
悲观锁：永远悲观，无论做什么都上锁！然后再操作
乐观锁的实现方式
- 取记录时，获取当前版本号（version）
- 更新时，带上这个版本号（set verson = newVersion where version = oldVersion）
- 如果版本号对比不上，则更新失败
配置类
package com.kk.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableTransactionManagement
@Configuration //表明当前类是一个配置类
public class MyBatisPlusConfig {
/**
* 注册乐观锁插件
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
分页查询
- limit分页
- pageHelper第三方插件分页
- MP内置的分页插件
MP分页插件如何使用
配置拦截器组件
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
直接使用Page对象
/**
* 测试分页
*/
@Test
void testPage(){
Page<Teacher> page = new Page<Teacher>(2,2);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page);
}
逻辑删除
只对自动注入的sql有效
步骤1: 配置com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig
- 例: application.yml
mybatis-plus:
global-config:
db-config:
logic-delete-value: 1
logic-not-delete-value: 0
步骤2: 实体类字段上加上@TableLogic注解
@TableLogic
private Integer deleted;
测试，实际走的是更新操作
@Test
void testDel(){
userMapper.deleteById(9l);
}
三、条件构造器（Wrapper）
@Test
void testWra(){
QueryWrapper<Teacher> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("tname")
.isNotNull("tid") //非空
.ge("version",2); //大于
userMapper.selectList(wrapper).forEach(System.out::println);
@Test
void testWra1(){
QueryWrapper<Teacher> wrapper = new QueryWrapper<>();
final QueryWrapper<Teacher> eq = wrapper.eq("tname", "小柯"); //等于
final List<Teacher> teachers = userMapper.selectList(eq);
System.out.println(teachers);
}
@Test
void testWra2(){
QueryWrapper<Teacher> wrapper = new QueryWrapper<>();
final QueryWrapper<Teacher> between = wrapper.between("version",2,3); //区间内
final List<Teacher> teachers = userMapper.selectList(between);
System.out.println(teachers);
}
@Test
void testWra3(){
QueryWrapper<Teacher> wrapper = new QueryWrapper<>();
wrapper
.notLike("tname", "1")
.likeRight("tname","小"); //模糊查询 = 小%
final List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
@Test
void testWra4(){
QueryWrapper<Teacher> wrapper = new QueryWrapper<>();
wrapper
.inSql("tid","select tid from teacher where tid>6"); //子查询
final List<Teacher> maps = userMapper.selectList(wrapper);
maps.forEach(System.out::println);
}
四、代码自动生成器
1.导入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
2.配置
package com.kk.mybatisplus;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
/**
*
* @author 柯神_
* @date 2021-03-11 15:48:09
* @Description 代码生成器
* @param
* @return
*/
public class AutoCode {
public static void main(String[] args) {
final AutoGenerator ag = new AutoGenerator();
// 1.全局配置
final GlobalConfig gc = new GlobalConfig();
final String projectPath = System.getProperty("user.dir"); // 获取当前目录
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("柯柯Ovo");
gc.setOpen(false); // 是否打开文件夹
gc.setFileOverride(false); // 是否覆盖
gc.setServiceName("%sService"); // 去掉 service 的前缀 I
gc.setIdType(IdType.AUTO);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
ag.setGlobalConfig(gc);
// 2.配置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUrl("jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC");
dsc.setUsername("root");
dsc.setPassword("666666");
dsc.setDbType(DbType.MYSQL);
ag.setDataSource(dsc);
// 3.包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.kk");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
ag.setPackageInfo(pc);
// 4.策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("student"); // 设置要映射的表
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("父类实体，没有就不用设置");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
ag.setStrategy(strategy);
strategy.setLogicDeleteFieldName("deleted"); // 逻辑删除
final TableFill createTime = new TableFill("create_time", FieldFill.INSERT);// 自动填充
final TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);// 自动填充
ArrayList<TableFill> list = new ArrayList<>();
list.add(createTime);
list.add(updateTime);
strategy.setTableFillList(list);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);
ag.setStrategy(strategy);
// 5.执行
ag.execute();
}
}
