MyBatis-Plus 常用注解详解

ゝ一纸荒年。 2023-10-03 09:42 84阅读 0赞

@TableName

![abb436bf7018e2b45cbe9879d1f34da6.png][]

@TableId  
主键专属

比如数据中的表中的字段是id

但是实体类是userId

那么就需要在userId上打上这个注解

用法

设置主键映射 value映射主键字段的名字

type 设置主键类型 主键的生成策略 (圈起来的重要)

![8d46e6c6d9fc4626f8290dd269036b85.png][]

![f9bd61c7e0bac5058fdc42408c133b51.png][]

1 数据库自增 AUTO  
开发者无需赋值,自己根据当前表中id最大值自增+1

手动赋值的话还是使用数据库id中最大值+1 的方式赋予id

2 自动生成主键 使用雪花算法 NONE  
配合新增使用 用的时候需要注意主键长度 但是3.20的时候是采取该字段最大值+1

1.数据类型改int为long

2.数据库表的长度要改

需要注意生成的长度否则会报错

Caused by: org.apache.ibatis.reflection.ReflectionException:  
Could not set property 'id' of 'class com.lin.mybatisplus.pojo.User'  
with value '1289924709438889985' Cause: java.lang.IllegalArgumentException:  
argument type mismatch  
然后还需要修改数据类型,才能存进去

3 开发者手动赋值 INPUT  
如果插入操作中,没有对id进行赋值,那么存进数据库中的将为0(long)

数据库一般会采取自增id的方式处理 当前数据库编号的值+1

如果给定值了,就用给定的值

4 ASSIGN\_ID  
等同于ID\_ WORKER(3) ,ID\_ WORKER STR(3) ，

使用mp自动赋值 采取雪花算法,但是3.20的时候是采取该字段最大值+1

5 ASSIGN\_ID  
等同于UUID

要求主键类型必须是String类型,会自动生成UUID进行赋值

需要考虑数据库的字段设计,数据库中的int类型的,所以存不进去,但因为主键自增,如果要修改int类型为varchar类型的话,需要去除主键自增

@TableField  
非主键字段使用

比如数据中的表中的字段是name

但是实体类是userName

![3c2a34ae327a164fa0f94d476722e1ef.png][]

那么就需要在userName上打上这个注解

映射非主键字段 value映射字段名

exist 表示是否为是数据库字段  
在VO DTO的时候,经常会查询一些数据库中没有的字段,如果没有打上标签

![4d56078ee21c9c9624673e147ea402eb.png][]

那么查询会报错(如果实体类中的成员变脸在数据库中没有对应字段,可以视同)

需要设置为false

select 表示是否查询该字段  
加上不参与查询,并且返回null

![2239b8ef52590d7659c2f5198a031d51.png][]

fill 表示是否自动填充  
将对象存入数据的时候,由mybatisplus自动给某些字段赋值

![7a2dc0c6a9d40b27a36b67b5a5c1b48b.png][]

应用场景

create\_time update\_time

比如说注册的时间和修改时间是基本上每个表都会用到的,实现起来就是获取时间存入,

但是就是烦

那么就交给mp来做 (采取以下配置,并且需要创建处理器)

DEFAULT --默认不处理

INSERT --插入时填充字段(第一次添加的时候)

INSERT\_UPDATE --插入和更新时填充字段

(最近一次更新的时候,也就是插入和更新都满足)

UPDATE --更新时填充字段

![c758820ba62330fc63df75cc86180d05.png][]  
创建自动填充处理器

![35271fc1ebe813d8d9bfd69b98b5a708.png][]  
测试

@Version  
标记乐观锁 -主修改操作

\-防止数据被重复操作

\-防止两个线程同时操作同一个数据,保证数据的安全性

原理:

标记乐观锁，通过version字段来保证数据的安全性，当修改数据的时候,

会以version作为条件，当条件成立的时候才会修改成功。

version=1

线程1: update ... set version = 2 where version= 1

线程2: update ... set version = 2 where version= 1

解释:

随便一条线程操作成功version 改为2 那么另一条线程就执行失败

环境搭建:

1.数据库添加version字段 默认值1

![eaca6eb425a8eb608fa9e2103ad90ac7.png][]  
2.实体类添加version成员变量 天且添加@version

![b2ebf3887b42c71a0bcba7e4b7a90b16.png][]  
3.编写配置类

![e2465166af969ac4037088ae81bf384f.png][]

测试

![13122c0d004e9270eb557f76e9dee5ed.png][]

