Mybatis-Plus

1、概述

简介

是什么？ Mybatis本来就是简化 JDBC操作的！

官网：https://mp.baomidou.com/ 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

2、快速入门

地址：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、创建数据库 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, '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_cteate、gmt_modified

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

4、 导入依赖

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

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

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

        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>

说明：

• 使用mybatis-plus可以节省大量的代码，尽量不要同时导入 mybatis 和 mybatis-plus ！！！ 版本差异！

5、连接数据库！这一步和 mybatis 相同

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

6、pojo -> dao（连接mybatis，配置mapper.xml）-> service -> controller

6、 使用mybatis-plus 之后

• pojo

package com.kingtl.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;

}

• mapper接口

package com.kingtl.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.kingtl.pojo.User;
import org.springframework.stereotype.Repository;

//在对应的Mapper上面继承基本的接口 BaseMapper
@Repository
public interface UseMapper extends BaseMapper<User> {

}

注意点：需要在主启动类上去扫描mapper包下的所有接口@MapperScan("com.kingtl.mapper")

• 测试类中测试

package com.kingtl;

import com.kingtl.mapper.UseMapper;
import com.kingtl.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 MybatisPlusApplicationTests {

    @Autowired
    private UseMapper useMapper;

    @Test
    void contextLoads() {
        //参数是 一个 wrapper， 条件构造器，这里先不用  ，填入null
        //查询全部用户
        List<User> users = useMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

3、配置日志

所有的SQL 现在是不可见的，我们希望知道它是怎么执行的，所以需要我们

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

4、CRUD扩展

插入操作

Insert 插入

//测试插入
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("KingTL");
        user.setAge(13);
        user.setEmail("123@163.com");

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

数据库插入的id的默认值为：全局的唯一 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。具体实现的代码可以参看https://github.com/twitter/snowflake。

主键自增

需要配置主键自增时：

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

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

3、 再次测试插入数据

其余的源码解释

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

更新操作

//测试更新
@Test
public void testUpdate(){
    User user = new User();
    user.setName("关注公众号：T1学长");
    user.setId(5L);

    //注意：updateById 但是参数是一个 对象！
    int i = useMapper.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、 编写处理器来处理这个注解即可！

package com.kingtl.handler;

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;

@Slf4j
@Component   //一定不要忘记把处理器加到IOC容器中！
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);
    }
}

4、测试插入

5、测试更新、观察时间

乐观锁

在面试过程中，我们进场会被问到乐观锁，悲观锁！

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

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

乐观锁实现方式：

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

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

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

测试一下 MP的乐观锁插件

1、给数据库增加 version字段

2、实体类加对应的字段

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

3、注册组件

package com.kingtl.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;

//扫描 mapper 文件夹
@MapperScan("com.kingtl.mapper")
@EnableTransactionManagement
@Configuration  //配置类
public class MyBatisPlusConfig {

    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

}

4、测试一下！

 //测试乐观锁成功！
    @Test
    public void testOptimisticLocker(){
        //1、查询用户信息
        User user = useMapper.selectById(1L);
        //2、修改用户信息
        user.setName("kingtl");
        user.setEmail("956847690@qq.com");
        //3、执行更新操作
        useMapper.updateById(user);
    }


    //测试乐观锁失败！
    @Test
    public void testOptimisticLocker2(){

        //线程1
        User user = useMapper.selectById(1L);
        user.setName("kingtl111111");
        user.setEmail("956847690@qq.com");

        //模拟另外一个线程执行了插队操作
        User user2 = useMapper.selectById(1L);
        user2.setName("kingtl222222");
        user2.setEmail("956847690@qq.com");
        useMapper.updateById(user2);

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

查询操作

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


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

    //按条件查询之一 使用map操作
    @Test
    public void testSelectByBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        //自定义查询
        map.put("name","KingTL");
        map.put("age",32);

        List<User> users = useMapper.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(){
    //参数1：当前页
    //参数2：页面的大小
    Page<User> page = new Page<>(2,5);
    useMapper.selectPage(page,null);

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

删除操作

基本的删除操作

 //测试删除
    @Test
    public void testDeleteById(){
        useMapper.deleteById(1288045175302033412L);
    }

    //通过id 批量删除
    @Test
    public void testDeleteBatchIds(){
        useMapper.deleteBatchIds(Arrays.asList(1288045175302033410L,1288045175302033411L));
    }


    //通过map批量删除
    @Test
    public void testDeleteMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","关注公众号：T1学长");
        useMapper.deleteByMap(map);
    }

工作中会遇到一些问题：逻辑删除！

逻辑删除

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

逻辑删除：在数据库中没有被移除，而是通过一个变量来让它失效！ 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
mybatis-plus.global-config.db-config.logic-not-delete-value=0

4、测试一下，删除,实际走的是 更新操作

记录依旧在数据库，但是值，却变化了

以上的所有CRUD操作及其扩展操作，都必须精通掌握！

性能分析插件

我们在平时的开发中，会遇到一些慢SQL。测试！ druid......

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

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

1、导入插件

 //SQL执行效率插件
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();

    //在工作中，不允许用户等待
    performanceInterceptor.setMaxTime(100); //设置SQL 执行的最大时间，如果超过了则不执行
    performanceInterceptor.setFormat(true);  //是否格式化
    return performanceInterceptor;
}

注意：要在SpringBoot中配置环境为 dev 还是 test 环境！

2、测试使用！

@Test
    void contextLoads() {
        //参数是 一个 wrapper， 条件构造器，这里先不用  ，填入null
        //查询全部用户
        List<User> users = useMapper.selectList(null);
        users.forEach(System.out::println);
    }

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

条件构造器 Wrapper

十分重要：Wrapper

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

1、 测试一

@Test
void contextLoads() {
    //查询不为空的用户，并且邮箱不为空的，年龄大于等于十二岁的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper
        .isNotNull("name")
        .isNotNull("email")
        .ge("age",12);
    useMapper.selectList(wrapper).forEach(System.out::println);
}

2、测试二

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

3、测试三

@Test
void test3(){
    //查询年龄在 20~30 岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30); //区间

    Integer integer = useMapper.selectCount(wrapper);//查询结果数
    System.out.println(integer);
}

4、测试四，记住查看输出的SQL 进行分析

//模糊查询
@Test
void test4(){
    //查询名字中不包含k的，并且邮箱以 t开头的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右 %k%
    wrapper
        .notLike("name","k")
        .likeRight("email","t");

    List<Map<String, Object>> maps = useMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

5、测试五（ ）

@Test
void test5(){

    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //id 在子查询中查出来
    wrapper.inSql("id","select id from user where id <3");

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

6、测试六

@Test
void test6(){

    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //通过 id 进行排序
    wrapper.orderByDesc("id");

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

代码自动生成器

dao、pojo、service、controller 都让程序编写完成

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

package com.kingtl;

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;

public class KingCode {
    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("KingTL");
        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);

        //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("admin888");
        dsc.setDbType(DbType.MYSQL);

        mpg.setDataSource(dsc);

        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.kingtl");
        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.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        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);
        strategy.setControllerMappingHyphenStyle(true);  //localhost:8080/hello_id_2

        mpg.setStrategy(strategy);



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