MybatisPlus

MybatisPlus学习

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

快速开始

地址：https://mp.baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

使用第三方组件：

1. 导入对应的依赖
2. 配置依赖
3. 编写代码
4. 提高扩展

1.1步骤

1. 创建数据库mybatis_plus
2. 创建表

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)
);

3. 插入数据

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');

4. 创建springboot工程并导包

<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.0.5</version>
        </dependency>

5. mysql配置

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=will

6. 使用mybatisplus

   • 编写pojo文件

   import lombok.AllArgsConstructor;
   import lombok.Data;
   import lombok.NoArgsConstructor;
   
   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   public class User {
       private int id;
       private String name;
       private int age;
       private String email;
   }
   

   • 编写mapper

   import com.baomidou.mybatisplus.core.mapper.BaseMapper;
   import com.liao.mybatisplus01.pojo.User;
   import org.springframework.stereotype.Repository;
   
   @Repository//代表持久层
   public interface UserMapper extends BaseMapper<User> {
   //已经编写完所有CRUD
   }
   

   • 注意需要在主启动类中扫描mapper包下的接口

   @MapperScan("com.liao.mybatisplus01.mapper")//将所有mapper扫描进spring容器
   

   • 测试类中测试

   import com.liao.mybatisplus01.mapper.UserMapper;
   import com.liao.mybatisplus01.pojo.User;
   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 MybatisPlus01ApplicationTests {
       @Autowired
       private UserMapper userMapper;
       @Test
       void contextLoads() {
           List<User> users = userMapper.selectList(null);
           users.forEach(System.out::println);
       }
   
   }
   

   配置日志

   #配置日志
   

mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-8LNCBcYS-1635922403381)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211101225830929.png)]

# CRUD扩展

## 插入操作

