快捷導(dǎo)航

Mybatis-Plus自動(dòng)填充更新操作相關(guān)字段的實(shí)現(xiàn)

更新時(shí)間：2021年11月09日 11:42:35 作者：honvin_

數(shù)據(jù)庫表中應(yīng)該都要有create_time、update_time字段；那么在開發(fā)中，對(duì)于這些共有字段的處理應(yīng)該要進(jìn)行統(tǒng)一，這樣就可以簡化我們的開發(fā)過程。那么本文就對(duì)Mybatis-Plus中的字段自動(dòng)填充進(jìn)行記錄

在阿里開發(fā)手冊(cè)的建表規(guī)約中有說明，數(shù)據(jù)庫表中應(yīng)該都要有create_time、update_time字段；那么在開發(fā)中，對(duì)于這些共有字段的處理應(yīng)該要進(jìn)行統(tǒng)一，這樣就可以簡化我們的開發(fā)過程。那么本文就對(duì)Mybatis-Plus中的字段自動(dòng)填充進(jìn)行記錄。

場景介紹

在項(xiàng)目的數(shù)據(jù)表設(shè)計(jì)中，每張表都有create_id、create_time、update_id、update_time這四個(gè)字段，那么在Java應(yīng)用中，針對(duì)新增和修改操作要對(duì)這四個(gè)字段進(jìn)行相應(yīng)的更改：

create_id、update_id要自動(dòng)填充為當(dāng)前登錄的用戶ID
create_time、update_time要自動(dòng)填充為當(dāng)前時(shí)間

下面說說代碼實(shí)現(xiàn)：

自動(dòng)填充處理器

需要實(shí)現(xiàn)Mybatis-Plus中的MetaObjectHandler接口

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import hw.topevery.basis.runtime.UserRuntime;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.util.Objects;

/**
 * 更新相關(guān)字段處理器
 *
 * @author whw
 * @date 2020/1/3 16:41
 */
@Component
public class UpdateRelatedFieldsMetaHandler implements MetaObjectHandler {

    /**
     * 新增操作
     *
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createId", String.class, getCurrentUserId());
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
        this.strictInsertFill(metaObject, "updateId", String.class, getCurrentUserId());
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

    /**
     * 更新操作
     *
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateId", String.class, getCurrentUserId());
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }

    /**
     * 獲取當(dāng)前登錄用戶ID
     *
     * @return
     */
    private String getCurrentUserId() {
        return "當(dāng)前登錄用戶ID";
    }
}

Mybatis-Plus配置類

需要將處理器注入進(jìn)Spring容器才會(huì)生效

import com.baomidou.mybatisplus.core.config.GlobalConfig;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import hw.topevery.kunming.wapi.handler.UpdateRelatedFieldsMetaHandler;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Mybatis-Plus配置類
 *
 * @author whw
 * @date 2020/1/3 16:41
 */
@Configuration
public class MybatisPlusConfig {

    @Bean
    public GlobalConfig globalConfig() {
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setMetaObjectHandler(new UpdateRelatedFieldsMetaHandler());
        return globalConfig;
    }
}

配置實(shí)體類中相關(guān)字段的自動(dòng)填充策略

在@TableField注解中設(shè)置fill屬性

字段填充策略FieldFill說明

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

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 基礎(chǔ)實(shí)體類
 *
 * @author whw
 * @date 2020/1/3 17:37
 */
@Data
public class BaseEntity implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "創(chuàng)建用戶ID")
    @TableField(value = "c_create_id", fill = FieldFill.INSERT)
    private String createId;

    @ApiModelProperty(value = "創(chuàng)建時(shí)間")
    @TableField(value = "c_create_time", fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    @ApiModelProperty(value = "更新用戶ID")
    @TableField(value = "c_update_id", fill = FieldFill.INSERT_UPDATE)
    private String updateId;

    @ApiModelProperty(value = "更新時(shí)間")
    @TableField(value = "c_update_time", fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
}

我這邊是在實(shí)體中抽取了一個(gè)父類出來，當(dāng)然也可以直接在實(shí)體類的對(duì)應(yīng)字段上添加注解。

到此這篇關(guān)于MyBatis-Plus實(shí)現(xiàn)字段自動(dòng)填充功能的示例的文章就介紹到這了,更多相關(guān)MyBatis-Plus 字段自動(dòng)填充內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: