mybatis—plus

mybatis-plus

简介

官网：https://mp.baomidou.com/

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

愿景

我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

特性

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

快速入门

我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，我们假设您已经：

• 拥有 Java 开发环境以及相应 IDE
• 熟悉 Spring Boot
• 熟悉 Maven

1、数据库创建

创建数据库：mybatis_plus
创建一张 User 表，其表结构如下：

id	name	age	email
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

其对应的数据库 Schema 脚本如下：

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

其对应的数据库 Data 脚本如下：

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

• 真实开发中，version (乐观锁)、deleted (逻辑删除)、gmt_ create、 gmt modified

2、创建springboot项目

1、导入依赖

引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、mysql 依赖：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

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

2、yml

• mysql 5 驱动不同 高版本能兼容低版本 com.mysql.jdbc.Driver
• mysql 8 驱动不同 高版本能兼容低版本 com.mysql.cj.jdbc.Driver ,需要添加时区配置 serverTimezone=GMT%2B8

# mysql 5 驱动不同 高版本能兼容低版本 com.mysql.jdbc.Driver
spring:
  datasource:
    username: root
    password: 123456
    url:  jdbc:mysql://localhost:3306/mybatis_plus?usrSSL=false$useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver


# mysql 8 驱动不同 高版本能兼容低版本 com.mysql.cj.jdbc.Driver ,需要添加时区配置 serverTimezone=GMT%2B8

3、使用

传统方式：

• entity
• dao（连接mybatis，配置mapper.xml文件）
• service
• controller

使用mybatis_plus：

• entity
• mapper接口
• 使用

编写entity

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

编写mapper

在对应的mapper上面继承 BaseMapper

//  在对应的mapper上面继承 BaseMapper
//@Mapper
@Repository //  代表持久层
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD操作都已经完成
    //不需要像之前一样配置一堆配置文件了
}

主启动加上包扫描:@MapperScan("com.wlq.mapper")

Test

@Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //查询全部
        //参数是一个mapper，条件构造器
        //userMapper.selectList.var可快速生成前面的users
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

效果

配置日志

配置日志为了开发的时候能够看到sql语句是怎么执行的

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

CRUD扩展

1、测试插入

	@Test
    void testInsert (){
        User user = new User();
        user.setName("zhangsan");
        user.setAge(18);
        user.setEmail("666@.qq.com");

        int result = userMapper.insert(user);   //自动生成id
        System.out.println("----------------------");
        System.out.println(result); //受影响的行数
        System.out.println(user);   //id自动回填
    }

2、主键生成策略

ID_WORKER 默认全局唯一id

分布式系统唯一ID生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。

主键自增
我们需要配置主键自增：

• 实体类字段上：@TableId(type = IdType.AUTO)
• 数据库字段id一定要是自增

其余源码解释

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、测试更新

	@Test
    void testUpdate1 (){
        User user = new User();
        user.setId(6L);
        user.setName("lisi");
        user.setAge(18);
        user.setEmail("88888@.qq.com");

        userMapper.updateById(user);
    }
	@Test
    void testUpdate2 (){
        User user = new User();
        user.setId(6L);
        user.setAge(28);

        userMapper.updateById(user);
    }

• 根据条件拼接动态sql
  

4、自动填充

• 创建时间、修改时间!这些个操作- -遍都是自动化完成的,我们不希望手动更新!
• 阿里巴巴开发手册:所有的数据库表: gmt_ create、gmt_ modified几乎所有的表都要配置上!而且需要自动化!

1、数据库级别（工作一般不能修改数据库）

• 在表中新增字段 create_time , update_time
  
• 再次测试插入，先把实体类同步

private Date createTime;
private Date updateTime;

2、代码级别

• 在表中新增字段 create_time , update_time，更新和默认不能修改.
  
• 实体类上添加注解

	//字段填充内容
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

@TableField 说明

