MyBatis-plus

本篇基于MP 3.3.0 版本 ，spring boot 方式。

MyBatis-plus 简介：

　　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 操作智能分析阻断，也可自定义拦截规则，预防误操作

　　支持数据库

• mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver

• 达梦数据库 、 虚谷数据库 、 人大金仓数据库

　　快速开始

1. 建立数据库，导入数据
2. 导入对应的依赖
3. 编写项目
   1. 配置数据库连接
   2. 编写实体类
   3. 编写Mapper接口继承BaseMapper<T> 即可！至此所有CRUD都已完成
4. 测试使用

　　详细看官网：https://mybatis.plus

插入策略

• 用户ID自动回填
• 主键生成策略
  • 自增
  • 手动输入
  • UUID
  • 雪花算法
  • 唯一ID生成器
  • 唯一ID生成器（字符串类型）

• 关于id生成的一些策略请参看：https://www.cnblogs.com/haoxinyue/p/5208136.html

public enum IdType {
   // 自增 
   AUTO(0),
   NONE(1),
   // 手动输入 
   INPUT(2), 
   // 唯一id生成器，默认策略
   ID_WORKER(3),
   // uuid
   UUID(4), 
   // 唯一id生成器（字符串类型）
   ID_WORKER_STR(5); }

更新策略

　　阿里巴巴规范中，id、gmt_create、gmr_update !

 给数据库表增加两个字段测试

1. 自动更新策略两种级别
   1. 数据库级别（不建议）
      1. 设置默认值
      2. 插入、更新测试
   2. 代码级别（建议）
      1. 删除更新默认值
      2. 编写实体类对应注解
      3. 编写注解的处理器

　　数据库级别

　　代码级别

    @TableField(fill = FieldFill.INSERT)
    private Date insertTime; // 创建时间
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime; // 更新时间

package com.coding.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    /*
    * default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) {
        if (Objects.nonNull(fieldVal) && metaObject.hasSetter(fieldName)) {
            metaObject.setValue(fieldName, fieldVal);
        }
        return this;
    }*/
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("insertTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

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

乐观锁

• 乐观锁：非常乐观，无论什么操作都不加锁！（思考：分布式环境下怎么解决冲突问题？）
• 悲观锁：非常悲观，无论什么操作都加锁！默认情况下都是悲观锁！

解决问题

　　通常方式就是增加一个乐观锁字段（version）

　　当要更新一条记录的时候，希望这条记录没有被别人更新

乐观锁实现方式：

1. 取出记录时，获取当前version （查询）old version = 1
2. 更新时，带上这个version （更新）
3. 执行更新时，set version = newVersion where version = old version
   1. 如果version不对应，就更新失败
   2. 对应，就更新成功

MP对乐观锁也进行了支持

1. 添加version注解到字段上面
2. 添加乐观锁插件即可
3. 测试就自动带上了版本号

　　详细见：https://mp.baomidou.com/guide/optimistic-locker-plugin.html#%E4%B8%BB%E8%A6%81%E9%80%82%E7%94%A8%E5%9C%BA%E6%99%AF

查询策略

　　注：分页查询需要添加以下插件：

//Spring boot方式
@EnableTransactionManagement
@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;
    }
}

    // 查询单个
    @Test
    void testSelectById(){
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    // 查询多个
    @Test
    void testSelectBatchIds(){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1L, 2L, 3L));
        users.forEach(System.out::println);
    }

    // 查询数量
    @Test
    void testSelectCount(){
        Integer count = userMapper.selectCount(null);
        System.out.println(count);
    }

    // 简单条件查询
    @Test
    void testSelectByMap(){
        Map<String, Object> map = new HashMap<>();
        map.put("name","zhangsan");
        map.put("age",18);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

    // 分页查询
    @Test
    void testSelectPage(){
        Page<User> page = new Page<>();
        Page<User> userPage = userMapper.selectPage(page, null);
        List<User> users = userPage.getRecords();
        users.forEach(System.out::println);
        System.out.println(userPage.getSize());
        System.out.println(userPage.getTotal());
        System.out.println(userPage.getPages());
    }

删除策略

    // 删除一个
    @Test
    void testDeleteById(){
        userMapper.deleteById(1L);
    }

    // 删除多个
    @Test
    void testDeleteBatchIds(){
        userMapper.deleteBatchIds(Arrays.asList(2L,6L));
    }

    // 根据条件删除
    @Test
    void testDeleteByMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","Tom");
        userMapper.deleteByMap(map);
    }

