04.MyBatis-Plus常用注解

Leefs 2022-12-19 PM 1721℃ 0条

[TOC]

### 一、@TableName

> 经过以上的测试，在使用MyBatis-Plus实现基本的CRUD时，我们并没有指定要操作的表，只是在 Mapper接口继承BaseMapper时，设置了泛型User，而操作的表为user表。
>
> 由此得出结论，MyBatis-Plus在确定操作的表时，由BaseMapper的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致。

#### 1.1 问题

> **若实体类类型的类名和要操作的表的表名不一致，会出现什么问题？**

+ 我们将表`user`更名为`t_user`，测试查询功能

![04.MyBatis-Plus常用注解01.png](https://lilinchao.com/usr/uploads/2022/12/394010177.png)

+ 程序抛出异常，`Table ‘mybatis_plus.user’ doesn’t exist`，因为现在的表名为`t_user`，而默认操作的表名和实体类型的类名一致，即`user`表。

![04.MyBatis-Plus常用注解02.png](https://lilinchao.com/usr/uploads/2022/12/3263266194.png)

#### 1.2 通过@TableName解决问题

在实体类类型上添加`@TableName("t_user")`，标识实体类对应的表，即可成功执行`SQL`语句。

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
//@TableName(value = "t_user")
public class User {

private Long id;
    private String name;
    private Integer age;
    private String email;
}
```

#### 1.3 通过GlobalConfig解决问题

在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如`t_`或`tbl_`

此时，可以使用`MyBatis-Plus`提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过`@TableName`标识实体类对应的表。

**方式一**

在yml配置文件中增加全局配置

```yaml
mybatis-plus:
  configuration:
    # 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      #配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_
```

**方式二**

在核心配置文件 `mybatis-config.xml`，中添加如下配置

```xml
<bean class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
	<property name="configLocation" value="classpath:mybatis-config.xml"></property>
	<property name="dataSource" ref="dataSource"></property>
	<property name="typeAliasesPackage" value="com.atguigu.mp.pojo"></property>
	
	<property name="globalConfig" ref="globalConfig"></property>
</bean>
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
    <property name="dbConfig">
        <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig">
            
            <property name="tablePrefix" value="t_"></property>
        </bean>
    </property>
</bean>
```

#### 1.4 总结

> `@TableName`：**表名注解，映射数据库的表名**。
>
> - **使用位置**：实体类
> - **使用场景：**当我们的**实体类名**跟我们的**数据库表名**不一致时，可根据**@TableName**来指定数据库表名。

**属性说明**

| 属性             | 类型     | 必须指定 | 默认值 | 描述                                                         |
| :--------------- | :------- | :------- | :----- | :----------------------------------------------------------- |
| value            | String   | 否       | ""     | 表名                                                         |
| schema           | String   | 否       | ""     | schema                                                       |
| keepGlobalPrefix | boolean  | 否       | false  | 是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时） |
| resultMap        | String   | 否       | ""     | xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）   |
| autoResultMap    | boolean  | 否       | false  | 是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入） |
| excludeProperty  | String[] | 否       | {}     | 需要排除的属性名 @since 3.3.1                                |

### 二、@TableId

> 经过以上的测试，`MyBatis-Plus`在实现`CRUD`时，会默认将`id`作为主键列，并在插入数据时，默认基于雪花算法的策略生成`id`

#### 2.1 问题

> **若实体类和表中表示主键的不是id，而是其他字段，例如uid，MyBatis-Plus会自动识别uid为主键列吗？**

+ 我们实体类中的属性`id`改为`uid`，将表中的字段`id`也改为`uid`，测试添加功能。

![04.MyBatis-Plus常用注解03.png](https://lilinchao.com/usr/uploads/2022/12/1118384584.png)

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

private Long uid;
    private String name;
    private Integer age;
    private String email;
}
```

+ 程序抛出异常，`Field ‘uid’ doesn’t have a default value`，说明MyBatis-Plus没有将`uid`作为主键赋值。

![04.MyBatis-Plus常用注解04.png](https://lilinchao.com/usr/uploads/2022/12/1971747373.png)

#### 2.2 通过@TableId解决问题

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

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

@TableId    //将属性所对应的字段指定为主键
    private Long uid;
    private String name;
    private Integer age;
    private String email;
}
```

#### 2.3 @TableId两个属性

##### （1）value属性

+ 若实体类中主键对应的属性为 id，而表中表示主键的字段为uid。

![04.MyBatis-Plus常用注解05.png](https://lilinchao.com/usr/uploads/2022/12/3954453068.png)

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

@TableId    //将属性所对应的字段指定为主键
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
```

+ 此时若只在属性 id 上添加注解 @TableId，则抛出异常`Unknown column ‘id’ in ‘field list’`。

![04.MyBatis-Plus常用注解06.jpg](https://lilinchao.com/usr/uploads/2022/12/1672919765.jpg)

此时 MyBatis-Plus 仍然会将 id 作为表的主键操作，而表中表示主键的是字段 uid 此时需要通过`@TableId`注解的value属性，指定表中的主键字段，`@TableId("uid")`或`@TableId(value="uid")`。

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

//将属性所对应的字段指定为主键
    //value属性用于指定主键的字段
    @TableId(value = "uid")
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
```

##### （2）type属性

> **type 属性用来定义主键策略：默认雪花算法**

**常用的主键策略**：

| 值                | 描述                                                         |
| ----------------- | ------------------------------------------------------------ |
| AUTO              | 使用数据库的自增策略，注意，该类型请确保数据库设置了id自增   |
| NONE              | 无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT） |
| INPUT             | 插入前自行设置主键值                                         |
| ASSIGN_ID（默认） | 默认策略，使用雪花算法自动生成主键 ID，主键类型为整形或字符串。<br/>（雪花算法：Twitter开源的分布式 ID 生成算法，使用一个64位的 Long 类型数字作为全局唯一 ID。在分布式系统中的应用十分广泛，且 ID 引入了时间戳，基本上保持自增） |
| ASSIGN_UUID       | 自动生成排除中划线的 UUID 作为主键，主键类型为字符串。       |

**设置自增主键**：

> 1. 数据库设置主键递增
> 2. 使用@TableId注解的type属性为IdType.AUTO

```java
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_users")
public class User {

@TableId(value = "uid",type = IdType.AUTO) //将当前属性所对应的字段作为主键
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
```

**全局配置主键生成策略**

**方式一**

在yml配置文件中增加全局配置

```yaml
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
```

**方式二**

在核心配置文件 `mybatis-config.xml`，中添加如下配置

#### 2.4 雪花算法

##### 1、背景

需要选择合适的方案去应对数据规模的增长，以应对逐渐增长的访问压力和数据量。

数据库的扩展方式主要包括：业务分库、主从复制，数据库分表。

##### 2、数据库分表

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

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

**示意图如下**：

![04.MyBatis-Plus常用注解06.png](https://lilinchao.com/usr/uploads/2022/12/2217553928.png)

- **垂直分表**

垂直分表适合将表中某些不常用且占了大量空间的列拆分出去

- **水平分表**

水平分表适合表行数特别大的表，有的公司要求单表行数超过 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 的子表中。

**复杂点**

初始表数量的确定。表数量太多维护比较麻烦，表数量太少又可能导致单表性能存在问题。

**优缺点**

+ **优点**：表分布比较均匀。

+ **缺点**：扩充新的表很麻烦，所有数据都要重分布。

##### 3、雪花算法

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

> **核心思想**

长度共64bit（一个long型）。

+ 首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。

+ 41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。

+ 10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。

+ 12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）

![04.MyBatis-Plus常用注解07.png](https://lilinchao.com/usr/uploads/2022/12/3978905233.png)

优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

### 三、@TbaleField

> 经过以上的测试，我们可以发现，MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致。
>
> 如果实体类中的属性名和字段名不一致的情况，会出现什么问题呢？

#### 3.1 情况一

若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格。

例如实体类属性`userName`，表中字段`user_name`。

+ **表中字段**

![04.MyBatis-Plus常用注解08.png](https://lilinchao.com/usr/uploads/2022/12/315072431.png)

+ **User实体类**

```java
private String userName;
```

此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格，相当于在MyBatis中配置。

#### 3.2 情况二

若实体类中的属性和表中的字段不满足情况1

例如实体类属性`name`，表中字段`username`

+ **表中字段**

![04.MyBatis-Plus常用注解09.png](https://lilinchao.com/usr/uploads/2022/12/3861206793.png)

+ **User实体类**

```java
private String name;
```

此时需要在实体类属性上使用`@TableField("username")`设置属性所对应的字段名

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

//将属性所对应的字段指定为主键
    //value属性用于指定主键的字段
    @TableId(value = "uid")
    private Long id;
    @TableField("username") //指定属性所对应的字段名
    private String name;
    private Integer age;
    private String email;
}
```

#### 3.3 属性说明

> + **@TableField作用**：在属性和列名不同的情况下，指定映射关系
>
> + **位置**：非主键属性上方

**属性值**

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

**FieldStrategy 属性**

**FieldFill属性值**

### 四、@TableLogic

#### 4.1 逻辑删除

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

#### 4.2 实现逻辑删除

**（1）数据库中创建逻辑删除状态列，设置默认值为0**

![04.MyBatis-Plus常用注解10.jpg](https://lilinchao.com/usr/uploads/2022/12/1894190458.jpg)

**（2）实体类中添加逻辑删除属性**

```java
@Data //lombok注解
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user") //设置实体类对应的表名
public class User {

//将属性所对应的字段指定为主键
    //value属性用于指定主键的字段
    @TableId(value = "uid")
    private Long id;
    private String name;
    private Integer age;
    private String email;

@TableLogic
    private int isDeleted;
}
```

**（3）测试删除功能**

```java
@Test
public void testDeleteById() {
    //通过id删除用户信息
    int result = userMapper.deleteById(1604678366476881922L); //ID为long类型，后面需要跟L进行标识
    System.out.println("受影响行数：" + result);
}
```

**运行结果**

```
==>  Preparing: UPDATE t_user SET is_deleted=1 WHERE uid=? AND is_deleted=0
==> Parameters: 1604678366476881922(Long)
<==    Updates: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4fc142ec]
受影响行数：1
```

删除功能，真正执行的是修改操作。

**（4）测试查询功能**

```java
@Test
public void testSelectById(){
    //根据id查询用户信息
    User user = userMapper.selectById(4L);
    System.out.println(user);
}
```

**运行结果**

```
==>  Preparing: SELECT uid AS id,name,age,email,is_deleted FROM t_user WHERE uid=? AND is_deleted=0
==> Parameters: 4(Long)
<==    Columns: id, name, age, email, is_deleted
<==        Row: 4, admin, 22, test4@baomidou.com, 0
<==      Total: 1
```

在进行查询操作时，会默认在末尾拼接上条件`AND is_deleted=0`，只查询未删除的数据。

*附参考文章链接*

*《尚硅谷MyBatisPlus教程》*

标签: MyBatis, MyBatis-Plus

非特殊说明，本博所有文章均为博主原创。

如若转载，请注明出处：https://lilinchao.com/archives/2694.html

上一篇 03.MyBatis-Plus基本CRUD

下一篇 05.MyBatis-Plus条件构造器和常用接口

04.MyBatis-Plus常用注解

评论已关闭

栏目分类

标签云

友情链接申请

04.MyBatis-Plus常用注解

评论已关闭

 栏目分类

标签云

友情链接申请

栏目分类

标签云

友情链接申请