【Mybatis-plus】注解

Metadata

title: 【Mybatis-plus】 注解
date: 2023-01-21 18:52
tags:
  - 行动阶段/完成
  - 主题场景/组件
  - 笔记空间/KnowladgeSpace/ProgramSpace/ModuleSpace
  - 细化主题/Module/Mybatis-plus
categories:
  - Mybatis-plus
keywords:
  - Mybatis-plus
description: 【Mybatis-plus】 注解

【Mybatis-plus】注解

@TableName

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

@TableName("sys_user")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

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

关于 autoResultMap 的说明：

MP 会自动构建一个 resultMap 并注入到 MyBatis 里（一般用不上），请注意以下内容：

因为 MP 底层是 MyBatis，所以 MP 只是帮您注入了常用 CRUD 到 MyBatis 里，注入之前是动态的（根据您的 Entity 字段以及注解变化而变化），但是注入之后是静态的（等于 XML 配置中的内容）。

而对于 typeHandler 属性，MyBatis 只支持写在 2 个地方:

定义在 resultMap 里，作用于查询结果的封装
定义在 insert 和 update 语句的 #{property} 中的 property 后面（例：#{property,typehandler=xxx.xxx.xxx}），并且只作用于当前 设置值

除了以上两种直接指定 typeHandler 的形式，MyBatis 有一个全局扫描自定义 typeHandler 包的配置，原理是根据您的 property 类型去找其对应的 typeHandler 并使用。

@TableId

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

@TableName("sys_user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

属性	类型	必须指定	默认值	描述
value	String	否	.”‘	主键字段名
type	Enum	否	IdType.NONE	指定主键类型

IdType

值	描述
AUTO	数据库 ID自增
NONE	无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）
INPUT	insert 前自行 set 主键值
ASSIGN_ID	分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口`IdentifierGenerator`的方法`nextId`(默认实现类为`DefaultIdentifierGenerator`雪花算法)
ASSIGN_UUID	分配 UUID,主键类型为 String(since 3.3.0),使用接口`IdentifierGenerator`的方法`nextUUID`(默认 default 方法)
~~ID_WORKER~~	分布式全局唯一 ID 长整型类型(please use `ASSIGN_ID`)
~~UUID~~	32 位 UUID 字符串(please use `ASSIGN_UUID`)
~~ID_WORKER_STR~~	分布式全局唯一 ID 字符串类型(please use `ASSIGN_ID`)

@TableField

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

@TableName("sys_user")
public class User {
    @TableId
    private Long id;
    @TableField("nickname")
    private String name;
    private Integer age;
    private String email;
}

属性	类型	必须指定	默认值	描述
value	String	否	“”	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	“”	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#

【Mybatis-plus】 注解

Metadata

【Mybatis-plus】 注解

@TableName

@TableId

IdType

@TableField

【Mybatis-plus】注解

【Mybatis-plus】注解