My Batis-Plus学习笔记

简介

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

为什么要学习它呢？

MyBatis-Plus更加简洁，简化了MyBatis，可以帮我们节省大量的工作时间，所有的CRUD（增删改查）都可以自动完成！

MyBatis-Plus官网：https://baomidou.com/

特性

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

快速入门

第一个项目

创建数据库

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

注入依赖

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

连接数据库

在资源文件夹中编写连接数据库的代码：

#mysql 5 驱动不同
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.cj.jdbc.Driver
#mysql 8 驱动不同，需要增加时区的配置  serverTimezone=GMT%2B8

在手动连接数据库

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2DPvUq3C-1616305666440)(D:\picture\study picture\连接数据库1 2021-03-11 143204.png)]

编写代码

创建普通java类，映射数据库的数据

package com.chao.pojo;

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

@Data   //提供属性的getting，setting方法
@AllArgsConstructor   //生成一个包含所有变量
@NoArgsConstructor   //生成一个无参数的构造方法
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

扫描mapper文件夹

package com.chao;

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

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

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

}

调用数据

package com.chao.mapper;

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

//在对应的mapper上继承基本的类 BaseMapper
@Repository //代表持久层
public interface UserMapper extends BaseMapper <User>{
    //目前为止所有的CRUD操作已经完成了
    //不用像以前一样去配置一大推文件
}

查询所有用户

package com.chao;

import com.chao.mapper.UserMapper;
import com.chao.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);
    }

}

配置日志

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

CRUD扩展

测试插入数据

    @Test
    public void tesInsert(){
        User user = new User();
        user.setName("唐钦鑫");
        user.setAge(18);
        user.setEmail("153@qq.com");

        int result = userMapper.insert(user);
        System.out.println(result);
        System.out.println(user);
    }

ID自增

在实体类中加代码，把数据库的设计表中的自增打开

@TableId(type = IdType.AUTO)

其余的源码解释：

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

更新操作

测试：

    //测试更新
    @Test
    public void tesUpdate(){
        User user = new User();
        //通过条件自动拼接动态sql
        user.setId(5L);
        user.setAge(21);
        user.setEmail("188@qq.com");

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

时间方法

方法一

数据库级别 工作时不允许使用

在数据库中添加两个字段，创建时间，更新时间

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tR57B5i6-1616305666442)(D:\picture\study picture\屏幕截图 2021-03-12 092357.png)]

插入字段，同步实体类

public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date create_time;
    private Date update_time;
}

方法二

代码级别，建议使用

实体类中获取本地时间

    @TableField(fill = FieldFill.INSERT)//自动填充，自动拿取本地时间
    private Date create_time;   //创建时间
    @TableField(fill = FieldFill.INSERT_UPDATE)//自动填充，自动拿取且更新本地时间
    private Date update_time;   //更新时间

创建处理器来处理注解

package com.chao.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 fieldName, Object fieldVal, MetaObject metaObject)
        this.setFieldValByName("create_time",new Date(),metaObject);
        this.setFieldValByName("update_time",new Date(),metaObject);
    }

    // 更新式的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start insert fill......");
        this.setFieldValByName("update_time",new Date(),metaObject);
    }
}

乐观锁

数据库增加字段version

乐观锁组件

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

注册组件

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

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

}

测试一下

    //测试乐观锁成功！  多线程如下
    @Test
    public void testOptimisticLocker(){
        //线程一
        //1.查询用户信息
        User user = userMapper.selectById(1369946399164149762L);
        //2.修改用户信息
        user.setName("暗黑大帝");
        user.setEmail("156@qq.com");
        //3.执行更新操作
        userMapper.updateById(user);

        //线程二  模拟另外一个执行了插队操作
        User user2 = userMapper.selectById(1369946399164149762L);
        user2.setName("修罗铠甲");
        user2.setEmail("666@qq.com");
        userMapper.updateById(user2);

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

    }

结果为线程二插了线程一的队

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3P2VP69N-1616305666444)(D:\picture\study picture\屏幕截图 2021-03-14 193906.png)]

查询操作

查询id为1的信息

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

查询多个ID

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

