mybatisPlus的註解

實體類

@TableName(opens new window)

• 描述：表名註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果設置了全局 tablePrefix 且自行設置了 value 的值)
resultMap	String	否	""	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自動構建 resultMap 並使用(如果設置 resultMap 則不會進行 resultMap 的自動構建並注入)
excludeProperty	String[]	否	{}	需要排除的屬性名(@since 3.3.1)

關於`autoResultMap`的說明:

mp會自動構建一個ResultMap並注入到mybatis裏(一般用不上).下面講兩句: 因爲mp底層是mybatis,所以一些mybatis的常識你要知道,mp只是幫你注入了常用crud到mybatis裏 注入之前可以說是動態的(根據你entity的字段以及註解變化而變化),但是注入之後是靜態的(等於你寫在xml的東西) 而對於直接指定typeHandler,mybatis只支持你寫在2個地方:

1. 定義在resultMap裏,只作用於select查詢的返回結果封裝
2. 定義在insert和updatesql的#{property}裏的property後面(例:#{property,typehandler=xxx.xxx.xxx}),只作用於設置值 而除了這兩種直接指定typeHandler,mybatis有一個全局的掃描你自己的typeHandler包的配置,這是根據你的property的類型去找typeHandler並使用.

#@TableId

#註解

介紹 MybatisPlus 註解包相關類詳解(更多詳細描述可點擊查看源碼註釋)

註解類包：

👉 mybatis-plus-annotation(opens new window)

#@TableName(opens new window)

• 描述：表名註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果設置了全局 tablePrefix 且自行設置了 value 的值)
resultMap	String	否	""	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自動構建 resultMap 並使用(如果設置 resultMap 則不會進行 resultMap 的自動構建並注入)
excludeProperty	String[]	否	{}	需要排除的屬性名(@since 3.3.1)

關於`autoResultMap`的說明:

mp會自動構建一個ResultMap並注入到mybatis裏(一般用不上).下面講兩句: 因爲mp底層是mybatis,所以一些mybatis的常識你要知道,mp只是幫你注入了常用crud到mybatis裏 注入之前可以說是動態的(根據你entity的字段以及註解變化而變化),但是注入之後是靜態的(等於你寫在xml的東西) 而對於直接指定typeHandler,mybatis只支持你寫在2個地方:

1. 定義在resultMap裏,只作用於select查詢的返回結果封裝
2. 定義在insert和updatesql的#{property}裏的property後面(例:#{property,typehandler=xxx.xxx.xxx}),只作用於設置值 而除了這兩種直接指定typeHandler,mybatis有一個全局的掃描你自己的typeHandler包的配置,這是根據你的property的類型去找typeHandler並使用.

#@TableId(opens new window)

• 描述：主鍵註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	主鍵字段名
type	Enum	否	IdType.NONE	主鍵類型

#IdType(opens new window)

值	描述
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)

#註解

介紹 MybatisPlus 註解包相關類詳解(更多詳細描述可點擊查看源碼註釋)

註解類包：

👉 mybatis-plus-annotation(opens new window)

#@TableName(opens new window)

• 描述：表名註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果設置了全局 tablePrefix 且自行設置了 value 的值)
resultMap	String	否	""	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自動構建 resultMap 並使用(如果設置 resultMap 則不會進行 resultMap 的自動構建並注入)
excludeProperty	String[]	否	{}	需要排除的屬性名(@since 3.3.1)

關於`autoResultMap`的說明:

mp會自動構建一個ResultMap並注入到mybatis裏(一般用不上).下面講兩句: 因爲mp底層是mybatis,所以一些mybatis的常識你要知道,mp只是幫你注入了常用crud到mybatis裏 注入之前可以說是動態的(根據你entity的字段以及註解變化而變化),但是注入之後是靜態的(等於你寫在xml的東西) 而對於直接指定typeHandler,mybatis只支持你寫在2個地方:

1. 定義在resultMap裏,只作用於select查詢的返回結果封裝
2. 定義在insert和updatesql的#{property}裏的property後面(例:#{property,typehandler=xxx.xxx.xxx}),只作用於設置值 而除了這兩種直接指定typeHandler,mybatis有一個全局的掃描你自己的typeHandler包的配置,這是根據你的property的類型去找typeHandler並使用.

#@TableId(opens new window)

• 描述：主鍵註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	主鍵字段名
type	Enum	否	IdType.NONE	主鍵類型

#IdType(opens new window)

值	描述
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(opens new window)

• 描述：字段註解(非主鍵)

屬性	類型	必須指定	默認值	描述
value	String	否	""	數據庫字段名
el	String	否	""	映射爲原生 #{ ... } 邏輯,相當於寫在 xml 裏的 #{ ... } 部分
exist	boolean	否	true	是否爲數據庫表字段
condition	String	否	""	字段 where 實體查詢比較條件,有值設置則按設置的值爲準,沒有則爲默認全局的 %s=#{%s},參考(opens new window)
update	String	否	""	字段 update set 部分注入, 例如：update="%s+1"：表示更新時會set version=version+1(該屬性優先級高於 el 屬性)
insertStrategy	Enum	N	DEFAULT	舉例：NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
updateStrategy	Enum	N	DEFAULT	舉例：IGNORED: update table_a set column=#{columnProperty}
whereStrategy	Enum	N	DEFAULT	舉例：NOT_EMPTY: 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	否	""	指定小數點後保留的位數

