Mybatis-Plus常见注解

Myth丶恋晨 2024-03-09 01:57 36阅读 0赞

**目录**

Mybatis-Plus常见注解

1、@TableName

2、@TableId

2.1 IdType

3、@TableField

4、@Version

5、@EnumValue

6、@TableLogic

7、@KeySequence

8、@OrderBy

--------------------

### Mybatis-Plus常见注解 ###

#### 1、@TableName ####

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

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

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

**关于 `autoResultMap` 的说明：**

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

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

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

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

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

#### 2、@TableId ####

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

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

##### 2.1 IdType #####

<table> 
 <tbody> 
  <tr> 
   <td>属性</td> 
   <td> <p>说明</p> </td> 
  </tr> 
  <tr> 
   <td>AUTO</td> 
   <td>数据库 ID 自增</td> 
  </tr> 
  <tr> 
   <td>NONE</td> 
   <td>无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT）</td> 
  </tr> 
  <tr> 
   <td>INPUT</td> 
   <td>insert 前自行 set 主键值</td> 
  </tr> 
  <tr> 
   <td>ASSIGN_ID</td> 
   <td>分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口<code>IdentifierGenerator</code>的方法<code>nextId</code>(默认实现类为<code>DefaultIdentifierGenerator</code>雪花算法)</td> 
  </tr> 
  <tr> 
   <td>ASSIGN_UUID</td> 
   <td>分配 UUID,主键类型为 String(since 3.3.0),使用接口<code>IdentifierGenerator</code>的方法<code>nextUUID</code>(默认 default 方法)</td> 
  </tr> 
 </tbody> 
</table>

#### 3、@TableField ####

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

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

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

注意：

关于\`jdbcType\`和\`typeHandler\`以及\`numericScale\`的说明:

`numericScale`只生效于 update 的 sql. `jdbcType`和`typeHandler`如果不配合`@TableName#autoResultMap = true`一起使用,也只生效于 update 的 sql. 对于`typeHandler`如果你的字段类型和 set 进去的类型为`equals`关系,则只需要让你的`typeHandler`让 Mybatis 加载到即可,不需要使用注解

FieldStrategy：

<table> 
 <tbody> 
  <tr> 
   <th>值</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>IGNORED</td> 
   <td>忽略判断</td> 
  </tr> 
  <tr> 
   <td>NOT_NULL</td> 
   <td>非 NULL 判断</td> 
  </tr> 
  <tr> 
   <td>NOT_EMPTY</td> 
   <td>非空判断(只对字符串类型字段,其他类型字段依然为非 NULL 判断)</td> 
  </tr> 
  <tr> 
   <td>DEFAULT</td> 
   <td>追随全局配置</td> 
  </tr> 
  <tr> 
   <td>NEVER</td> 
   <td>不加入SQL</td> 
  </tr> 
 </tbody> 
</table>

FieldFill：

<table> 
 <tbody> 
  <tr> 
   <th>值</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>DEFAULT</td> 
   <td>默认不处理</td> 
  </tr> 
  <tr> 
   <td>INSERT</td> 
   <td>插入时填充字段</td> 
  </tr> 
  <tr> 
   <td>UPDATE</td> 
   <td>更新时填充字段</td> 
  </tr> 
  <tr> 
   <td>INSERT_UPDATE</td> 
   <td>插入和更新时填充字段</td> 
  </tr> 
 </tbody> 
</table>

#### 4、@Version ####

描述：乐观锁注解、标记 `@Version` 在字段上

#### 5、@EnumValue ####

描述：普通枚举类注解(注解在枚举字段上)

#### 6、@TableLogic ####

描述：表字段逻辑处理注解（逻辑删除）

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必须指定</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>否</td> 
   <td>""</td> 
   <td>逻辑未删除值</td> 
  </tr> 
  <tr> 
   <td>delval</td> 
   <td>String</td> 
   <td>否</td> 
   <td>""</td> 
   <td>逻辑删除值</td> 
  </tr> 
 </tbody> 
</table>

#### 7、@KeySequence ####

*  描述：序列主键策略 `oracle`
 *  属性：value、dbType

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必须指定</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>否</td> 
   <td>""</td> 
   <td>序列名</td> 
  </tr> 
  <tr> 
   <td>dbType</td> 
   <td>Enum</td> 
   <td>否</td> 
   <td>DbType.OTHER</td> 
   <td>数据库类型，未配置默认使用注入 IKeyGenerator 实现，多个实现必须指定</td> 
  </tr> 
 </tbody> 
</table>

#### 8、@OrderBy ####

描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>类型</th> 
   <th>必须指定</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>isDesc</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>true</td> 
   <td>是否倒序查询</td> 
  </tr> 
  <tr> 
   <td>sort</td> 
   <td>short</td> 
   <td>否</td> 
   <td>Short.MAX_VALUE</td> 
   <td>数字越小越靠前</td> 
  </tr> 
 </tbody> 
</table>

参考：[注解 | MyBatis-Plus][_ MyBatis-Plus]

[_ MyBatis-Plus]: https://baomidou.com/pages/223848/#tablename