MyBatis-Plus速成指南：常用注解

原创已于 2025-02-04 17:10:14 修改 · 1k 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #java #开发语言

于 2025-02-04 17:09:49 首次发布

@Table Name:

概述：
1. MyBatis-Plus 在确定操作的表时，由 BaseMapper的泛型决定，即实体类决定，且默认操作的表名和实体类的类名一致
问题：
1. 如果实体类类型的类名和要操作表的表名不一致会出现什么问题？(把 user 表改成 t_user)
  1. 答：程序抛出异常，Table 'mybatis_plus,.user' doesn't exist，因为现在的表名 t_user，而默认的表名和实体类型的类名一致，即 user表：
通过 @TableName 解决问题：
1. 在实体类类型上添加 @TableName("t_user")，表示实体类对应的表，即可成功执行 SQL 语句
通过全局配置解决问题：
1. 在开发过程中，我们经常遇到以上问题，即实体类所对应的表都有固定的前缀，例如 t_ 或 tbl_
2. 此时，可以使用 MyBatis-Plus 提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过 @TableName 标识实体类对应的表

@TableId：

概述：
1. 经过以上的测试，MyBatis-Plus 在实现 CURD 时，会默认将 id 作为主键列，并在插入数据时，默认基于雪花算法的策略生成的 id
问题：
1. 若实体类和表中标识主键的不是 id，而是其他字段，例如 uid，MyBatis-Plus 会自动识别 uid 作为主键列吗？
  1. 答：程序抛出异常 Field 'u_id' doesn't have a default value ，说明 MyBatis-Plus 没有将 uid 作为主键赋值
通过 @TableId 解决问题：
1. 在实体类中 uid 属性上通过 @TableId 将其标识为主键，即可成功执行 SQL 语句

@TableId 的 value 属性：

若实体类中主键对应的属性为 id，而表中表示主键的字段为 uid，此时若只在属性 id 上添加注解 @TableId，则抛出异常 Unknown column 'id' in 'field list'，即 MyBatis-Plus 仍然会将 id 最为表的主键操作，而表中表示主键的字段是 uid
此时需要通过 @TableId 注解的 value 属性，指定表中的主键字段，@TableId("uid") 或 @TableId(value = "uid")

@TableId 的 type 属性：

type 属性用来定义主键策略：

常用的主键策略：

值	描述
IdType.ASSIGN_ID(默认)	基于雪花算法的策略生成的数据 id，与数据库 id 是否设置自增无关
IdType.AUTO	使用数据库的自增策略，注意，该类型请确保数据库设置了 id 自增，否则无效

配置全局主键策略：

雪花算法：

背景：
1. 选择合适的方案去对应数据规模的增长，以应对逐渐增长的访问压力和数据量
2. 数据库的扩展方式主要包括：业务分库、主从复制、数据库分表
数据库分表：
1. 将不同业务数据分散存储到不同的数据库服务器，能够支撑百万甚至千万用户规模的业务，但如果业务继续发展，同意业务的单表数据会达到单台服务器的处理瓶颈
  1. 例如：淘宝的几亿用户数据，如果全部存放在一台数据库服务的一张表中，肯定是无法满足性能要求得，此时就需要对表单数据进行拆分
2. 单表数据拆分由两种方式：垂直分表和水平分表。示意图如下：
垂直分表：
1. 垂直分表适合将表中某些不常用且占了大量空间的列拆分出去
2. 例如：前面示意图中的 nickname 和 desription 字段，假设我们是一个婚恋网站，用户在筛选其他用户的时候，主要使用 age 和 sex 两个字段，进行查询，而 nickname 和 decription 两个字段单独存储到另外一张表中，这样在查询 age 和 sex 时，就能带来一定的性能提升
水平分表：
1. 水平分表适合表行数特别大的表，又得公司要求单表行数超过 5000 万就必须进行分表，可能超过 1000 万就要分表了
2. 而对于一些简单的表，及时存储数据超过一亿行，也可以不分表
3. 但不管怎样，当看到表的数据量达到千万级别时，作为架构师就要警觉起来，因为这很有可能是架构的性能瓶颈或者隐患
两者区别：
1. 水平分表比垂直分表会引入更多的复杂问题
2. 例如：要求全局唯一的数据 id 该如何处理

水平分表：

主键自增：
1. 以最常见的用户 ID 为例：可以按照 1000000 的范围大小进行分段，1 ~ 999999 放到表 1 中，1000000 ~ 1999999 放到表 2 中，以此类推
2. 复杂点：
  1. 分段大小的选取。
  2. 分段太小会导致切分后子表数量过多，增加维护复杂度
  3. 分段太大可能导致单表依然存在性能问题，一般建议分段大小在 100 万至 200 万之间，具体需要根据业务选取合适的分段大小
3. 优点：
  1. 可以随着数据的增加平滑的扩充新的表
  2. 例如：现在的用户是 100 万，如果增加到 1000 万，只需要增加新的表就可以了，原有的数据不需要动
4. 缺点：
  1. 分布不均匀
  2. 假如：按照 1000万来进行分表，有可能某个分段实际存储的数据量只有 1 条，而另外一个分段实际存储的数据量有 1000 万条
取模：
1. 同样以用户 ID 为例，加入我们一开始就规划了 10 个数据库表，可以简单地用 user_id %10 的值来表示数据所属的数据库表编号
2. 例如：ID 为985 的用户放到编号为 5 的子表中，以此类推
3. 优点：表分布比较均匀
4. 缺点：扩充新的表很麻烦，所有数据都要重分布
雪花算法：
1. 雪花算法是由 Twitter 公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同的主键有序性
2. 核心思想：
  1. 长度共 64 bit(一个 long 类型)
  2. 首先是一个符号位，1 bit 表示，由于 long 基本类型在 Java 中是带符号的，最高位是符号位(整数是0，负数是1)，所以 id 一般是正数，最高位是 0
3. 41 bit 时间戳(毫秒级)，存储的是时间戳的差值(当前时间 - 开始时间)，结果等于 69.73 年
4. 10 bit 作为机器的 ID：5 个 bit 是数据中心，5 个 bit 的机器 ID，可以部署在 1024 个节点
5. 12 bit 作为毫秒内的流水号：意味着每个节点在每毫秒可以产生 4096 个 ID
6. 优点：整体上按照时间自增排序，并且整个分布式系统内不会产生 ID 碰撞，并且效率较高

@TableFieId：

概述：
1. 经过以上测试，可以发现：MyBatis-Plus 在执行 SQL 语句时，要保证实体类中的属性名和表中的字段名一致
问题：如果实体类中的属性名和字段名不一致会出现什么问题？
1. 情况1：
  1. 若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格
  2. 例如：实体类属性 userName，表中字段 user_name
2. 情况2：
  1. 若实体类中的属性和表中的字段不满足情况1
  2. 例如：实体类属性 name，表中字段 username
  3. 此时需要在实体类属性上使用 @TableFieId("username") 设置属性所对应的字段名

@TableLogic：

逻辑删除：
1. 物理删除：真实删除，将对应的数据从数据中删除，之后查询不到此条被删除的数据
2. 逻辑删除：假删除，将对应数据中代表是否被删除字段的状态改为 " 被删除状态 "，之后在数据库中仍旧能看到此条数据记录
3. 使用场景：可以进行数据恢复
实现逻辑删除：
1. 将数据库中创建逻辑删除状态列，设置默认值为 0
2. 实体类中添加逻辑删除属性：
3. 测试：