拓展

• 逻辑删除：并不是真的从数据库中删掉了，只是增加了一个判断而已
  • 业务场景：管理员在后台可以看到被删除的记录，使用逻辑删除可以保证项目的安全和健壮性
• 物理删除：直接从数据库中删除

逻辑删除使用测试

1. 添加逻辑删除字段
2. 在实体类添加注解
3. 在配置文件进行配置
4. 注册Bean

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

# application.yml 加入配置(如果你的默认值和mp默认的一样,该配置可无)
mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局逻辑删除字段值 3.3.0开始支持，详情看下面。
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

// 注册 Bean(3.1.1开始不再需要这一步)

import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfiguration {

    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }
}

    // 逻辑删除，删除一个
    @Test
    void testLogicDeleteById(){
        userMapper.deleteById(1L);
    }

性能分析

　　在开发的时候排除慢sql！ 

　　3.2.0版本以上参考：https://mp.baomidou.com/guide/p6spy.html

1. 导入p6spy的maven依赖
2. 在dev环境下配置文件进行配置
3. spy.properties配置

　　3.2.0版本以下参考：https://mp.baomidou.com/guide/performance-analysis-plugin.html

条件构造器

　　我们平时写的sql，一般使用的最多的是一些条件，这些东西MP也帮助我们提供了

　　更多条件查询见官网：https://mp.baomidou.com/guide/wrapper.html#abstractwrapper

package com.coding;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.coding.mapper.UserMapper;
import com.coding.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class WrapperTest {
    @Autowired
    private UserMapper userMapper;
　　// 仅举一例，更多条件查询见官网
    @Test
    void testConditionSelect(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","zhangsan") // 姓名 = zhangsan
                .gt("age",18); // 年龄 > 18
        userMapper.selectList(wrapper);
    }
}

MP 一键生成 ——非常便捷

　　导入依赖

        <!-- MP -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
        </dependency>    

package com.coding.utils;

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.*;
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;
import java.util.List;

// 遇事不决就重启，遇事不决就重启，遇事不决就重启 
// 自动生成代码
public class CodeGenerator {

    public static void main(String[] args) {

        String moduleName = "edu";

        // 1.代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 规则的配置
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        // 获取当前项目路径
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/coding-edu-edu/src/main/java");
        // 全局自动添加作者
        gc.setAuthor("coding");
        // 配置是否开启文件夹弹出
        gc.setOpen(false);
        // 配置是否覆盖之前生成的文件夹
        gc.setFileOverride(false);
        // 配置去掉service接口命名的“I” ，例：IUserService 变成UserService
        gc.setServiceName("%sService");
        // 配置主键策略
        gc.setIdType(IdType.ID_WORKER_STR);
        // 配置日期相关的 ,日期类型
        gc.setDateType(DateType.ONLY_DATE);
        // 开启swagger注解自动生成
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUrl("jdbc:mysql://localhost:3306/coding_" + moduleName + "?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);


        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(moduleName);
        pc.setParent("com.coding");// 父路径
        pc.setEntity("entity");
        pc.setController("controller");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 要生成哪一个表对应的类
        strategy.setInclude(moduleName + "_\w*"); // 重要！！！
        strategy.setTablePrefix(pc.getModuleName() + "_"); // edu_ 这个前缀不生成在类名中 例：edu_name --> Name
        // 数据库表生成到实体类 下划线转驼峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 自动生成lombok注解
        strategy.setEntityLombokModel(true);
        // 配置逻辑删除字段
        strategy.setLogicDeleteFieldName("is_deleted");
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        // 自动填充
        TableFill gmt_create = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmt_modified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        List<TableFill> list = new ArrayList<>();
        list.add(gmt_create);
        list.add(gmt_modified);
        strategy.setTableFillList(list);
        // 乐观锁
        strategy.setVersionFieldName("version");
        // restful api
        strategy.setRestControllerStyle(true);
        //
        strategy.setControllerMappingHyphenStyle(true); // 请求示例：/user/hello_name 而不是/user/helloName

        mpg.setStrategy(strategy);
        // 2.执行生成器
        mpg.execute();
    }

}

运行后的文件结构截图

　　部分源码截图

　　entity

　　mapper

　　mapper.xml

 　　service 接口

　　service 实现类

　　controller