Mybatis-Plus常见注解

原创

Anabelle 2022-12-04 00:27:39 ©著作权

©著作权归作者所有：来自51CTO博客作者Anabelle的原创作品，请联系作者获取转载授权，否则将追究法律责任

一、@TableName注解

在使用MyBatis-Plus实现基本的CRUD时，并没有指定要操作的表，只是在Mapper接口继承BaseMapper时，设置了泛型User，而操作的表为user表，由此可知MyBatis-Plus在确定操作的表时，由BaseMapper的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致。

但是在实际开发的时候会存在数据库中表名和实体类名字不一致的情况的，这时候就会出现错误，例如：

表名字为t_user，而实体类中类名是User:

Mybatis-Plus常见注解_字段

执行之前的测试代码会出现如下错误：

Mybatis-Plus常见注解_字段_02

如何解决上述问题呢？

方式一：通过@TableName注解解决

只需要在实体类前加上 @TableName("t_user")，让实体类识别对应的表，即可成功执行SQL语句

package com.augus.pojo;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@AllArgsConstructor
@NoArgsConstructor
@Data
@TableName(value = "t_user")
public class User implements Serializable {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

方式二：通过对mybatis-plus全局配置解决问题

在开发的过程中，往往会遇到以上的问题，即实体类所对应的表都有固定的前缀，例如t_或tbl_此时，可以使用MyBatis-Plus提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过@TableName标识实体类对应的表

只需要在application.yml上添加如下内容即可：

mybatis-plus:
  #指定实体类的位置
  type-aliases-package: com.augus.pojo
  #指定mapper映射文件的位置，这里默认就是mapper包下加载，可以不指定
  #mapper-locations:
  # 下面配置的是日志
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      # 配置mybatis-plus 操作表的前缀
      table-prefix: t_

Mybatis-Plus常见注解_字段_03

二、@TableId 注解

MyBatis-Plus在实现CRUD时，会默认将id作为主键列，并在插入数据时，默认基于雪花算法的策略生成id。但是如果实体类和表中表示主键的字段名不是id，而是其他字段，例如uid，MyBatis-Plus无法自动识别uid为主键的。

将User实体类中的属性id改为uid，同时将表中的字段id也改为uid，测试添加数据的功能会显示如下：

Mybatis-Plus常见注解_字段_04

执行后：

Mybatis-Plus常见注解_实体类_05

2.1.那么就可以通过@TableId 指定主键字段为除了id之外的某个值

在实体类中uid属性上通过@TableId将其标识为主键，即可成功执行SQL语句

package com.augus.pojo;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@AllArgsConstructor
@NoArgsConstructor
@Data
public class User implements Serializable {
    @TableId
    private Long uid;
    private String name;
    private Integer age;
    private String email;
}

2.2.@TableId的value属性

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

Mybatis-Plus常见注解_实体类_06

通过@TableId注解的value属性，指定表中的主键字段，即可解决：

package com.augus.pojo;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@AllArgsConstructor
@NoArgsConstructor
@Data
public class User implements Serializable {
    @TableId(value = "uid")
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

2.3.@TableId的type属性

2.3.1type属性用来定义主键策略，常用的type属性值如下：

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

可以通过，type属性指定当前表的主键策略

package com.augus.pojo;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@AllArgsConstructor
@NoArgsConstructor
@Data
public class User implements Serializable {
    //指定id对应的表中主键字段为uid，主键策略为自增
    @TableId(value = "uid", type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

2.3.2.配置全局主键策略

如果每一张表都配置主键策略，那么多且繁琐，所以在这里，我们就通过在application.yml中配置全局的主键策略，后续实体类中则不需要在单独设置

Mybatis-Plus常见注解_实体类_07

2.4.雪花算法

2.4.1.雪花算法产生背景

实际项目中往往需要选择合适的方案去应对数据规模的增长，以应对逐渐增长的访问压力和数据量。数据库的扩展方式主要包括：业务分库、主从复制，数据库分表。

2.4.2.数据库分表

将不同业务数据分散存储到不同的数据库服务器，能够支撑百万甚至千万用户规模的业务，但如果业务继续发展，同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如，淘宝的几亿用户数据，如果全部存放在一台数据库服务器的一张表中，肯定是无法满足性能要求的，此时就需要对单表数据进行拆分。

单表数据拆分有两种方式：垂直分表和水平分表。如下图

Mybatis-Plus常见注解_字段_08

垂直分表

垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。例如，上图中的在筛选其他用户的时候，主要是用 name和 age两个字段进行查询，而 sex、photo、grade和height字段主要用于展示，一般不会在业务查询中用到。因此我们可以将这两个字段独立到另外一张表中，这样在查询 name和 age时，就能带来一定的性能提升。

水平分表

水平分表适合表行数特别大的表，有的公司要求单表行数超过 5000 万就必须进行分表，这个数字可以作为参考，但并不是绝对标准，关键还是要看表的访问性能。对于一些比较复杂的表，可能超过 1000万就要分表了；而对于一些简单的表，即使存储数据超过 1 亿行，也可以不分表。但不管怎样，当看到表的数据量达到千万级别时，作为架构师就要警觉起来，因为这很可能是架构的性能瓶颈或者隐患。

水平分表相比垂直分表，会引入更多的复杂性，例如要求全局唯一的数据id该如何处理，处理手段如下：

主键自增

以最常见的用户 ID 为例，可以按照 1000000 的范围大小进行分段，1 ~ 999999 放到表 1中，1000000 ~ 1999999 放到表2中，以此类推。
复杂点：分段大小的选取。分段太小会导致切分后子表数量过多，增加维护复杂度；分段太大可能会导致单表依然存在性能问题，一般建议分段大小在 100 万至 2000 万之间，具体需要根据业务选取合适的分段大小。
优点：可以随着数据的增加平滑地扩充新的表。例如，现在的用户是 100 万，如果增加到 1000 万，只需要增加新的表就可以了，原有的数据不需要动。
缺点：分布不均匀。假如按照 1000 万来进行分表，有可能某个分段实际存储的数据量只有 1 条，而另外一个分段实际存储的数据量有 1000 万条。

取模

同样以用户 ID 为例，假如我们一开始就规划了 10 个数据库表，可以简单地用 user_id % 10 的值来表示数据所属的数据库表编号，ID 为 985 的用户放到编号为 5 的子表中，ID 为 10086 的用户放到编号为 6 的子表中。
复杂点：初始表数量的确定。表数量太多维护比较麻烦，表数量太少又可能导致单表性能存在问题。
优点：表分布比较均匀。
缺点：扩充新的表很麻烦，所有数据都要重分布。

雪花算法

　　雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的主键的有序性。

核心思想：长度共64bit（一个long型）。首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截-开始时间截)，结果约等于69.73年。10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）。
优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

三、@TableField注解

MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致，如果不一致怎么解决呢？

3.1.场景一:

如果实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名，例如：实体类属性userName，表中字段user_name此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格，相当于在MyBatis中配置

3.2.场景二：

若实体类中的属性和表中的字段名不一致，例如实体类属性name，表中字段username，这时候就需要在实体类属性上使用@TableField("username")设置属性所对应的字段名

package com.augus.pojo;

import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@AllArgsConstructor
@NoArgsConstructor
@Data
public class User implements Serializable {
    //指定id对应的表中主键字段为uid，主键策略为自增
    //@TableId(value = "uid", type = IdType.AUTO)
    @TableId(value = "uid")
    private Long id;
    @TableField(value = "user_name")
    private String name;
    private Integer age;
    private String email;
}