按条件查询

    //按条件查询之一使用map操作
    @Test
    public void testSelectByBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        //自定义查询
        map.put("name","唐钦鑫");   //查询neme为唐钦鑫的用户
        map.put("age",18);   //查询age为18的用户
        List<User> users = userMapper.selectByMap(map);
        System.out.println(map);
    }

分页查询

    //测试分页查询
    @Test
    public void testPage(){
        //参数一：当前页
        //参数二：页面大小
        //使用了分页插件之后，所有的的分页操作变得简单
        //查询第1页的5条数据
        Page<User> page = new Page<>(1,5);
        userMapper.selectPage(page,null);

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

删除操作

删除指定ID的单个用户

    //测试删除指定ID的用户
    @Test
    public void testDeleteById(){
        userMapper.deleteById(1369946399164149763L);
    }

删除指定的多个用户

    //测试删除指定的多个用户
    @Test
    public void testDeleteBachID(){
        userMapper.deleteBatchIds(Arrays.asList(1369946399164149767L,1369946399164149766L));
    }

通过map删除

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

逻辑删除

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

逻辑删除：在数据库中没有被删除，而是通过一个变量

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

开始调试

首先在MySQL数据库中增加一个deleted

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cvf3OiAs-1616305666447)(D:\picture\study picture\屏幕截图 2021-03-15 173910.png)]

基本设置

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GFLT4q4L-1616305666448)(D:\picture\study picture\屏幕截图 2021-03-15 174323.png)]

在普通java类增加字段

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

在配置文件中，配置逻辑删除（deletedApplication.yml）

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

然后开始之前的删除操作，会发现控制台查不到被删除的数据，但在我们的数据库里还是可以看到用户数据

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-i2fqJIgR-1616305666449)(D:\picture\study picture\屏幕截图 2021-03-15 195757.png)]

以上就是CRUD的操作以及扩展操作，我们必须精通掌握！

性能分析插件

了解一下（现在已经被MP弃用）

作用：性能分析拦截器，用于输出的每条sql语句以及执行时间，如果过了设置的时间就会停止运行！

导入插件

//    注册性能分析组件(但是在新版本中已经被MP弃用了！)
//    @Bean
//    设置dev、test环境开启，保证效率
//    @Profile({"dev","test"})
//    public PerformanceInterceptor performanceInterceptor(){
//        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
//        //设置sql执行的最大时间，如果超过了则不执行，单位为ms
//        performanceInterceptor.setMaxTime(1000);
//        //是否格式化代码
//        performanceInterceptor.setFormat(true);
//        return performanceInterceptor;
//    }

配置文件

#性能测试器（在新版本中已经被MP弃用）
#spring.profiles.active=test或者dev

条件构造器（重点）

我们用复杂的sql语句就可以用他来替代。

test01

    @Test
    void contextLoads(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name");//查询那么不为空的用户
        wrapper.isNotNull("email");//并且邮箱不为空的用户
        wrapper.ge("age",19);//年龄大于或等于19的用户
        //查询全部的wrapper
        userMapper.selectList(wrapper).forEach(System.out::println);
//        System.out.println(wrapper);
    }

test02

@Test
void test02(){
    //查询name为修罗铠甲
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","修罗铠甲"); //eq:同步、等于的意思
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

test03

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

test04

//模糊查询
@Test
void test04(){
    //左和右   %t%
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name","8");
    wrapper.likeRight("email" ,"1");

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

test05

@Test
void test05(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //id 在子查询中查出来
    //查询id小于3的用户
    wrapper.inSql("id","select id from user where id<3");

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

test06

    @Test
    void test06(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //通过id进行排序
        wrapper.orderByDesc("id");   //降序排序
//        wrapper.orderByAsc("id");   //升序排序

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

:println);
}

test05

```java
@Test
void test05(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //id 在子查询中查出来
    //查询id小于3的用户
    wrapper.inSql("id","select id from user where id<3");

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

test06

    @Test
    void test06(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //通过id进行排序
        wrapper.orderByDesc("id");   //降序排序
//        wrapper.orderByAsc("id");   //升序排序

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