MyBatis-Plus学习笔记

一、概述

1.简介

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

2.特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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.创建表

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)
);
-- 真实开发中，version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified

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

2.编写项目

这里使用SpringBoot创建

3.导入依赖

 		<!--数据库驱动-->
        <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.20</version>
        </dependency>
        <!--mybatis-plus 是自己开发的 并非官方的！-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

说明：尽量不要同时导入mybatis和mvbatis-plus！版本的差异，因为mybatis-plus内部集成了mybatis

4.连接数据库

这一步和mybatis相同！

# mysql5和mysql8驱动同，mysql8需要增加时区的配置   URL要加serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/user?useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

5.使用mybatis-plus之后

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

package com.kang.pojo;

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

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

mapper接口

package com.kang.mapper;

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

//在对应的Mapper上面继承基本的接口 BaseMapper
@Repository//代表持久层
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD操作都已经编写完成了，你不需要像以前配置一大堆文件了
}

注意：我们需要在主启动类去扫描我们的mapper包下的所有接口

package com.kang;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

//扫描我们的mapper文件夹
@MapperScan("com.kang.mapper")
@SpringBootApplication
public class MyBatisPlusApplication {

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

}

使用测试类

package com.kang;

import com.kang.mapper.UserMapper;
import com.kang.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 {

    //继承了BaseMapper，所有的方法都来自 父类，也可以编写自己的扩展方法！
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        //查询全部用户  参数是一个wrapper ，条件构造器，这里我们先不用 写null就行了
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

6.配置日志

我们所有的sql现在是不可见的，不知道它是怎么执行的，所以必须要看日志！在application.properties文件中

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

三、CRUD扩展

Insert 插入

 	@Test
    public void testInsert(){
        User user=new User();
        user.setAge(3);
        user.setName("rqk");
        user.setEmail("2444292287@qq.com");
        int insert = userMapper.insert(user);//帮我们自动生成id
        System.out.println(insert);//受影响的行数
        System.out.println(user);//发现，id会自动回填
    }

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

主键生成策略

默认 ID_WORKER 全局唯一id

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

主键自增
我们需要配置主键自增：
1、实体类字段上@TableId(type=IdType.AUTO)
2、数据库字段一定要是自增的
@TableId注解中的type类型源码

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

如果设置手动，就必须自己配置id了

Update更新

 	@Test
    public void testUpdate(){
        User user=new User();
        //通过条件自动拼接动态sql
        user.setName("rqk1");
        user.setId(6);

        //注意：虽然方法名叫updateById 但是参数是一个 对象！
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

自动填充

创建时间、修改时间！这些操作一般都是自动化完成的，我们不希望手动更新！
阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！

方式一：数据库级别 （工作中不允许你修改数据库）

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

2、再次测试插入方法，我们需要把实体类里属性同步
3、再次更新查看结果即可

方式二：代码级别

1、删除数据库的默认值、更新！
2、实体类字段属性上需要增加注解了

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

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

package com.kang.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........");
        //setFieldValByName(String 要更改的属性, Object 值, 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);
    }
}

乐观锁

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

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

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

乐观锁实现方式：

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

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

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

测试一下Mybatis-Plus的乐观锁插件

1、给数据库中添加version字段！
2、给实体类添加属性

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

3、注册组件

package com.kang.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.kang.mapper")
@EnableTransactionManagement
@Configuration //配置类
public class MyBatisPlusConfig {

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

4、测试

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

