快捷導(dǎo)航

在MyBatisPlus中使用@TableField完成字段自動(dòng)填充的操作

更新時(shí)間：2021年02月03日 11:31:14 作者：BADAO_LIUMANG_QIZHI

這篇文章主要介紹了在MyBatisPlus中使用@TableField完成字段自動(dòng)填充的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

場(chǎng)景

官方文檔：

字段注解 @TableField

com.baomidou.mybatisplus.annotations.TableField

值	描述
value	字段值（駝峰命名方式，該值可無(wú)）
update	預(yù)處理 set 字段自定義注入
condition	預(yù)處理 WHERE 實(shí)體條件自定義運(yùn)算規(guī)則
el	詳看注釋說(shuō)明
exist	是否為數(shù)據(jù)庫(kù)表字段（默認(rèn) true 存在，false 不存在）
strategy	字段驗(yàn)證（默認(rèn) 非 null 判斷，查看 com.baomidou.mybatisplus.enums.FieldStrategy ）
fill	字段填充標(biāo)記（ FieldFill, 配合自動(dòng)填充使用）

字段填充策略 FieldFill

值	描述
DEFAULT	默認(rèn)不處理
INSERT	插入填充字段
UPDATE	更新填充字段
INSERT_UPDATE	插入和更新填充字段

實(shí)現(xiàn)

實(shí)體類中有如下屬性，通過(guò)上面的自動(dòng)填充屬性，我們可以實(shí)現(xiàn)

在進(jìn)行插入操作時(shí)對(duì)

添加了注解@TableField(fill = FieldFill.INSERT)

的字段進(jìn)行自動(dòng)填充。

對(duì)添加了注解@TableField(fill = FieldFill.INSERT_UPDATE)

的字段在進(jìn)行插入和更新時(shí)進(jìn)行自動(dòng)填充。

 /**
   * 創(chuàng)建人
   */
  @TableField(fill = FieldFill.INSERT)
  private Long creatorId;
 
  /**
   * 創(chuàng)建時(shí)間
   */
  @TableField(fill = FieldFill.INSERT)
  private Date gmtCreat;
 
  /**
   * 修改人
   */
  @TableField(fill = FieldFill.INSERT_UPDATE)
  private Long modifierId;
 
  /**
   * 修改時(shí)間
   */
  @TableField(fill = FieldFill.INSERT_UPDATE)
  private Date gmtModified;
 
  /**
   * 是否可用
   */
  @TableField(fill = FieldFill.INSERT)
  private Boolean availableFlag;

這樣我們?cè)诰唧w業(yè)務(wù)中對(duì)實(shí)體類進(jìn)行賦值就可以不用對(duì)這些公共字段進(jìn)行賦值，在執(zhí)行插入或者更新時(shí)就能自動(dòng)賦值并插入數(shù)據(jù)庫(kù)。

那么要自動(dòng)賦的值在哪里配置？

在項(xiàng)目的config包下新建自動(dòng)填充處理類使其實(shí)現(xiàn)接口MetaObjectHandler

并重寫(xiě)其方法：

package com.ws.api.config;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
 
/**
 * 自動(dòng)填充處理類
 * @author badao
 * @version 1.0
 * @see
 **/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
  @Override
  public void insertFill(MetaObject metaObject) {
    this.setFieldValByName("modifierId", new Long(111), metaObject);
    this.setFieldValByName("gmtModified", new Date(), metaObject);
    this.setFieldValByName("creatorId", new Long(111), metaObject);
    this.setFieldValByName("gmtCreat",new Date(), metaObject);
    this.setFieldValByName("availableFlag",true, metaObject);  
  }
 
  @Override
  public void updateFill(MetaObject metaObject) {
    this.setFieldValByName("modifierId", new Long(111), metaObject);
    this.setFieldValByName("gmtModified", new Date(), metaObject);
  }
}

其中方法參數(shù)中第一個(gè)是前面自動(dòng)填充所對(duì)應(yīng)的字段，第二個(gè)是要自動(dòng)填充的值。

補(bǔ)充：Mybatis-Plus里 @TableField注解自動(dòng)賦值功能的配置類

package com.jt.auto;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
//完成自動(dòng)填充功能
@Component //將該對(duì)象交給spring容器管理
public class MyMetaObjectHandler implements MetaObjectHandler {
  /**
   * 在POJO中添加了 新增/更新的注解,但是必須在數(shù)據(jù)庫(kù)的字段中完成賦值的操作.
   * 所以.必須明確,新增/更新時(shí)操作的是哪個(gè)字段,及值是多少
   * * * @param metaObject
   */
  @Override
  public void insertFill(MetaObject metaObject) {
    this.setInsertFieldValByName("created", new Date(), metaObject);
    this.setInsertFieldValByName("updated", new Date(), metaObject);
  }
  @Override
  public void updateFill(MetaObject metaObject) {
    this.setUpdateFieldValByName("updated", new Date(), metaObject);
  }
}

@TableField注解完成自動(dòng)填充賦值使用案例：

package com.jt.pojo;
import java.io.Serializable;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;
import lombok.experimental.Accessors;
//pojo基類，完成2個(gè)任務(wù)，2個(gè)日期，實(shí)現(xiàn)序列化
@Data
@Accessors(chain=true)
public class BasePojo implements Serializable{
 @TableField(fill = FieldFill.INSERT) //新增有效
 private Date created;
 @TableField(fill = FieldFill.INSERT_UPDATE) //新增和更新有效
 private Date updated;
}

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教。

您可能感興趣的文章: