Mybatis-Plus公共字段填充

 commonFieldMetaObjectHandler 


@Slf4j
@Component
public class commonFieldMetaObjectHandler implements MetaObjectHandler {


    public commonFieldMetaObjectHandler() {
        log.info("启用 XXX Mybatis Plus 公共字段自动填充策略.");
    }
S

    private static final String DEPT_ID_COLUMN_NAME = "deptId";
    private static final String DO_NOT_USE_SYSTEM_TIME = "doNotUseSystemTime";



/**
 * 插入数据时填充创建时间和更新时间,以及创建人和部门信息。
 * 如果未设置不使用系统时间,则自动使用当前时间;如果未设置创建人和部门信息,则自动填充当前用户和部门信息。
 * 
 * @param metaObject 数据对象,用于检查和设置字段值。
 */
@Override
public void insertFill(MetaObject metaObject) {
    // 检查是否有设置创建时间、创建人、创建人姓名的setter方法
    boolean createTimePro = metaObject.hasSetter(GlobalConsts.PublicField.CREATE_TIME.getValue());
    boolean createUserPro = metaObject.hasSetter(GlobalConsts.PublicField.CREATE_USER.getValue());
    boolean createUserNamePro = metaObject.hasSetter(GlobalConsts.PublicField.CREATE_USER_NAME.getValue());

    // 如果三个字段的setter都存在
    if (BooleanUtil.and(createTimePro, createUserPro, createUserNamePro)) {
        // 获取创建时间和更新时间的值
        // insert时没有不使用系统时间那么由系统自动获取
        Object createTime = getFieldValByName(GlobalConsts.PublicField.CREATE_TIME.getValue(), metaObject);
        Object updateTime = getFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_TIME.getValue(), metaObject);
        // 检查是否使用系统时间,如果未设置不使用系统时间或不为"1",则使用当前时间
        Object doNotUseSystemTime = metaObject.hasSetter(DO_NOT_USE_SYSTEM_TIME) ? getFieldValByName(DO_NOT_USE_SYSTEM_TIME, metaObject) : null;
        if(ObjectUtil.isEmpty(createTime) || ObjectUtil.isEmpty(doNotUseSystemTime) || ObjectUtil.notEqual("1", String.valueOf(doNotUseSystemTime))){
            this.setFieldValByName(GlobalConsts.PublicField.CREATE_TIME.getValue(), LocalDateTime.now(), metaObject);
        }
        if(ObjectUtil.isEmpty(updateTime) || ObjectUtil.isEmpty(doNotUseSystemTime) || ObjectUtil.notEqual("1", String.valueOf(doNotUseSystemTime))){
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_TIME.getValue(), LocalDateTime.now(), metaObject);
        }
        // 检查是否有设置部门ID的setter方法
        boolean deptIdPro = metaObject.hasSetter(DEPT_ID_COLUMN_NAME);
        if(deptIdPro){
            Object deptId = getFieldValByName(DEPT_ID_COLUMN_NAME, metaObject);
            // 如果未设置部门ID,则使用当前用户所在部门的ID
            if(ObjectUtil.isEmpty(deptId)){
                this.setFieldValByName(DEPT_ID_COLUMN_NAME,UserUtil.getCurrentUser().getCurrentDeptId(),metaObject);
            }else{
                this.setFieldValByName(DEPT_ID_COLUMN_NAME,deptId, metaObject);
            }
        }
        // 获取创建人和创建人姓名的值
        Object createUser = getFieldValByName(GlobalConsts.PublicField.CREATE_USER.getValue(), metaObject);
        Object createUserName = getFieldValByName(GlobalConsts.PublicField.CREATE_USER_NAME.getValue(), metaObject);
        // 如果创建人和创建人姓名都未设置,则使用当前用户的信息
        // 如果创建人id和姓名都为空,则由系统获取当前用户,否则填充人为set的值
        if (ObjectUtil.isAllEmpty(createUser, createUserName)) {
            this.setFieldValByName(GlobalConsts.PublicField.CREATE_USER.getValue(), UserUtil.getCurrentUser().getUserId(), metaObject);
            this.setFieldValByName(GlobalConsts.PublicField.CREATE_USER_NAME.getValue(), UserUtil.getCurrentUser().getEmployeeName(), metaObject);

            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue(), UserUtil.getCurrentUser().getUserId(), metaObject);
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue(), UserUtil.getCurrentUser().getEmployeeName(), metaObject);
        } else {
            // 如果创建人和创建人姓名已设置,则用于更新最后更新人和姓名
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue(), createUser, metaObject);
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue(), createUserName, metaObject);
        }
    }
}

  /**
 * 更新实体对象的最后更新时间、最后更新人和最后更新人姓名字段。
 * 
 * 此方法用于在实体对象被更新时,自动设置最后更新时间,并根据条件设置最后更新人和姓名。
 * 如果最后更新人和姓名字段为空,则使用当前登录用户的ID和姓名填充。
 * 
 * @param metaObject 要更新的实体对象的元数据描述。
 */
