一篇文章搞懂MybatisPlus

整理自狂神说

一、MybatisPlus有什么用

强大的 CRUD 操作，内置全局拦截插件，内置性能分析插件，内置分页插件，分页插件支持多种数据库,内置代码生成器，支持 ActiveRecord 模式，支持主键自动生成

二、MybatisPlus的入门案例

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) );
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项目，导入依赖

<!-- 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
    <groupId>org.projectlombok</groupId> 
    <artifactId>lombok</artifactId> 
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是自己开发，并非官方的！ --> 
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId> 
    <version>3.0.5</version>
</dependency>

注：尽量不要同时导入mybatis和mybatis-plus！

3、编写aplication.properties文件

# mysql
spring.datasource.username=root
spring.datasource.password=123123
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

4、编写实体类

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

5、编写mapper接口

@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
   
}

注：继承BaseMapper接口，BaseMapper里代表操作的对象，所有的CRUD操作都已经基本完成了，不需要像以前的配置一大堆文件了

6、springboot主启动类上

@MapperScan("com.sk.mapper")//扫描包

7、在测试类中测试

@SpringBootTest
class MybatisPlusApplicationTests {

    
    //自动装配mapper
    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //参数是一个Wrapper , 条件构造器,这里我们先不用 --null
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

三、配置日志

1、作用

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

2、使用

# 配置日志 (在application.properties)
mybatisplus.configuration.logimpl=org.apache.ibatis.logging.stdout.StdOutImpl

四、CRUD的扩展

1、插入操作的扩展

（1）全局唯一id（默认）

作用：插入某个user时，没设置id，系统会帮我们自动设置一个随机的id（雪花算法：生成一个几乎全球唯一的id）

开启方法：默认开启

（2）主键自增

作用：插入某个user时，没设置id，系统会帮我们自动设置增长的id

开启方法：在实体类的id字段上，加上@TableId(type = IdType.AUTO) ，数据库的id字段要设置为自增

（3）NONE

作用：插入某个user时，没设置id，则为id为null

开启方法：在实体类的id字段上，加上@TableId(type = IdType.NONE)

2、更新操作的扩展

（1）自动拼接sql

作用：当我们在修改某行数据（对象）时，可以直接把修改好的对象放进去，不用考虑sql，会自动修改数据

举例：

//测试更新
@Test
public void testUpdate(){
    User user = new User();
    // 通过条件自动拼接动态sql
    user.setId(6L);
    user.setName("关注我的微信公众号");
    user.setAge(18);
    // 注意： updateById 但是参数是一个 对象
    int i = userMapper.updateById(user);
    System.out.println(i);
}

（2）自动填充时间

作用：当修改表时，系统能够自动的将你修改数据库的时间保存到数据库的字段中

使用：

方法一、数据库级别（不让用，略）

方法二、代码级别

1、删除数据库时间字段的默认值和更新操作

2、实体类对应字段上添加注解

//记住用util包下的Date!!
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Data creatTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Data updateTime;

3、编写处理器（类）来处理这个注解(复制即可)

package com.codeyuaiiao.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、插入数据时，就会有记录了

（3）乐观锁

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

悲观锁;顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!

乐观锁实现方式:（通过version，修改后，version会+1）

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

（即：当有两个线程运行时，都要修改同一个数据，某个线程修改数据成功之后，令一个线程的修改便会失效）

具体实现：

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

2、需要实体类加上对应的字段

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

3、注册组件（类）

// 扫描我们的 mapper文件夹
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {

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

4、进行测试

    // 测试乐观锁成功
    @Test
    public void testVersionSuccess(){
        // 1. 查询用户信息
        User user = userMapper.selectById(1L);
        // 2. 修改用户信息
        user.setName("fan");
        user.setAge(24);
        // 3. 执行更新操作
        userMapper.updateById(user);
    }

    // 测试乐观锁失败!多线程下
    @Test
    public void testVersionFall(){
        // 线程1
        User user1 = userMapper.selectById(1L);
        user1.setName("fan111");
        user1.setAge(14);

        // 线程2
        User user2 = userMapper.selectById(1L);
        user2.setName("fan222");
        user2.setAge(24);
        
        
        userMapper.updateById(user2);
        
        //自旋锁来多次尝试提交！
        userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
    }
}

5、结果

user2的数据更新成功

3、查询操作的扩展

（1）批量查询

作用：根据多个id，批量多个数据（selectBatchIds）

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

（2）条件查询

作用：————（selectByMap）

@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","Dainel");
    map.put("age","6");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

（3）分页查询

作用：将数据库中的数据分页显示出来

1、在config类中配置拦截器

// 分页插件
@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());
}

4、删除操作的扩展

（1）基本的删除

// 测试删除
@Test
public void testdelete(){
    userMapper.deleteById(6L);
}

// 测试批量删除
@Test
public void testdeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1287326823914405893L,1287326823914405894L));
}

//通过map删除
@Test
public void testDeleteByMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","KUANG");
    userMapper.deleteByMap(map);
}

（2）逻辑删除

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

逻辑删除: 在数据库中没有被移除,而是通过一个变量来让他无法被查到 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、执行删除操作后

走更新操作后，会更新delete的值，而数据不会被删除

查询时却无法找到

五、性能分析插件

1、作用

我们在平时的开发中，会遇到一些慢sql。解决方案：测试，druid监控…

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

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

2、使用方法

1、导入插件

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

注：要在SpringBoot中配置环境为dev或者test环境！

2、测试使用

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

注:超过规定的时间就会抛异常

六、条件构造器

1、作用

用来写一些复杂的sql

2、测试

1、查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12

@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 
void test2(){ 
    // 查询名字狂神说 
    QueryWrapper<User> wrapper = new QueryWrapper<>(); 
    wrapper.eq("name","狂神说"); 
    User user = userMapper.selectOne(wrapper); // 查询一个数据，出现多个结果使用List 或者 Map 
    System.out.println(user); 
}

3、查询年龄在 20 ~ 30 岁之间的用户

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

4、查询名字中无e的用户和邮箱以t开头的用户

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

5、按id降序顺序查找用户

//测试无
@Test void test6(){ 
    QueryWrapper<User> wrapper = new QueryWrapper<>(); 
    // 通过id进行排序 
    wrapper.orderByAsc("id"); 
    List<User> users = userMapper.selectList(wrapper); 
    users.forEach(System.out::println); 
}

3、核心

就是在构造器上附加查询的具体条件