SSM - Springboot - MyBatis-Plus 全栈体系（三十二）

第七章 MyBatis-Plus

二、MyBatis-Plus 核心功能

5. 核心注解使用

5.1 理解和介绍

• MyBatis-Plus 是一个基于 MyBatis 框架的增强工具，提供了一系列简化和增强的功能，用于加快开发人员在使用 MyBatis 进行数据库访问时的效率。

• MyBatis-Plus 提供了一种基于注解的方式来定义和映射数据库操作，其中的注解起到了重要作用。

• 理解：

public interface UserMapper extends BaseMapper<User> {

}
1
2
3

• 此接口对应的方法为什么会自动触发 user 表的 crud 呢？

  • 默认情况下， 根据指定的<实体类>的名称对应数据库表名，属性名对应数据库的列名！

  • 但是不是所有数据库的信息和实体类都完全映射！

  • 例如： 表名 t_user → 实体类 User 这时候就不对应了！

  • 自定义映射关系就可以使用 mybatis-plus 提供的注解即可！

5.2 @TableName 注解

• 描述：表名注解，标识实体类对应的表
• 使用位置：实体类

@TableName("sys_user") //对应数据库表名
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
1
2
3
4
5
6
7

• 特殊情况：如果表名和实体类名相同（忽略大小写）可以省略该注解！