值	描述
value	字段值（驼峰命名方式，该值可无）
update	预处理 set 字段自定义注入
condition	预处理 WHERE 实体条件自定义运算规则
el	详看注释说明
exist	是否为数据库表字段（ 默认 true 存在，false 不存在 ）
strategy	字段验证 （ 默认 非 null 判断，查看 com.baomidou.mybatisplus.enums.FieldStrategy ）
fill	字段填充标记 （ FieldFill, 配合自动填充使用 ）

public enum FieldFill {
    /**
     * 默认不处理
     */
    DEFAULT,
    /**
     * 插入填充字段
     */
    INSERT,
    /**
     * 更新填充字段
     */
    UPDATE,
    /**
     * 插入和更新填充字段
     */
    INSERT_UPDATE
}

• 编写处理器处理这个注解，implements MetaObjectHandler

@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.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

• 测试插入和修改
  
  

5、乐观锁&悲观锁

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

乐观锁

OptimisticLockerInnerInterceptor

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

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

乐观锁: 1、先查询，获得版本号version = 1
-- A	线程
update user set name = "666"， version = version + 1
where id = 2 and version = 1

-- B	线程，线程抢先完成，这个时候version = 2，会导致A修改失败!
update user set name = "666"， version = version + 1
where id = 2 and version = 1

测试

• 数据库添加version字段
  
• 同步实体类：@Version

	@Version    //乐观锁
    private Integer version;

• 注册组件

@Configuration
@MapperScan("com.wlq.mapper")
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

• 测试

成功情况下：

//测试乐观锁成功
    @Test
    void testOptimisticLocker (){
        User user = userMapper.selectById(1L);
        user.setName("火花");
        user.setAge(28);

        userMapper.updateById(user);
    }

失败情况下，多线程下：

//测试乐观锁失败，多线程下
    @Test
    void testOptimisticLocker2 (){
        User user = userMapper.selectById(1L);
        user.setName("火花111");
        user.setAge(28);

        //模拟有线程插队
        User user2 = userMapper.selectById(1L);
        user2.setName("火花2222");
        user2.setAge(28);
        userMapper.updateById(user2);

        //如果没有乐观锁，这个更新操作会覆盖user2插队线程的数据
        userMapper.updateById(user);
    }

由于user2先更新，所有到了更新user时，发现值已经被人改过了，所有就不会更新

6、查询

	//查询多个
	@Test
    void testSelect (){
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }
    
    //条件查询
    @Test
    void testSelect2 (){
        HashMap<String, Object> map = new HashMap<>();
        //自定义查询
        map.put("name","lisi");

        userMapper.selectByMap(map);
    }

7、分页查询

分页在网站使用的十分之多!

1. 原始的limit进行分页
2. pageHelper 第三方插件
3. MP其实也内置了分页插件!

如何使用

1、config类，配置拦截器组件

// 旧版，分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

• 测试，直接使用Page

//分页查询
    @Test
    void testPage (){
        //参数一：当前页   参数二：页面大小
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page,null);

        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());    //总页数
    }

8、逻辑删除

• 物理删除：从数据库中直接移除
• 逻辑删除：再数据库中没有被移除,而是通过一个变量来让他是否显示

管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!

测试一下：

1、在数据表添加字段：deleted

2、实体类同步

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

3、配置组件

//3.0版本的
    @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }

mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

4、测试删除

//删除
    @Test
    void testDelete (){
        userMapper.deleteById(11L);
    }

5、再查询这个数据看看

• 发现sql语句会自动拼接过滤被逻辑删除的数据

性能分析插件

我们在平时的开发中,会遇到一些慢sql。 测试! drui…

MP也提供性能分析插件,如果超过这个时间就停止运行!

作用：性能分析拦截器，用于输出每条SQL语句及执行时间

1、导入插件

/**
     * SQL执行效率插件
     */
    @Bean
    @Profile({"dev","test"})    //设置dev test环境开启，保证我们的效率
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);   //ms，设置SQL最大执行时间，如果超过则不执行
        performanceInterceptor.setFormat(true); //SQL格式化
        return performanceInterceptor;
    }

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

2、测试使用

@Test
    void contextLoads() {
        //查询全部
        //参数是一个mapper，条件构造器
        //userMapper.selectList.var可快速生成前面的users
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

条件构造器

我们写一些复杂的sq|就可以使用它来替代！

1、测试一

@Test
    void contextLoads() {
        //查询name不为空，Email不为空，age大于20
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);
        userMapper.selectList(wrapper).forEach(System.out::println);
    }

2、测试二

@Test
    void test1() {
        //查询一个
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.eq("name","lisi");
        User user = userMapper.selectOne(wrapper);
        System.out.println(user);
    }

3、测试三

@Test
    void test2() {
        //查询区间
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.between("age",20,30);
        Integer count = userMapper.selectCount(wrapper);
        System.out.println(count);
    }

4、模糊查询

@Test
    void test3() {
        //模糊查询
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //%z%(String), t%(String)
        wrapper
                .notLike("name","z")
                .likeRight("email","t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

• sql

Preparing: SELECT id,name,age,email,version,deleted,create_time,update_time FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ?

5、IN查询

@Test
    void test5() {
        //IN查询
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //id 在子查询中查出来
        wrapper.inSql("id","select id from user where id<3");
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

代码自动生成器

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

• 代码如下

package cn.itcast.mp;

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;
import java.util.HashMap;
import java.util.Map;

//代码自动生成器
public class CodeGenerator {

    public static void main(String[] args) {
        //构建一个 代码自动生成器 对象
        AutoGenerator autoGenerator = new AutoGenerator();

        //1、全局配置
        GlobalConfig gc = new GlobalConfig();
        String oPath = System.getProperty("user.dir");//得到当前项目的路径
        gc.setOutputDir(oPath + "/src/main/java");   //生成文件输出根目录
        gc.setOpen(false);//生成完成后不弹出文件框
        gc.setFileOverride(true);  //文件覆盖
        gc.setAuthor("ryan");// 作者
        gc.setServiceName("%sService");    //去除Service的I前綴
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        autoGenerator.setGlobalConfig(gc);

        ///2、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);   //设置数据库类型
        dsc.setUrl("jdbc:mysql://localhost:3306/mp_crud?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");  //指定数据库
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        autoGenerator.setDataSource(dsc);



        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("mp");
        pc.setParent("cn.itcast");
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        autoGenerator.setPackageInfo(pc);

        // 4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("tb_department","tb_employee"); // 设置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true); // 自动lombok；
        strategy.setLogicDeleteFieldName("deleted");
        strategy.setTablePrefix("tb_"); //去掉表的前缀
        // 自动填充配置
        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);
        strategy.setControllerMappingHyphenStyle(true);
        autoGenerator.setStrategy(strategy);

        //不加这个会报空指针异常
        InjectionConfig injectionConfig = new InjectionConfig() {
            //自定义属性注入:abc
            //在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
            @Override
            public void initMap() {
                Map<String, Object> map = new HashMap<>();
                map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                this.setMap(map);
            }
        };
        //自定义配置
        autoGenerator.setCfg(injectionConfig);

        // 执行生成
        autoGenerator.execute();
    }
}

• 相关依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.itcast.mp</groupId>
    <artifactId>itcast-mp-springboot</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.5.RELEASE</version>
    </parent>

    <properties>
        <spring.version>5.0.2.RELEASE</spring.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- 代码简化工具 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
            <scope>provided</scope>
            <optional>true</optional>
        </dependency>
        <!-- mybatis-plus的springboot支持 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>
        <!-- MySQL驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--自动生成代码插件-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.1.2</version>
        </dependency>
        <!--添加模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>

    </dependencies>

</project>

MybatisX 快速开发插件