4.mybatis-plus-常用注解

野性酷女 2024-03-23 12:44 66阅读 0赞

### 1.@TableName ###

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

> 将数据库中`user`表更名为`mp_user`

@TableName("mp_user")
    public class User {
        
        private Long id;
        private String name;
        private Integer age;
        private String email;
    }
    
    # 或者配置mybatis-plus全局配置
    mybatis-plus:
      configuration:
        # 日志
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
        #开启映射时驼峰命名
        map-underscore-to-camel-case: true
      # 设置mybatis-plus全局配置
      global-config:
        db-config:
          # 设置表名前缀
          table-prefix: mp_

**参数说明**

**关于 `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 ###

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

> 将`mp_user`表中`id`字段更改`uid`，`mybatis-plus`默认主键字段为`id`，不是`id`的话需要指定添加`@TableId`注解指定为主键

public class User {
        
        # 将字段uid映射为id,将数据库中设置为自增可以使用IdType
        @TableId(value = "uid",type = IdType.AUTO)
        private Long  id;
        private String name;
        private Integer age;
        private String email;
    }

> 默认自增为`雪花算法`，可通过注解`@TableId`实现，也可以通过全局配置配置主键生成策略
> 
>     mybatis-plus:
>     global-config:
>      db-config:
>        # 设置统一的主键生成策略
>        id-type: auto

**参数说明**

#### 1.@IdType ####

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

### 3.@TableField ###

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

> 将`mp_user`表中`name`字段更改`user_name`，添加`@TableField`注解将`user_name`映射为`name`

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

**参数说明**

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

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

#### 1.@ieldStrategy ####

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

#### 2.FieldFill ####

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

**实现元对象处理器接口**

@Data
    public class User {
        
        ......
            
        @TableField(value="create_time",fill = FieldFill.INSERT)
        private Date createTime;
    
        @TableField(value="update_time",fill = FieldFill.INSERT_UPDATE)
        private Date updateTime;
    }
    
    @Component
    public class MyObjectHandler implements MetaObjectHandler {
        
        @Override
        public void insertFill(MetaObject metaObject) {
        
    		//添加时填充的数据
            ......
            this.setFieldValByName("createTime", new Date(), metaObject);
            this.setFieldValByName("updateTime", new Date(), metaObject);
        }
    }

### 4.@Version ###

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

\**数据库中添加version字段\**

ALTER TABLE `user` ADD COLUMN `version` INT

**实体类添加version字段并添加 @Version 注解**

@Version
        @TableField(fill = FieldFill.INSERT)
        private Integer version;

**元对象处理器接口添加version的insert默认值**

@Component
    public class MyObjectHandler implements MetaObjectHandler {
        
        @Override
        public void insertFill(MetaObject metaObject) {
        
    		//添加时填充的数据
            ......
            this.setFieldValByName("version", 1, metaObject);
        }
    }

**特别说明:**

*  支持的数据类型只有 `int,Integer,long,Long,Date,Timestamp,LocalDateTime`
 *  整数类型下 `newVersion = oldVersion + 1`
 *  `newVersion` 会回写到 `entity` 中
 *  仅支持 `updateById(id)` 与 `update(entity, wrapper)` 方法
    
    在 `update(entity, wrapper)` 方法下, `wrapper` 不能复用!!!

**在 MybatisPlusConfig 中注册 Bean**

> 创建配置类

@EnableTransactionManagement
    @Configuration
    @MapperScan("com.atguigu.mybatis_plus.mapper")
    public class MyOptimisticLockerInterceptor {
    
        /**
         * 乐观锁插件
         */
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor() {
            return new OptimisticLockerInterceptor();
        }
    }

# 测试
        
    /**
     * 测试 乐观锁插件
     */
    @Test
    public void testOptimisticLocker() {
        
    
        //查询
        User user = userMapper.selectById(1L);
        //修改数据
        user.setName("Helen Yao");
        user.setEmail("helen@qq.com");
        //执行更新
        userMapper.updateById(user);
    }

### 5.@EnumValue ###

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

### 6.@TableLogic ###

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

**数据库中添加 deleted字段**

手动添加在数据库中可添加字段`is_deleted`，数据类型为`int`，默认值为`0`
    # 或
    ALTER TABLE `user` ADD COLUMN `deleted` boolean

**实体类添加deleted字段**

> 并加上 `@TableLogic` 注解 和 `@TableField(fill = FieldFill.INSERT)` 注解

@TableLogic
        @TableField(fill = FieldFill.UPDATE)
        private Integer isDeleted;

**元对象处理器接口添加deleted的insert默认值**

@Component
    public class MyObjectHandler implements MetaObjectHandler {
        
        @Override
        public void insertFill(MetaObject metaObject) {
        
    		//添加时填充的数据
    		//0-未删除  1-已删除
            ......
            this.setFieldValByName("is_deleted", 0, metaObject);
        }
    }
    
    
    @Component
    public class MpInterceptor {
        
    
         /**
         * 创建乐观锁拦截器，存入Spring容器
         * 拦截生成的sql语句，注入版本号的字段
         */
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        
            return new OptimisticLockerInterceptor();
        }
    }

**全局配置**

mybatis-plus:
        global-config:
            db-config:
                # version
                logic-delete-field: is_deleted # 全局逻辑删除的实体字段名
                logic-delete-value: 1 # 逻辑已删除值(默认为 1)
                logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

### 7.@KeySequence ###

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

### 8.@InterceptorIgnore ###

### 9.@OrderBy ###

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