• 其他解决方案：全局设置前缀 (https://www.baomidou.com/pages/56bac0/#基本配置)

mybatis-plus: # mybatis-plus的配置
  global-config:
    db-config:
      table-prefix: sys_ # 表名前缀字符串
1
2
3
4

5.3 @TableId 注解

• 描述：主键注解
• 使用位置：实体类主键字段

@TableName("sys_user")
public class User {
    @TableId(value="主键列名",type=主键策略)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
1
2
3
4
5
6
7
8

• IdType属性可选值：

• 全局配置修改主键策略:

mybatis-plus:
  configuration:
    # 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_
      # 配置MyBatis-Plus的主键策略
      id-type: auto
1
2
3
4
5
6
7
8
9
10

• 在以下场景下，添加@TableId注解是必要的：

  • 实体类的字段与数据库表的主键字段不同名：如果实体类中的字段与数据库表的主键字段不一致，需要使用@TableId注解来指定实体类中表示主键的字段。
  • 主键生成策略不是默认策略：如果需要使用除了默认主键生成策略以外的策略，也需要添加@TableId注解，并通过value属性指定生成策略。

5.4 雪花算法使用场景

• 雪花算法（Snowflake Algorithm）是一种用于生成唯一 ID 的算法。它由 Twitter 公司提出，用于解决分布式系统中生成全局唯一 ID 的需求。

• 在传统的自增 ID 生成方式中，使用单点数据库生成 ID 会成为系统的瓶颈，而雪花算法通过在分布式系统中生成唯一 ID，避免了单点故障和性能瓶颈的问题。

• 雪花算法生成的 ID 是一个 64 位的整数，由以下几个部分组成：

  • 时间戳：41 位，精确到毫秒级，可以使用 69 年。

  • 节点 ID：10 位，用于标识分布式系统中的不同节点。

  • 序列号：12 位，表示在同一毫秒内生成的不同 ID 的序号。

  • 通过将这三个部分组合在一起，雪花算法可以在分布式系统中生成全局唯一的 ID，并保证 ID 的生成顺序性。

• 雪花算法的工作方式如下：

  • 当前时间戳从某一固定的起始时间开始计算，可以用于计算 ID 的时间部分。
  • 节点 ID 是分布式系统中每个节点的唯一标识，可以通过配置或自动分配的方式获得。
  • 序列号用于记录在同一毫秒内生成的不同 ID 的序号，从 0 开始自增，最多支持 4096 个 ID 生成。

• 需要注意的是，雪花算法依赖于系统的时钟，需要确保系统时钟的准确性和单调性，否则可能会导致生成的 ID 不唯一或不符合预期的顺序。

• 雪花算法是一种简单但有效的生成唯一 ID 的算法，广泛应用于分布式系统中，如微服务架构、分布式数据库、分布式锁等场景，以满足全局唯一标识的需求。

• 需要记住的: 雪花算法生成的数字,需要使用 Long 或者 String 类型主键!!

5.5 @TableField

• 描述：字段注解（非主键）

@TableName("sys_user")
public class User {
    @TableId
    private Long id;
    @TableField("nickname")
    private String name;
    private Integer age;
    private String email;
}
1
2
3
4
5
6
7
8
9

• MyBatis-Plus 会自动开启驼峰命名风格映射!!!

三、MyBatis 高级扩展

1. 逻辑删除实现

1.1 概念

• 逻辑删除，可以方便地实现对数据库记录的逻辑删除而不是物理删除。逻辑删除是指通过更改记录的状态或添加标记字段来模拟删除操作，从而保留了删除前的数据，便于后续的数据分析和恢复。

  • 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据
  • 逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

1.2 逻辑删除实现

1.2.1 数据库和实体类添加逻辑删除字段

1.2.1.1 表添加逻辑删除字段

• 可以是一个布尔类型、整数类型或枚举类型。

ALTER TABLE USER ADD deleted INT DEFAULT 0 ;  # int 类型 1 逻辑删除 0 未逻辑删除
1

1.2.1.2 实体类添加逻辑删除属性

@Data
public class User {

   // @TableId
    private Integer id;
    private String name;
    private Integer age;
    private String email;

    @TableLogic
    //逻辑删除字段 int mybatis-plus下,默认 逻辑删除值为1 未逻辑删除 1
    private Integer deleted;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

1.2.2 指定逻辑删除字段和属性值

1.2.2.1 单一指定

@Data
public class User {

   // @TableId
    private Integer id;
    private String name;
    private Integer age;
    private String email;
     @TableLogic
    //逻辑删除字段 int mybatis-plus下,默认 逻辑删除值为1 未逻辑删除 1
    private Integer deleted;
}
1
2
3
4
5
6
7
8
9
10
11
12

1.2.2.2 全局指定

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

1.2.3 演示逻辑删除操作

逻辑删除以后,没有真正的删除语句,删除改为修改语句!

1.2.3.1 删除代码

//逻辑删除
@Test
public void testQuick5(){
    //逻辑删除
    userMapper.deleteById(5);
}
1
2
3
4
5
6

1.2.3.2 执行效果

JDBC Connection [com.alibaba.druid.proxy.jdbc.ConnectionProxyImpl@5871a482] will not be managed by Spring
==> Preparing: UPDATE user SET deleted=1 WHERE id=? AND deleted=0
==> Parameters: 5(Integer)
<==    Updates: 1
1
2
3
4

1.2.4 测试查询数据

@Test
public void testQuick6(){
    //正常查询.默认查询非逻辑删除数据
    userMapper.selectList(null);
}

//SELECT id,name,age,email,deleted FROM user WHERE deleted=0
1
2
3
4
5
6
7

2. 乐观锁实现

2.1 悲观锁和乐观锁场景和介绍

2.1.1 并发问题场景演示

2.1.2 解决思路

• 乐观锁和悲观锁是在并发编程中用于处理并发访问和资源竞争的两种不同的锁机制!!
• 悲观锁：
  • 悲观锁的基本思想是，在整个数据访问过程中，将共享资源锁定，以确保其他线程或进程不能同时访问和修改该资源。悲观锁的核心思想是"先保护，再修改"。在悲观锁的应用中，线程在访问共享资源之前会获取到锁，并在整个操作过程中保持锁的状态，阻塞其他线程的访问。只有当前线程完成操作后，才会释放锁，让其他线程继续操作资源。这种锁机制可以确保资源独占性和数据的一致性，但是在高并发环境下，悲观锁的效率相对较低。
• 乐观锁：
  • 乐观锁的基本思想是，认为并发冲突的概率较低，因此不需要提前加锁，而是在数据更新阶段进行冲突检测和处理。乐观锁的核心思想是"先修改，后校验"。在乐观锁的应用中，线程在读取共享资源时不会加锁，而是记录特定的版本信息。当线程准备更新资源时，会先检查该资源的版本信息是否与之前读取的版本信息一致，如果一致则执行更新操作，否则说明有其他线程修改了该资源，需要进行相应的冲突处理。乐观锁通过避免加锁操作，提高了系统的并发性能和吞吐量，但是在并发冲突较为频繁的情况下，乐观锁会导致较多的冲突处理和重试操作。
• 理解点: 悲观锁和乐观锁是两种解决并发数据问题的思路,不是具体技术！

2.1.3 具体技术和方案

2.1.3.1 乐观锁实现方案和技术

• 版本号/时间戳：为数据添加一个版本号或时间戳字段，每次更新数据时，比较当前版本号或时间戳与期望值是否一致，若一致则更新成功，否则表示数据已被修改，需要进行冲突处理。
• CAS（Compare-and-Swap）：使用原子操作比较当前值与旧值是否一致，若一致则进行更新操作，否则重新尝试。
• 无锁数据结构：采用无锁数据结构，如无锁队列、无锁哈希表等，通过使用原子操作实现并发安全。

2.1.3.2 悲观锁实现方案和技术

• 锁机制：使用传统的锁机制，如互斥锁（Mutex Lock）或读写锁（Read-Write Lock）来保证对共享资源的独占访问。
• 数据库锁：在数据库层面使用行级锁或表级锁来控制并发访问。
• 信号量（Semaphore）：使用信号量来限制对资源的并发访问。

2.1.4 介绍版本号乐观锁技术的实现流程

• 每条数据添加一个版本号字段 version
• 取出记录时，获取当前 version
• 更新时，检查获取版本号是不是数据库当前最新版本号
• 如果是[证明没有人修改数据], 执行更新, set 数据更新 , version = version+ 1
• 如果 version 不对[证明有人已经修改了]，我们现在的其他记录就是失效数据!就更新失败

2.2 使用 mybatis-plus 数据使用乐观锁

2.2.1 添加版本号更新插件

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
    return interceptor;
}
1
2
3
4
5
6

2.2.2 乐观锁字段添加@Version 注解

• 注意: 数据库也需要添加 version 字段

ALTER TABLE USER ADD VERSION INT DEFAULT 1 ;  # int 类型 乐观锁字段
1

• 支持的数据类型只有：
  • int,Integer,long,Long,Date,Timestamp,LocalDateTime
• 仅支持 updateById(id) 与 update(entity, wrapper) 方法

@Version
private Integer version;
1
2

2.2.3 正常更新使用即可

//演示乐观锁生效场景
@Test
public void testQuick7(){
    //步骤1: 先查询,在更新 获取version数据
    //同时查询两条,但是version唯一,最后更新的失败
    User user  = userMapper.selectById(5);
    User user1  = userMapper.selectById(5);

    user.setAge(20);
    user1.setAge(30);

    userMapper.updateById(user);
    //乐观锁生效,失败!
    userMapper.updateById(user1);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

3. 防全表更新和删除实现

• 针对 update 和 delete 语句 作用: 阻止恶意的全表更新删除

3.1 添加防止全表更新和删除拦截器

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
	  MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
	  interceptor.addInnerInterceptor(new BlockAttackInnerInterceptor());
	  return interceptor;
	}
}
1
2
3
4
5
6
7

3.2 测试全部更新或者删除

@Test
public void testQuick8(){
    User user = new User();
    user.setName("custom_name");
    user.setEmail("xxx@mail.com");
    //Caused by: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException: Prohibition of table update operation
    //全局更新,报错
    userService.saveOrUpdate(user,null);
}
1
2
3
4
5
6
7
8
9

四、MyBatis-Plus 代码生成器(MyBatisX 插件)

1. MyBatisX 插件逆向工程

• MyBatis-Plus 为我们提供了强大的 mapper 和 service 模板，能够大大的提高开发效率

• 但是在真正开发过程中，MyBatis-Plus 并不能为我们解决所有问题，例如一些复杂的 SQL，多表联查，我们就需要自己去编写代码和 SQL 语句，我们该如何快速的解决这个问题呢，这个时候可以使用 MyBatisX 插件

• MyBatisX 一款基于 IDEA 的快速开发插件，为效率而生。

2. MyBatisX 快速代码生成

• 使用 mybatisX 插件,自动生成 sql 语句实现
• https://baomidou.com/pages/ba5b24/#%E5%8A%9F%E8%83%BD