Mybatis-Plus插件的使用

1、快速入门

mybatis-plus官网

1.1、初始化SpringBoot项目

1.1.1、导入相关依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.18</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.28</version>
</dependency>

1.1.2、配置application.yml文件

# 数据库连接配置
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus_for_kuangshen?useSSl=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: lubricate
    password: mysql123

1.2.3、编写代码

mybatis-plus使用步骤： 引入依赖；创建pojo； 创建mapper接口（需要让其继承BaseMapper，增加mapper注解或Repository：表示其是持久层）；测试即可。

2、配置日志

由于sql是不可见的，我们希望知道它是如何执行的，所有需要配置日志。

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #使用默认的控制台输出

3、CRUD扩展

3.1、插入操作

insert

@Test
void insertTest(){
    User user = new User();
    user.setName("lubricate");
    user.setAge(18);
    user.setEmail("test@qq.com");
    int insert = userMapper.insert(user);//会自动生成ID
    System.out.println(insert);//返回受影响的行数
    System.out.println(user);
}

数据库插入的id的默认值为：全局的唯一id

3.1.1、主键生成策略

默认ID_WORKER：全局唯一id

分布式系统唯一id生成

雪花算法：snowflake算法

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID

其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫内的流水号，最后还有一个符号位，永远是0。

AUTO：主键自增

需要配置主键自增：

1、实体类字段上加上注解**@TableId(type = IdType.AUTO)**

2、数据库字段一定是自增

其余的源码解释

public enum IdType {
    AUTO(0),//数据库id自增
    NONE(1),//未设置主键
    INPUT(2),//手动输入
    ID_WORKER(3),//默认的全局唯一id ——>数字
    UUID(4),//全局唯一id  uuid
    ID_WORKER_STR(5);// ID_WORKER 字符串表示方法 ——>字符串
}

3.2、更新操作

3.2.1、自动填充

创建时间、修改时间！这些操作一般都是自动化完成的，不需要手动更新！

阿里巴巴开发手册：所有的数据表：gmt_create（自己使用create_time）、gmt_modified（update_time）几乎所有的表都要配置上！并且需要自动化！（gmt：全球）

方式一：数据库级别

1、在表中新增字段create_time、update_time

2、再次测试插入方法，我们需要先把实体同步！

private Date createTime;
private Date updateTime;

3、再次查看查看结果

方式二：代码级别

1、删除数据库中create_time、update_time的默认值和更新操作！

2、在实体类字段属性上需要增加注解

// 表示在插入操作时自动进行字段填充
@TableField(fill = FieldFill.INSERT)
private Date createTime;
// 进行首次插入或者更新时自动进行填充
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3、编写处理器来处理这个注解即可 ！

package com.lubricate.mybatis.plus.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;
/**
 * @Author: lubricate
 * @description: 我的源数据处理
 * @date:Created in 22:32 2022/8/4
 */
