MyBatisPlus【详解】

一、概述

需要的基础：把MyBatis、Spring、SpringMVC学习了。

为什么要学习它呢？ MyBatisPlus 可以节省我们大量工作时间，所有的CRUD 代码它都可以自动化完成。

比如：JPA、tk-mapper、MyBatisPlus

1.简介

MyBatis-Plus(简称 简称 MP)，是一个 MyBatis 的增强工具包，只做增强不做改变。为简化开发工作、提高生产率而生。

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

2.官网地址

官网：https://mp.baomidou.com/
Github官网：https://github.com/baomidou/mybatis-plus
Gitee官网：https://gitee.com/baomidou/mybatis-plus

3.特性

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

二、快速入门

使用第三方组件：

1. 导入对应的依赖
2. 研究依赖如何配置
3. 代码如何编写
4. 提高扩展技术能力

操作步骤

1、创建数据库mybatis_plus

2、创建user表

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

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
##真实开发中，Version（乐观锁），deleted（逻辑删除），gmt_create、gmt_modified

3、编写项目，使用 Springboot 初始化

4、导入pom文件

<!--数据库驱动-->
<dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>5.1.6</version>
 </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>

 <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>
     <exclusions>
         <exclusion>
             <groupId>org.junit.vintage</groupId>
             <artifactId>junit-vintage-engine</artifactId>
         </exclusion>
     </exclusions>
 </dependency>

说明：我们使用 MyBatis-plus 可以节省我们大量的代码，尽量不要同时导入 mybatis 和 mybatis-plus。会有版本差异。

5、 配置文件
在application.properties中配置连接数据库

# mysql 5 驱动不同 com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver，需要增加时区的配置 serverTimezone=GMT%2B8

# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver，需要增加时区的配置 serverTimezone=GMT%2B8

在 Spring Boot 启动类中添加 @MapperScan

// 添加 @MapperScan 注解，扫描 Mapper 文件夹
@MapperScan("com.kuang.mapper")
@SpringBootApplication
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

6、传统方式 pojo - dao（连接mybatis，配置mapper.xml文件）- service -controller
6、使用 mybatis-plus 之后

• pojo

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

• mapper接口

// 在对一个的mapper上面继承基本的类 BaseMapper
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
	// 此时所有的CRUD 操作已经编写完毕了
}

• 测试

@SpringBootTest
class MybatisPlusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        // 查询一个 Wrapper， 条件构造器，这里我们不用null
        // 查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
    
}

三、配置日志

我们所有sql现在是不可见的，我们希望知道他是怎么执行的，所以我们必须要看日志。

根据自己的需求选择对应的日志，这里我们就控制台输出。

# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

四、CRUD扩展

Insert 插入

// 测试插入
@Test
public void testInsert(){
    User user = new User();
    user.setName("tom");
    user.setAge(2);
    user.setEmail("[email protected]");

    int result = userMapper.insert(user);// 帮我们自动生成id
    System.out.println(result);// 受影响的行数
    System.out.println(user);// 会发现 id 自动回填
}

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

主键生成策略

分布式系统唯一id 生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

默认 ID_WORKER 全局唯一id

// 对应数据库中的主键（uuid、自增id、雪花算法，redis、zookeeper）
@TableId(type = IdType.ID_WORKER)

雪花算法：

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

主键自增

我们需要配置主键自增：

1、实体属性字段上@TableId(type = IdType.AUTO)

2、数据库字段一定要为自增。否则会报错。

3、再次测试插入可以看出结果

其他的源码解释：

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

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

更新操作

// 测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        // 通过条件动拼接动态SQL
        user.setId(6L);
        user.setName("lisi");
        user.setAge(15);

        // 注意：updateById 但是参数是一个 对象。
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

所有SQL都是自动帮你动态配置的。

自动填充

创建时间、修改时间。这些操作一遍都是自动完成的，我们不希望手动更新。

阿里巴巴手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上。而且需要自动化。

方式一： 数据库级别（工作中不建议）

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

2、同步实体类

private Date createTime;
private Date updateTime;

3、测试更新操作

方式二：代码级别

1、删除数据库的默认值。

2、在实体类字段属性上添加注解

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

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

@Slf4j
@Component// 一定不要忘记吧处理器加入到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill....");
        // default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        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);
    }
}

4、测试插入，观察时间即可。

5、测试更新，观察时间即可。

乐观锁

在面试中经常会被问道乐观锁、悲观锁。

乐观锁：顾名思意十分乐观，他总是认为不会出现问题，无论干什么都不去上锁。如果出现问题，就在再次更新值测试。
悲观锁：顾名思意十分悲观，他总是认为总是出现问题，无论干什么都会上锁，在去操作。

这里主要说乐观锁机制！

乐观锁实现方式：

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

乐观锁：先查询版本号 version = 1
--A线程
update user set name ="starsea7",version = version +1
where id = 2 and version = 1

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

测试一下MP的乐观锁插件

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

2、给实体类加对应字段

@Version//乐观锁Version注解
private Integer version;

3、注册组件

// 添加 @MapperScan 注解，扫描 Mapper 文件夹
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration//配置类
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4、测试乐观锁

// 测试乐观锁成功
@Test
 public void testOptimisticLocker(){
     // 查询用户信息
     User user = userMapper.selectById(1L);
     //修改用户信息
     user.setName("starsea7");
     user.setEmail("[email protected]");
     // 执行更新操作
     userMapper.updateById(user);
 }

 // 测试乐观锁失败，多线程下
 @Test
 public void testOptimisticLocker2(){
     // 线程1
     User user = userMapper.selectById(1L);
     user.setName("starsea77");
     user.setEmail("[email protected]");

     // 线程2
     User user2 = userMapper.selectById(1L);
     user2.setName("starsea88");
     user2.setEmail("[email protected]");
     userMapper.updateById(user2);

     // 自旋锁来多次尝试提交。
     userMapper.updateById(user);// 如果没有乐观锁就会覆盖插队线程的值
 }