@Override
public void updateFill(MetaObject metaObject) {
    // 检查实体对象是否有设置最后更新时间、最后更新人和最后更新人姓名的setter方法
    boolean lastUpdateTimePro = metaObject.hasSetter(GlobalConsts.PublicField.LAST_UPDATE_TIME.getValue());
    boolean lastUpdateUserPro = metaObject.hasSetter(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue());
    boolean lastUpdateUserNamePro = metaObject.hasSetter(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue());
    
    // 当所有相关字段都有setter方法时,执行更新操作
    if (BooleanUtil.and(lastUpdateTimePro, lastUpdateUserPro, lastUpdateUserNamePro)) {
        // 设置最后更新时间为当前时间
        // update时默认更新时间由系统自动获取
        this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_TIME.getValue(), LocalDateTime.now(), metaObject);

        // 获取当前设置的最后更新人和姓名
        Object lastUpdateUser = getFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue(), metaObject);
        Object lastUpdateUserName = getFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue(), metaObject);
        
        // 如果当前的最后更新人和姓名都为空,则使用当前登录用户的ID和姓名填充
        if (ObjectUtil.isAllEmpty(lastUpdateUser, lastUpdateUserName)) {
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue(), UserUtil.getCurrentUser().getUserId(), metaObject);
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue(), UserUtil.getCurrentUser().getEmployeeName(), metaObject);
        }else {
            // 否则,使用已设置的最后更新人和姓名
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER.getValue(), lastUpdateUser, metaObject);
            this.setFieldValByName(GlobalConsts.PublicField.LAST_UPDATE_USER_NAME.getValue(), lastUpdateUserName, metaObject);
        }
    }
}

全局常量对象


/**
 * 全局常量对象
 */
@SuppressWarnings("all")
public interface GlobalConsts extends Serializable {

    /**
     * 数据库公共字段
     */
    enum PublicField {

        /**
         * 创建时间
         */
        CREATE_TIME("createTime"),
        /**
         * 创建者
         */
        CREATE_USER("createUser"),

        /**
         * 创建者名称
         */
        CREATE_USER_NAME("createUserName"),
        /**
         * 更新时间
         */
        LAST_UPDATE_TIME("lastUpdateTime"),
        /**
         * 更新人
         */
        LAST_UPDATE_USER("lastUpdateUser"),
        /**
         * 更新人名称
         */
        LAST_UPDATE_USER_NAME("lastUpdateUserName");

        String value;

        PublicField(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }

        @Override
        public String toString() {
            return this.value;
        }

    }

}

Mybatis-Plus提供了公共字段填充的功能,可以在插入和更新操作时自动填充公共字段,减少代码重复和出错的可能性。下面是Java代码实现公共字段填充的示例: 1. 创建公共字段填充器类 ```java @Component public class MyMetaObjectHandler implements MetaObjectHandler { // 插入时填充字段 private static final String CREATE_TIME = "createTime"; private static final String UPDATE_TIME = "updateTime"; private static final String CREATE_BY = "createBy"; private static final String UPDATE_BY = "updateBy"; @Override public void insertFill(MetaObject metaObject) { // 填充创建时间和更新时间 this.strictInsertFill(metaObject, CREATE_TIME, LocalDateTime::now, LocalDateTime.class); this.strictInsertFill(metaObject, UPDATE_TIME, LocalDateTime::now, LocalDateTime.class); // 填充创建人和更新人 this.strictInsertFill(metaObject, CREATE_BY, "system", String.class); this.strictInsertFill(metaObject, UPDATE_BY, "system", String.class); } @Override public void updateFill(MetaObject metaObject) { // 填充更新时间 this.strictUpdateFill(metaObject, UPDATE_TIME, LocalDateTime::now, LocalDateTime.class); // 填充更新人 this.strictUpdateFill(metaObject, UPDATE_BY, "system", String.class); } } ``` 2. 配置公共字段填充器 ```java @Configuration public class MybatisPlusConfig { @Autowired private MyMetaObjectHandler metaObjectHandler; @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 添加公共字段填充器 List<MetaObjectHandler> metaObjectHandlers = new ArrayList<>(); metaObjectHandlers.add(metaObjectHandler); interceptor.setMetaObjectHandlers(metaObjectHandlers); return interceptor; } } ``` 在以上示例中,我们创建了一个名为MyMetaObjectHandler的公共字段填充器类,实现了MetaObjectHandler接口,并在insertFill和updateFill方法中分别填充了创建时间、更新时间、创建人和更新人等公共字段。然后在MybatisPlusConfig中将MyMetaObjectHandler配置到MybatisPlusInterceptor中,作为公共字段填充器。这样,在执行插入和更新操作时,就会自动填充公共字段,无需手动设置,大大提高了开发效率和数据准确性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

伏颜.

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值