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;
}
}
}