@Slf4j
@Component  //一定不要忘记把处理器放到IOC容器中！
public class MyMetaObjectHandle implements MetaObjectHandler {
    /**
     * 插入时的填充策略
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("开始插入填充！");
        //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        //参数一：想要插入的字段名  参数二：想要插入的字段值  参数三：给那个数据处理
        // 给createTime字段自动插入时间 在执行插入操作时，将创建时间自动填充进去
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("开始更新填充！");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

4、测试观察时间变化，即可！

3.3、乐观锁（version）

面试容易问道！包括悲观锁

乐观锁：十分的乐观，它总认为不会出现问题，无论干什么都不去上锁！如果出现问题，再次更新值测试

悲观锁：十分的悲观，它总是认为会出现问题，无论干什么都会上锁！再去操作

使用version字段：每次更新携带一个版本号，判断版本号是否更新，来确定数据是否更新

3.3.1、乐观锁实现方式

• 取出记录时，获取当前version

• 更新时，带上这个version

• 执行更新时， set version = newVersion where version = oldVersion

• 如果version不对，就更新失败

  列子

  乐观锁：1、先查询，或得版本号 version = 1
  -- A线程
  update user set name="lubricate",version = version+1
  where id = 2 and version = 1
  
  -- B线程  B线程抢先完成，这时version=2，会导致A线程修改失败！
  update user set name="lubricate",version = version+1
  where id = 2 and version = 1
  

  测试MP（mybatis-plus）的乐观锁插件

1、给数据库中增加version字段

2、给实体类加上对应的字段

@Version //表示这是一个乐观锁
private Integer version;

3、还需要注册组件

package com.lubricate.mybatis.plus.config;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
 * @Author: lubricate
 * @description:
 * @date:Created in 23:15 2022/8/4
 */
//主启动类中就不需要配置，扫描mapper包，是交给mybatis的，所以写到关于mybatis配置文件中
@MapperScan("com.lubricate.mybatis.plus.mapper")
@EnableTransactionManagement // 开启事物
@Configuration  //配置类
public class MybatisPlusConfig {
    // 注册乐观锁插件
    /**
     * 旧版
     * Interceptor：拦截器，进行所有的操作会进行拦截，进行自动化的处理
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4、测试一下

// 测试乐观锁成功
@Test
void OptimisticLockerTest(){
    //1、查询用户信息
    User user = userMapper.selectById(1L);
    //2、修改用户信息
    user.setName("李爷爷");
    user.setEmail("123@qq.com");
    //3、执行更新操作
    userMapper.updateById(user);
}
// 测试乐观锁失败
@Test
void OptimisticLockerTest2(){
    //模拟两个线程
    //线程A
    User user = userMapper.selectById(1L);
    user.setName("李爷爷111");
    user.setEmail("123@qq.com");

    //线程B  执行插队操作
    User user2 = userMapper.selectById(1L);
    user2.setName("李爷爷222");
    user2.setEmail("123@qq.com");
    userMapper.updateById(user2);

    userMapper.updateById(user);//如果没有乐观锁就会覆盖插队线程的值
}

3.4、查询操作

// 查询多个id的用户信息
@Test
void selectBatchIdsTest(){
    //selectBatchIds：批量查询
    List<User> userList = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    userList.forEach(System.out::println);
}
// 按条件查询 可以使用map
@Test
void selectByMapTest(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","李菜菜");
    List<User> userList = userMapper.selectByMap(map);
    userList.forEach(System.out::println);
}

3.5、分页查询

1、原始的limit进行分页

2、pagehelper第三方插件

3、MP其实也内置了分页插件

3.5.1、如何使用

1、配置拦截器组件即可！

//分页插件
// 旧版
@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 new PaginationInterceptor();
}

2、直接使用page对象即可！

//分页查询
@Test
void Test(){
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);
    //getRecords：获得所有记录
    page.getRecords().forEach(System.out::println);
}

3.6、逻辑删除

物理删除：从数据库中直接移除

逻辑删除：数据库中的数据没有移除，而是通过一个变量让它失效！例如deleted=0表示有效deleted=1表示无效

测试一下：

1、在数据库中增加一个deleted字段

2、在实体类中添加对应的字段

@TableLogic //逻辑删除注解
private Integer deleted;

3、配置

// 逻辑删除组件
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

mybatis-plus:
  # 配置逻辑删除
  global-config:
    db-config:
      logic-delete-value: 1 # 删除赋值为0
      logic-not-delete-value: 0 #没有删除赋值为1

4、测试

//通过id删除数据
@Test
void deleteByIdTest(){
    userMapper.deleteById(1L);
}

3.7、性能分析插件

开发中，会遇到一些慢sql。如何找出来，通过测试、Druid…

MP提供了性能分析插件，如果超过这个时间就停止运行！

如何使用

1、导入插件

//性能分析插件
//sql执行效率插件
@Bean
@Profile({"dev","test"})//设置dev test环境开启  保证效率
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//设置sql执行的最大时间，如果超过了则不执行
    performanceInterceptor.setFormat(true);//开启sql美化功能
    return performanceInterceptor;
}

需要在SpringBoot配置文件中配置环境为dev或者test！

2、测试使用！

//分页查询
@Test
void selectPageTest(){
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);
    //getRecords：获得所有记录
    page.getRecords().forEach(System.out::println);
}

3.8、条件构造器

拼接sql

//模糊查询  拼接sql  连表查询
@Test
void selectObjsTest(){

    QueryWrapper<User> userQueryWrapper = new QueryWrapper<>();

    //id 在子查询中查出
    userQueryWrapper.inSql("id","select id from user where id < 3");

    List<Object> objects = userMapper.selectObjs(userQueryWrapper);
    objects.forEach(System.out::println);
}

4、代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

配置

package com.lubricate.mybatis.plus;

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.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: lubricate
 * @description:
 * @date:Created in 14:30 2022/8/6
 */
// 代码自动生成器
public class codeGenerateTest {
    public static void main(String[] args) {

        // 首先 需要构造一个 代码自动生成器 对象
        AutoGenerator generator = new AutoGenerator();

        // 配置策略 如何执行

        //1、全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");// 获取系统当前目录  获取用户目录  这里表示当前项目路径
        globalConfig.setOutputDir(projectPath+"/src/main/java");// 代码生成存放在那个目录下面
        globalConfig.setAuthor("Lubricate");// 设置作者信息
        globalConfig.setOpen(false);// 是否打开资源管理器  是否生成完毕之后打开Windows文件夹
        globalConfig.setFileOverride(false);// 是否覆盖原来生成的
        // 去service的I前缀
        globalConfig.setServiceName("%sService");// 设置服务的名字  通常接口的名字是 IXXXservice  使用该该属性可以去掉I，使其编程XXXservice
        globalConfig.setIdType(IdType.ID_WORKER);// 设置主键生成策略，采用默认
        globalConfig.setDateType(DateType.ONLY_DATE);// 设置时间类型  ONLY_DATE：仅仅是时间类型
        globalConfig.setSwagger2(true);// 自动配置swagger文档

        // 需要将全局配置放到自动生成器里面
        generator.setGlobalConfig(globalConfig);


        //2、设置数据源
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis_plus_for_kuangshen?useSSl=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername("lubricate");
        dataSourceConfig.setPassword("mysql123");
        dataSourceConfig.setDbType(DbType.MYSQL);// 设置数据库的类型
        generator.setDataSource(dataSourceConfig);


        //3、包的配置  规定生成那些包，放在那个位置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setModuleName("blog");// 设置模块名字
        packageConfig.setParent("com.lubricate");// 类放在那个包下面  会生成=com.lubricate.blog
        packageConfig.setEntity("pojo");// 取包名
        packageConfig.setMapper("mapper");
        packageConfig.setController("controller");
        packageConfig.setService("service");

        generator.setPackageInfo(packageConfig);


        //4、策略配置   自动配置时间、乐观锁策略
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user");// 设置要映射表名  要生成代码的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);// 设置包命名规则  underline_to_camel：下划线转驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);// 数据库字段
        strategy.setEntityLombokModel(true);// 自动生成lombok注解
        strategy.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);
        strategy.setTableFillList(tableFills);

        // 设置乐观锁
        strategy.setVersionFieldName("version");

        // 设置驼峰命名
        strategy.setRestControllerStyle(true);//开启resultfull的驼峰命名格式，controller可以使用rest的使用风格
        strategy.setControllerMappingHyphenStyle(true);// 多个参数使用下划线形式  localhost:8080/hello_id_2

        generator.setStrategy(strategy);


        // 最后 执行
        generator.execute();
    }
}

还需要导入依赖

原因：MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：

<!--代码生成器依赖-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

<!--模板引擎-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

效果