```java
User user = new User();
user.setAge(3);
user.setEmail("2818927810@qq.com");
user.setName("will");
int result = userMapper.insert(user);

主键自增策略

给实体类中的属性配置注解，切换自增策略

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EHkMP6cq-1635922403383)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102165607895.png)]

//idType的几种值
AUTO(0),//自增，同事要在数据库表属性，设置id为自增才是使用
NONE(1),//该类型为未设置主键类型，设置后，必须手动注入id
INPUT(2),//用户输入id，类型可以通过自己注册自动填充插件进行填充
ID_WORKER(3),//默认是ID_WORKER,生成全局唯一的id
UUID(4),//全局唯一ID (UUID)
ID_WORKER_STR(5);//字符串全局唯一ID (idWorker 的字符串表示)

更新操作

User user = new User();
user.setId(3L);
user.setName("liao");
user.setAge(13);
int result = userMapper.updateById(user);//传入的是对象，跟据对象的id来更新数据

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-q1eYdbtX-1635922403385)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102171811325.png)]

所有的sql都是自动配置的

自动填充

根据阿里巴巴开发手册，所有的数据库表:gmt_creat,gmt_modified几乎所有的表都要配置上，而且需要实现自动化

方式一：数据库级别（实际开发中不允许操作数据库，只能操作sql）

数据库字段设置

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Dvgn187t-1635922403387)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102201238852.png)]

默认值设置为CURRENT_TIMESTAMP,

**注意：**若保存时出现以下报错，可能是数据库版本的问题。

Invalid default value for 'create_time'

添加字段

private Date createTime;
    private Date updateTime;与数据库对应，注意驼峰命名法和数据库表字段之间的转换

执行更新操作

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OT987Nu1-1635922403389)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102200942581.png)]

方式二：代码级别

1. 首先先删除默认值，还有更新操作

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FNPOK3P5-1635922403390)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102202700158.png)]

2. 根据官网给的教程：https://mp.baomidou.com/guide/auto-fill-metainfo.html

• 用注解标注填充字段

@TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

• 配置对象处理器MyMetaObjectHandler

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert....");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

• 测试运行

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TPtBmJfd-1635922403391)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102204005333.png)]

乐观锁

乐观锁：十分乐观，认为不会出问题，无论干什么，都不上锁，要是出问题，再更改值进行测试

悲观锁：十分悲观，认为一定会出问题，无论干什么都先上锁，再去操作。

乐观锁实现方式：

• 取出记录时，获取当前version，从数据库中查询出来，version=1
• 更新时，带上这个version，update user set name = “java” ,version = version+1
• 执行更新时， set version = newVersion where version = oldVersion where id = 2 and version = 1
• 如果version不对，就更新失败

测试mybatisplus乐观锁插件

1. 给数据库添加字段

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KsbelE7c-1635922403392)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102212119410.png)]

2. 给实体类添加字段和@version注释

@Version
    private int version;

3. 编写mybatisplus配置类，添加乐观锁拦截器

@MapperScan("com.liao.mybatisplus01.mapper")//将所有mapper扫描进spring容器
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4. 测试运行。

• 正常情况下（无竞争）

public void testHappyLock1(){
        User user1 = userMapper.selectById(1L);
        user1.setName("java");
        user1.setAge(19);
        userMapper.updateById(user1);
    }

​ 结果：version为4

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YMQJAuBl-1635922403397)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213413683.png)]

然后更新时where后的version=4，条件成立，插入成功（同时version只也加一）

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-khSI4PUS-1635922403398)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213551796.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-C7gBCNDt-1635922403399)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213719533.png)]

• 多线程（有竞争）

@Test
    public void testHappyLock2(){
        User user1 = userMapper.selectById(1L);
        user1.setName("java1111");
        user1.setAge(19);

        User user2 = userMapper.selectById(1L);
        user2.setName("java2222");
        user2.setAge(190);
        userMapper.updateById(user2);
        userMapper.updateById(user1);
    }

​ 结果：

先查询出version为3

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-pAdFWaIb-1635922403400)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213005070.png)]

此处，AND verison = 3条件成立，将4插入。name为java2222

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-odMgxjZI-1635922403401)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213202230.png)]

而java1111则插入失败。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-llqjUl72-1635922403402)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102213705979.png)]

查询操作

1. 根据id查询(所有集合的包都是util包下的)

User user = userMapper.selectById(1L);

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HcQpQbnf-1635922403403)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102234800001.png)]

2. 利用数组查询多个id

List<User> users = userMapper.selectBatchIds(Arrays.asList(1,2,3));

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-NadqISnW-1635922403404)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211102234951796.png)]

3. 利用map进行组合条件查询

Map<String,Object> map1 = new HashMap<>();
map1.put("name","will");//一个条件
List<User> users1 = userMapper.selectByMap(map1);查出两条记录
users1.forEach(System.out::println);

Map<String,Object> map2 = new HashMap<>();
map2.put("name","will");//一个条件
map2.put("age",4);//增加一个条件
List<User> users2 = userMapper.selectByMap(map2);查出一条记录
users2.forEach(System.out::println);//查询出一条记录

分页插件

分页的方法

1. 使用limit
2. pageHelper 第三方插件
3. MP内置的分页插件

使用方法:官网地址：https://mp.baomidou.com/guide/page.html

1. 配置拦截器

@Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

2. 使用page对象即可

@Test
    public void testPage(){
        Page<User> page = new Page<>(1,4);//arg1：当前页，arg2：页面大小
        userMapper.selectPage(page,null);
        //page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());//其实page在查询时已经吧所有的记录查了一边 count(1)=9
    }

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-O7lR2FFQ-1635922403405)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103084927890.png)]

删除操作

1. 根据id删除
2. 通过id批量删除
3. 通过map条件删除

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ejPWk7lq-1635922403406)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103085909798.png)]

sql注入成功，删除成功！

逻辑删除

1. 数据库添加delete字段，默认值为0
2. 实体类添加属性，并添加注解
3. 配置ISqlInjector //3.1.1开始不需要这一步

@Bean  //3.1.1开始不需要这一步
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }

4. 配置properties

#配置逻辑删除 1为逻辑已删除值（只有管理员可见），0为逻辑未删除值（用户能查到）
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5. 测试

@Test
    public void logicDelete(){
        //通过id
        userMapper.deleteById(1L);

    }

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lYBir53e-1635922403406)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103093133820.png)]

可以看到，删除操作转换为更新操作，只是将deleted的值设置为1，然后用户查询时，自动拼接deleted=0的条件，即可过滤被逻辑删除的记录，

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5CHxMx15-1635922403407)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103093459495.png)]

性能插件

1. 添加插件

@Bean
    @Profile({"dev","test"})//设置dev,test环境，保证效率
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//最大执行时间，超过这个时间就会报错
        performanceInterceptor.setFormat(true);//格式化sql语句
        return performanceInterceptor;
    }

2. 配置开发环境

#配置开发环境
spring.profiles.active=dev

2. 执行测试

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BAzyK8OP-1635922403408)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103095112537.png)]

条件构造器

1. 查询名字不为空，邮箱不为空，年龄大于4岁的用户。

//查询名字不为空，邮箱不为空，年龄大于4岁的用户。
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name").isNotNull("email")
                .ge("age",4);
        userMapper.selectList(wrapper).forEach(System.out::println);

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LC6L60IN-1635922403408)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103100819052.png)]

2. 模糊查询，name不含t,且email是以2开头的记录

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name","i")//相当于not like %i%
        .likeRight("email","2");//相当于2%
List<User> users = userMapper.selectList(wrapper);

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Ct4axFo6-1635922403410)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103102616402.png)]

3. 嵌套查询

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.inSql("id","select id from user where id<3");
List<User> users = userMapper.selectList(wrapper);

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A516nTzI-1635922403411)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103103336726.png)]

代码生成器

package com.liao.mybatisplus01;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
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;

public class GenerateCode {
    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("will");//设置作者
        gc.setOpen(false);//设置为false，即生成完成后是否自动打开资源文件夹
        gc.setFileOverride(false); // 是否覆盖之前生成的
        gc.setServiceName("%sService"); // 去Service的I前缀
        gc.setIdType(IdType.ID_WORKER); // 设置id增长策略，默认是全局唯一IdType.ID_WORKER
        gc.setDateType(DateType.ONLY_DATE); // 设置时间为简单时间
        gc.setSwagger2(true); // 自动配置Swagger文档
        mpg.setGlobalConfig(gc); //将全局配置放到生成器对象

        //2、设置数据源
        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("will");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc); //将数据库配置放到生成器对象

        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("testmpg");
        pc.setParent("com.liao");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user"); // 设置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel); // 设置实体类字段驼峰转换为表中的下划线
        strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 设置表字段下划线转换为实体类字段驼峰
        strategy.setEntityLombokModel(true); // 自动lombok；
        strategy.setLogicDeleteFieldName("deleted"); // 逻辑删除

        // 自动填充配置
        TableFill gmtCreate = new TableFill("create_time", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("update_time",FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);

        // 乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true); //localhost:8080 / hello_id_2
        mpg.setStrategy(strategy);
        mpg.execute(); //执行
    }
}

生成结果

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PdCcq92p-1635922403412)(C:\Users\三代守望\AppData\Roaming\Typora\typora-user-images\image-20211103125735066.png)]

, FieldFill.INSERT);
TableFill gmtModified = new TableFill(“update_time”,FieldFill.INSERT_UPDATE);
ArrayList tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);

    // 乐观锁
    strategy.setVersionFieldName("version");
    strategy.setRestControllerStyle(true);
    strategy.setControllerMappingHyphenStyle(true); //localhost:8080 / hello_id_2
    mpg.setStrategy(strategy);
    mpg.execute(); //执行
}

}

生成结果

[外链图片转存中...(img-PdCcq92p-1635922403412)]