同时修改情况 -感兴趣的可以试一下

@EnumValue  
通用的枚举类注解,将数据库字段映射成实体类的枚举类型成员变量

意识:将枚举改成成员变量和数据库的字段映射起来,根据数据库字段的值找到对应枚举的对象

1.数据库添加状态字段

![56c31d15c6c4dd7b2937974198f0e04c.png][]  
2.新建枚举类

![65cd92dbe0d610c086c7e477bd7f4b25.png][]  
加入字段 -需要注意,一定要和数据库字段映射起

在配置文件中配置枚举包扫描  
@TableLogic

映射逻辑删除

常用注解  
@TableName：对数据表名注解

@TableId：表主键标识

@TableId(value = “id”, type = IdType.AUTO)：自增

@TableId(value = “id”, type = IdType.ID\_WORKER\_STR)：分布式全局唯一ID字符串类型

@TableId(value = “id”, type = IdType.INPUT)：自行输入

@TableId(value = “id”, type = IdType.ID\_WORKER)：分布式全局唯一ID 长整型类型

@TableId(value = “id”, type = IdType.UUID)：32位UUID字符串

@TableId(value = “id”, type = IdType.NONE)：无状态

@TableField：表字段标识

@TableField(exist = false)：表示该属性不为数据库表字段，但又是必须使用的。

@TableField(exist = true)：表示该属性为数据库表字段。

@TableField(condition = SqlCondition.LIKE)：表示该属性可以模糊搜索。

@TableField(fill = FieldFill.INSERT)：注解填充字段 ，生成器策略部分也可以配置！

@FieldStrategy：

@FieldFill

@Version：乐观锁注解、标记

@EnumValue：通枚举类注解

@TableLogic：表字段逻辑处理注解（逻辑删除）

@SqlParser：租户注解

[abb436bf7018e2b45cbe9879d1f34da6.png]: https://img-blog.csdnimg.cn/img_convert/abb436bf7018e2b45cbe9879d1f34da6.png
[8d46e6c6d9fc4626f8290dd269036b85.png]: https://img-blog.csdnimg.cn/img_convert/8d46e6c6d9fc4626f8290dd269036b85.png
[f9bd61c7e0bac5058fdc42408c133b51.png]: https://img-blog.csdnimg.cn/img_convert/f9bd61c7e0bac5058fdc42408c133b51.png
[3c2a34ae327a164fa0f94d476722e1ef.png]: https://img-blog.csdnimg.cn/img_convert/3c2a34ae327a164fa0f94d476722e1ef.png
[4d56078ee21c9c9624673e147ea402eb.png]: https://img-blog.csdnimg.cn/img_convert/4d56078ee21c9c9624673e147ea402eb.png
[2239b8ef52590d7659c2f5198a031d51.png]: https://img-blog.csdnimg.cn/img_convert/2239b8ef52590d7659c2f5198a031d51.png
[7a2dc0c6a9d40b27a36b67b5a5c1b48b.png]: https://img-blog.csdnimg.cn/img_convert/7a2dc0c6a9d40b27a36b67b5a5c1b48b.png
[c758820ba62330fc63df75cc86180d05.png]: https://img-blog.csdnimg.cn/img_convert/c758820ba62330fc63df75cc86180d05.png
[35271fc1ebe813d8d9bfd69b98b5a708.png]: https://img-blog.csdnimg.cn/img_convert/35271fc1ebe813d8d9bfd69b98b5a708.png
[eaca6eb425a8eb608fa9e2103ad90ac7.png]: https://img-blog.csdnimg.cn/img_convert/eaca6eb425a8eb608fa9e2103ad90ac7.png
[b2ebf3887b42c71a0bcba7e4b7a90b16.png]: https://img-blog.csdnimg.cn/img_convert/b2ebf3887b42c71a0bcba7e4b7a90b16.png
[e2465166af969ac4037088ae81bf384f.png]: https://img-blog.csdnimg.cn/img_convert/e2465166af969ac4037088ae81bf384f.png
[13122c0d004e9270eb557f76e9dee5ed.png]: https://img-blog.csdnimg.cn/img_convert/13122c0d004e9270eb557f76e9dee5ed.png
[56c31d15c6c4dd7b2937974198f0e04c.png]: https://img-blog.csdnimg.cn/img_convert/56c31d15c6c4dd7b2937974198f0e04c.png
[65cd92dbe0d610c086c7e477bd7f4b25.png]: https://img-blog.csdnimg.cn/img_convert/65cd92dbe0d610c086c7e477bd7f4b25.png