    //测试乐观锁失败！多线程下
    @Test
    public void testOptimisticLocker2(){
        //线程1
        User user = userMapper.selectById(1);
        user.setName("RQK111");
        user.setEmail("2444292287@qq.com");

        //模拟另一个线程执行了插队操作
        User user2=userMapper.selectById(1);
        user2.setName("RQK333");
        user.setEmail("2444292287@qq.com");
        userMapper.updateById(user2);

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

查询

 //根据id查询
    @Test
    public void testSelectById(){
        User user = userMapper.selectById(1);
        System.out.println(user);
    }

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

    //条件查询
    @Test
    public void testSelectByMap(){
        Map<String,Object> map=new HashMap<String,Object>();
        map.put("name","任庆康1");
        map.put("age",3);
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

分页查询

1、原始的limit进行分页 2、pageHelper第三方插件 3、MyBatisPlus内置分页插件
如何使用
1、配置拦截器组件 在你的xxxConfig类中

// 旧版
    @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;
    }
    
    // 最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }

2、直接使用Page对象

  //分页
    @Test
    public void testPage(){
        Page<User> page=new Page<>(1,3);
        userMapper.selectPage(page,null);
        page.getRecords().forEach(System.out::println);
        System.out.println(page.getTotal());
    }

删除

userMapper.deleteBatchIds(Arrays.asList(1,2,3));
userMapper.deleteById(1);
userMapper.deleteByMap(map);

逻辑删除

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

逻辑删除：再数据库中没有被移除，而是通过一个变量让他失效！isDelete=0 或者 isDelete=1

1、在数据库中加入一个isDelete字段
2、实体类添加属性

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

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、测试一下删除

实际上执行的是更新操作
再去执行查询操作时

sql语句会自动拼接 is_delete=0，所以查询不到

性能分析插件

我们在平时的开发中，会遇到一些慢sql。
作用：性能分析拦截器，用于输出每条SQL语句及其执行时间
MyBatisPlus也提供性能分析插件，如果超过这个时间就会停止运行！

1、导入插件

	@Bean
    @Profile({"dev","test"})
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);//设置sql执行的最大时间，如果超过了则不执行 单位ms
        performanceInterceptor.setFormat(true);//是否格式化代码
        return performanceInterceptor;
    }

记住，要在SpringBoot中配置环境为dev或者test环境！
2、测试使用

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

结果

条件构造器

测试一

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

测试二

 	@Test
    public void testWrapper2(){
        //查询name等于任庆康的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","任庆康");
        System.out.println(userMapper.selectOne(wrapper));//selectOne()只查询一个数据，出现多个结果报错
    }

测试三

@Test
    void testWrapper3(){
        //查询年龄在20~30岁之间的用户个数
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);
        Integer integer = userMapper.selectCount(wrapper);
        System.out.println(integer);
    }

测试四

 @Test
    public void testWrapper(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name","e").likeRight("email","t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

测试五

	@Test
    void testWrapper5(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.inSql("id","select id from user where id<3");
        List<Object> list = userMapper.selectObjs(wrapper);
        list.forEach(System.out::println);
    }

测试六

	@Test
    public void testWrapper6(){
        //排序
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        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 等各个模块的代码，极大的提升了开发效率。

需要导入另外两个依赖

		<dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

package com.kang;

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.List;

import java.util.ArrayList;

//代码自动生成器
public class KangCode {
    public static void main(String[] args) {
        //需要构建一个  代码自动生成器对象
        AutoGenerator autoGenerator = new AutoGenerator();
        //配置策略

        //1、全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");//获取系统当前目录
        globalConfig.setOutputDir(projectPath+"/src/main/jave");//输出到那个目录
        globalConfig.setAuthor("rqk");//设置作者
        globalConfig.setOpen(false);//是否打开资源管理器
        globalConfig.setFileOverride(false);//是否覆盖
        globalConfig.setServiceName("%sService");//设置服务的名字  去Service的I前缀
        globalConfig.setIdType(IdType.ID_WORKER);//设置id的类型，
        globalConfig.setDateType(DateType.ONLY_DATE);//设置时间类型
        globalConfig.setSwagger2(true);
        autoGenerator.setGlobalConfig(globalConfig);//把设置放到自动生成器中

        //设置数据源
        DataSourceConfig dataSourceConfig=new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/user?useSSL=false&useUnicode=true&characterEncoding=UTF-8");
        dataSourceConfig.setPassword("root");
        dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setDbType(DbType.MYSQL);//数据库类型
        autoGenerator.setDataSource(dataSourceConfig);

        //包的配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setModuleName("blog");//设置模块名
        packageConfig.setParent("com.kang");//放在哪个包下
        packageConfig.setEntity("pojo");//设置实体类包名
        packageConfig.setMapper("mapper");//设置mapper包名
        packageConfig.setService("service");//设置service包名
        packageConfig.setController("controller");//设置controller包名
        autoGenerator.setPackageInfo(packageConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user","book");//设置要映射的表名 可以写多个
        strategy.setNaming(NamingStrategy.underline_to_camel);//设置表名生成策略
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);//自动生成lombok
        strategy.setLogicDeleteFieldName("is_delete");//设置逻辑删除 参数写字段名
        //自动填充配置
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);//inset操作自动填充
        TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);//inset操作和update操作自动填充
        List<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_1
        autoGenerator.setStrategy(strategy);

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