關於`jdbcType`和`typeHandler`以及`numericScale`的說明:

numericScale只生效於 update 的sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效於 update 的sql. 對於typeHandler如果你的字段類型和set進去的類型爲equals關係,則只需要讓你的typeHandler讓Mybatis加載到即可,不需要使用註解

#FieldStrategy(opens new window)

值	描述
IGNORED	忽略判斷
NOT_NULL	非NULL判斷
NOT_EMPTY	非空判斷(只對字符串類型字段,其他類型字段依然爲非NULL判斷)
DEFAULT	追隨全局配置

#FieldFill(opens new window)

值	描述
DEFAULT	默認不處理
INSERT	插入時填充字段
UPDATE	更新時填充字段
INSERT_UPDATE	插入和更新時填充字段

#註解

介紹 MybatisPlus 註解包相關類詳解(更多詳細描述可點擊查看源碼註釋)

註解類包：

👉 mybatis-plus-annotation(opens new window)

#@TableName(opens new window)

• 描述：表名註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	表名
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果設置了全局 tablePrefix 且自行設置了 value 的值)
resultMap	String	否	""	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自動構建 resultMap 並使用(如果設置 resultMap 則不會進行 resultMap 的自動構建並注入)
excludeProperty	String[]	否	{}	需要排除的屬性名(@since 3.3.1)

關於`autoResultMap`的說明:

mp會自動構建一個ResultMap並注入到mybatis裏(一般用不上).下面講兩句: 因爲mp底層是mybatis,所以一些mybatis的常識你要知道,mp只是幫你注入了常用crud到mybatis裏 注入之前可以說是動態的(根據你entity的字段以及註解變化而變化),但是注入之後是靜態的(等於你寫在xml的東西) 而對於直接指定typeHandler,mybatis只支持你寫在2個地方:

1. 定義在resultMap裏,只作用於select查詢的返回結果封裝
2. 定義在insert和updatesql的#{property}裏的property後面(例:#{property,typehandler=xxx.xxx.xxx}),只作用於設置值 而除了這兩種直接指定typeHandler,mybatis有一個全局的掃描你自己的typeHandler包的配置,這是根據你的property的類型去找typeHandler並使用.

#@TableId(opens new window)

• 描述：主鍵註解

屬性	類型	必須指定	默認值	描述
value	String	否	""	主鍵字段名
type	Enum	否	IdType.NONE	主鍵類型

#IdType(opens new window)

值	描述
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(opens new window)

• 描述：字段註解(非主鍵)

屬性	類型	必須指定	默認值	描述
value	String	否	""	數據庫字段名
el	String	否	""	映射爲原生 #{ ... } 邏輯,相當於寫在 xml 裏的 #{ ... } 部分
exist	boolean	否	true	是否爲數據庫表字段
condition	String	否	""	字段 where 實體查詢比較條件,有值設置則按設置的值爲準,沒有則爲默認全局的 %s=#{%s},參考(opens new window)
update	String	否	""	字段 update set 部分注入, 例如：update="%s+1"：表示更新時會set version=version+1(該屬性優先級高於 el 屬性)
insertStrategy	Enum	N	DEFAULT	舉例：NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
updateStrategy	Enum	N	DEFAULT	舉例：IGNORED: update table_a set column=#{columnProperty}
whereStrategy	Enum	N	DEFAULT	舉例：NOT_EMPTY: 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	否	""	指定小數點後保留的位數

關於`jdbcType`和`typeHandler`以及`numericScale`的說明:

numericScale只生效於 update 的sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效於 update 的sql. 對於typeHandler如果你的字段類型和set進去的類型爲equals關係,則只需要讓你的typeHandler讓Mybatis加載到即可,不需要使用註解

#FieldStrategy(opens new window)

值	描述
IGNORED	忽略判斷
NOT_NULL	非NULL判斷
NOT_EMPTY	非空判斷(只對字符串類型字段,其他類型字段依然爲非NULL判斷)
DEFAULT	追隨全局配置

#FieldFill(opens new window)

值	描述
DEFAULT	默認不處理
INSERT	插入時填充字段
UPDATE	更新時填充字段
INSERT_UPDATE	插入和更新時填充字段

#@Version(opens new window)

• 描述：樂觀鎖註解、標記 @Verison 在字段上

#@EnumValue(opens new window)

• 描述：通枚舉類註解(註解在枚舉字段上)

#@TableLogic(opens new window)

• 描述：表字段邏輯處理註解（邏輯刪除）

屬性	類型	必須指定	默認值	描述
value	String	否	""	邏輯未刪除值
delval	String	否	""	邏輯刪除值

#@SqlParser(opens new window)

see @InterceptorIgnore

#@KeySequence(opens new window)

• 描述：序列主鍵策略 oracle
• 屬性：value、resultMap

屬性	類型	必須指定	默認值	描述
value	String	否	""	序列名
clazz	Class	否	Long.class	id的類型, 可以指定String.class，這樣返回的Sequence值是字符串"1"

#@InterceptorIgnore(opens new window)

see 插件主體