·

查询操作

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

// 测试批量查询
@Test
public void testSelectByBatchId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3, 4));
    users.forEach(System.out::println);
}

// 条件查询之一使用 map
@Test
public void testSelectByBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","tom");
    map.put("age",2);

    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网站使用非常之多！

1、使用原始的 limit 进行分页

2、pageHelper 第三方插件

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

如何使用

1、配置拦截器组件即可

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

2、直接使用page对象即可

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

    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());
}

删除操作

基本删除操作

// 测试删除
@Test
 public void testDeleteById(){
     int i = userMapper.deleteById(6L);
     System.out.println(i);
 }

 // 通过id批量删除
 @Test
 public void testDeleteBatchId(){
     int i = userMapper.deleteBatchIds(Arrays.asList(1294578792320237570L, 1294578792320237571L, 1294578792320237572L));
     System.out.println(i);
 }

 // 通过 map 条件删除
 @Test
 public void testDeleteMap(){
     HashMap<String, Object> map = new HashMap<>();
     map.put("name","zhangsan");

     userMapper.deleteByMap(map);
 }

我们在工作中遇到一些问题：逻辑删除

逻辑删除

物理删除：从数据库中直接删除
逻辑删除：在数据库中没有移除，而是通过一个变量来让他失效，deleted = 0 => deleted = 1

应用场景：管理员可以查询被删除的记录！方式数据的丢失，类似于回收站。

测试一下：

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

2、实体类中增加属性

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

3、配置组件

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

4、逻辑删除的配置

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

5、测试删除操作

记录依旧在数据库，但是值确已变化了。

在次查询这条数据，发现过滤了逻辑删除的数据。

以上就是所有的CRUD 操作及其扩展的操作。 会大大提高你的工作效率和写项目的效率。

五、性能分析插件

我们在平时的开发汇总，会遇到一些慢SQL。

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

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

1、导入插件

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

注意： 要在SprinBoot 中配置环境为 dev 或者 test 环境。

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

2、 测试使用

@Test
void contextLoads() {
    // 查询一个 Wrapper， 条件构造器，这里我们不用null
    // 查询全部用户
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}

使用性能分析插件，可以帮助我们提高效率。

六、条件构造器

十分重要：Wrapper

我们写一些复杂的SQL就可以使用它来替代。

1、测试一

@SpringBootTest
public class WrapperTest {

    @Autowired
    private UserMapper userMapper;

    // 条件查询
    @Test
    void contextLoads() {
        // 查询 name 不为空的用户，并且邮箱不为空的用户，年龄大于等于12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age","12");
        userMapper.selectList(wrapper).forEach(System.out::println);// 和我们学习的 Map 对于以下
    }
}

2、测试二

// 条件查询
@Test
 public void test2() {
     // 查询名字为 Billie
     QueryWrapper<User> wrapper = new QueryWrapper<>();
     wrapper.eq("name","Billie");
     User user = userMapper.selectOne(wrapper);// 查询一个数据，出现多个结果使用List，或者Map
     System.out.println(user);
 }

3、测试三

// 条件查询
@Test
public void test3() {
     // 查询年龄在20 - 30 岁之间的用户
     QueryWrapper<User> wrapper = new QueryWrapper<>();
     wrapper.between("age",20,30);
     Integer count = userMapper.selectCount(wrapper);
     System.out.println(count);
 }

4、测试四

// 模糊查询
@Test
public void test4() {
    // 查询名字中不包含e，邮箱中以t开头的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    // 左和右   %a%
    wrapper
            .notLike("name","e")
            .likeRight("email","t");  // t%
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

5、测试五

// 组合查询
@Test
public void test5() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id","select id from user where id <3");

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

6、测试六

//排序查询
@Test
public void test6() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    // 通过id进行排序
    wrapper.orderByDesc("id");

    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

七、代码生成器

dao、pojo、service、controller都给我们自己编写完成。

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

1、导入MP 坐标

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

2、导入数据库配置

# 服务端口
server.port=9000
# 设置开发环境
spring.profiles.active=dev
# 禁止模板缓存
spring.thymeleaf.cache=false

# mysql 5 驱动不同 com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/starSea99_community?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver，需要增加时区的配置 serverTimezone=GMT%2B8

# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

3、MyBatisPlusConfig配置类

// 添加 @MapperScan 注解，扫描 Mapper 文件夹
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration//配置类
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

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

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

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

4、代码生成器类

//代码生成器
public class KuangCode {

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        // 配置策略

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("StarSea99");  // 设置作者
        gc.setOpen(false);  // 是否打开文件夹
        gc.setFileOverride(false); //是否覆盖
        gc.setServiceName("%sService");    // 去掉Service 的I前缀
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.kuang");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user");// 单个表映射，设置要映射的表名，只需要修改这里
        //strategy.setInclude("blog","blog_tags","course","links","sys_settings","user","user_course","user_record","user_say");
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);// 自动lombok

        // 逻辑删除策略
        strategy.setLogicDeleteFieldName("deleted");
        // 自动填充配置
        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);// localhost:8080/hello_id_2

        mpg.setStrategy(strategy);

        mpg.execute();// 执行
    }
}

部分效果图