一、MybatisPlus-基本使用一、简介二、主要特性无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝

本文是系列文章，目录：
本文是系列文章，目录：
一、MybatisPlus-基本使用
 二、MybatisPlus-进阶使用-条件构造器
 三、MybatisPlus-进阶使用-自定义sql
四、MybatisPlus-进阶使用-Service接口（1）-基本使用
 五、MybatisPlus-进阶使用-Service接口（2）-自定义service
六、MybatisPlus-进阶使用-Service接口（3）- 批量新增
 七、MybatisPlus-进阶使用-逻辑删除
 八、MybatisPlus-进阶使用-枚举处理器
 九、MybatisPlus-进阶使用-JSON类型处理器
 十、MybatisPlus-进阶使用-配置文件加密
 十一、MybatisPlus-插件功能-分页插件(1)
十二、MybatisPlus-插件功能-分页插件(2)-通用分页封装
 十三、MybatisPlus-插件功能-乐观锁插件
 十四、MybatisPlus-插件功能-sql性能分析
 十五、MybatisPlus-自动填充字段
 MybatisPlus-问题汇总

一、简介

MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。另外还支持代码生成、自动分页、逻辑删除、自动填充、拦截器等功能。

二、主要特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

三、学习目标

能利用MybatisPlus实现基本的CRUD
会使用MybatisPlus中的常用注解
会使用MybatisPlus中的常用配置
会使用条件构建造器构建查询和更新语句
会使用MybatisPlus处理枚举、JSON类型字段
会使用MybatisPlus实现分页

四、实现基本的CRUD

4.1 项目搭建

4.1.1 创建工程

微信图片_20240813181032.png

4.1.2 引入依赖

<!-- 添加依赖 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.32</version>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

4.1.3 application.yaml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3307/mp?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: root
logging:
  level:
    com.pino.demo: debug
  pattern:
    dateformat: HH:mm:ss
mybatis:
  mapper-locations: classpath*:mapper/*.xml

4.2 基本使用

4.2.1 创建用户类

package com.pino.demo.domain.po;

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class User {

    /**
     * 用户id
     */
    private Long id;

    /**
     * 用户名
     */
    private String username;

    /**
     * 密码
     */
    private String password;

    /**
     * 注册手机号
     */
    private String phone;

    /**
     * 详细信息
     */
    private String info;

    /**
     * 使用状态（1正常 2冻结）
     */
    private Integer status;

    /**
     * 账户余额
     */
    private Integer balance;

    /**
     * 创建时间
     */
    private LocalDateTime createTime;

    /**
     * 更新时间
     */
    private LocalDateTime updateTime;
}

4.2.2 创建用户Mapper

由于使用了mabatis-plus，这里只需要继承BaseMapper就可以实现user表的基本的单表操作(增删改查)。

package com.pino.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.pino.demo.domain.po.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

4.2.3 创建测试类

package com.pino.demo;

import com.pino.demo.domain.po.User;
import com.pino.demo.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.time.LocalDateTime;
import java.util.List;

@SpringBootTest
public class UserTest {
    @Autowired
    private UserMapper userMapper;

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

    @Test
    void testInsert() {
       User user = new User();
       user.setId(5L);
       user.setUsername("LiuBei");
       user.setPassword("123");
       user.setPhone("179659846596");
       user.setBalance(1000);
       user.setInfo("{"age": 18, "intro": "国主", "gender": "female"}");
       user.setCreateTime(LocalDateTime.now());
       user.setUpdateTime(LocalDateTime.now());
       userMapper.insert(user);
    }

    @Test
    void testSelectByIds() {
       List<User> users = userMapper.selectBatchIds(List.of(1L, 2L, 3L, 4L, 5L));
       users.forEach(System.out::println);
    }

    @Test
    void testUpdateById() {
       User user = new User();
       user.setId(5L);
       user.setBalance(20000);
       userMapper.updateById(user);
    }
    @Test
    void testDelete() {
       userMapper.deleteById(5L);
    }

}

五、常用注解

MybatisPlus如何知道我们要查询的是哪张表？表中有哪些字段呢？

MybatisPlus就是根据PO实体的信息来推断出表的信息，从而生成SQL的。默认情况下：

MybatisPlus会把PO实体的类名驼峰转下划线作为表名
MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名，并根据变量类型推断字段类型
MybatisPlus会把名为id的字段作为主键

但很多情况下，默认的实现与实际场景不符，因此MybatisPlus提供了一些注解便于我们声明表信息。

5.1 @ TableName

描述：表名注解，标识实体类对应的表

使用位置：实体类

示例：

@TableName("user")
public class User {
    private Long id;
    private String name;
}

TableName注解除了指定表名以外，还可以指定很多其它属性：

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
schema	String	否	""	指定数据库的 Schema 名称。通常情况下，如果你的数据库没有使用 Schema 来组织表，这个属性可以不填写。
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMap	String	否	""	指定在 XML 中定义的 ResultMap 的 ID，用于将查询结果映射到特定类型的实体类对象。
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludeProperty	String[]	否	{}	需要排除的属性名 @since 3.3.1

5.2 @TableId

描述：主键注解，标识实体类中的主键字段

使用位置：实体类的主键字段

示例：

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
}

TableId注解支持两个属性：

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
type	Enum	否	IdType.NONE	指定主键类型

IdType支持的类型有：

值	描述
AUTO	数据库 ID 自增
NONE	无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）
INPUT	insert 前自行 set 主键值
ASSIGN_ID	分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID	分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)
~~ID_WORKER~~	分布式全局唯一 ID 长整型类型(please use ASSIGN_ID)
~~UUID~~	32 位 UUID 字符串(please use ASSIGN_UUID)
~~ID_WORKER_STR~~	分布式全局唯一 ID 字符串类型(please use ASSIGN_ID)

这里比较常见的有三种：

AUTO：利用数据库的id自增长
NONE: 未设置主键类型。若在代码中没有手动设置主键，则会根据主键的全局策略自动生成（默认的主键全局策略是基于雪花算法的自增ID）
INPUT：需要手动设置主键，若不设置。插入操作生成SQL语句时，主键这一列的值会是null。oracle的序列主键需要使用这种方式
ASSIGN_ID：雪花算法生成Long类型的全局唯一id，这是默认的ID策略
ASSIGN_UUID: 当实体类的主键属性为空时，才会自动填充，使用UUID

5.3 @TableField

描述：普通字段注解

位置：类属性

作用：指定数据库字段名称

示例：

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    @TableField("isMarried")
    private Boolean isMarried;
    @TableField("concat")
    private String concat;
}

一般情况下我们并不需要给字段添加@TableField注解，一些特殊情况除外：

成员变量名与数据库字段名不一致
成员变量是以isXXX命名，按照JavaBean的规范，MybatisPlus识别字段时会把is去除，这就导致与数据库不符。
成员变量名与数据库一致，但是与数据库的关键字冲突。使用@TableField注解给字段名添加转义字符：``

支持的其它属性如下：

属性	类型	必填	默认值	描述
value	String	否	""	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，参考(opens new window)
update	String	否	""	字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性）
insertStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_NULL insert into table_a(column) values (#{columnProperty})
updateStrategy	Enum	否	FieldStrategy.DEFAULT	举例：IGNORED update table_a set column=#{columnProperty}
whereStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_EMPTY where column=#{columnProperty}
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC 类型 (该默认值不代表会按照该值生效)
typeHandler	TypeHander	否		类型处理器 (该默认值不代表会按照该值生效)
numericScale	String	否	""	指定小数点后保留的位数

六、常见配置

MyBatis-Plus 提供了丰富的配置选项，以满足不同用户的需求。这些配置中，一部分继承自 MyBatis 原生支持的配置，另一部分则是 MyBatis-Plus 特有的扩展配置。

大多数的配置都有默认值，因此我们都无需配置。但还有一些是没有默认值的，例如:实体类的别名扫描包、全局id类型。
在 Spring Boot 项目中，可以通过 application.yml 或 application.properties 文件来配置 MyBatis-Plus。
例如：

mybatis-plus:
 # 指定 MyBatis 别名包扫描路径，用于给包中的类注册别名。注册后，在 Mapper 对应的 XML 文件中可以直接使用类名，无需使用全限定类名。
  type-aliases-package: com.pino.demo
  # MyBatisPlus也支持手写SQL的，而mapper文件的读取地址可以自己配置：
  mapper-locations: classpath:/mapper/**.xml
  configuration:
    # 开启自动驼峰命名规则（camel case）映射
    map-underscore-to-camel-case: true
  global-config:
    # 全局配置
    db-config:
      # 数据库配置
      id-type: auto