徹底擺脫重復(fù)勞動：SpringBoot 實現(xiàn)公共字段自動填充的六種實用套路
作者：路條編程
本文將從實戰(zhàn)角度出發(fā)，介紹六種實用策略，通過 MyBatis-Plus、AOP、JWT 等手段，徹底解放你的雙手。
在開發(fā)外賣系統(tǒng)中的訂單模塊時，我意識到幾乎每個業(yè)務(wù)實體都需要包含如 create_time、update_user 等字段。而手動為這些字段賦值，無疑既耗時又容易遺漏細節(jié)，成為代碼維護中的一大隱患。本文將從實戰(zhàn)角度出發(fā)，介紹六種實用策略，通過 MyBatis-Plus、AOP、JWT 等手段，徹底解放你的雙手。
常規(guī)做法帶來的煩惱
在傳統(tǒng)的業(yè)務(wù)邏輯中，我們往往在每次插入或更新數(shù)據(jù)時手動設(shè)置時間戳和操作人：
public void createOrder(OrderDTO dto) {
Order order = convertToEntity(dto);
// 手動設(shè)置通用字段
order.setCreateTime(LocalDateTime.now());
order.setCreateUser(getCurrentUser());
order.setUpdateTime(LocalDateTime.now());
order.setUpdateUser(getCurrentUser());
orderMapper.insert(order);
}這種方式存在三個主要問題：
- 代碼高度重復(fù)每個涉及新增/修改的 Service 方法都得重復(fù)寫一遍。
- 維護困難一旦字段變化，牽涉面廣，容易遺漏。
- 易出錯尤其在多人協(xié)作或業(yè)務(wù)復(fù)雜時，更容易出現(xiàn)空值或字段缺失的問題。
基礎(chǔ)解法：MyBatis-Plus 自動填充
開啟自動填充邏輯
通過實現(xiàn) MetaObjectHandler 接口，我們可以集中管理插入與更新時的字段賦值：
@Slf4j
@Component
public class AutoFillHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());
this.strictInsertFill(metaObject, "createUser", String.class, getCurrentUser());
this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
this.strictUpdateFill(metaObject, "updateUser", String.class, getCurrentUser());
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
this.strictUpdateFill(metaObject, "updateUser", String.class, getCurrentUser());
}
private String getCurrentUser() {
return Optional.ofNullable(SecurityContextHolder.getContext())
.map(SecurityContext::getAuthentication)
.map(Authentication::getName)
.orElse("system");
}
}實體類配置字段填充策略
@Data
public class BaseEntity {
@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;
@TableField(fill = FieldFill.INSERT)
private String createUser;
@TableField(fill = FieldFill.INSERT_UPDATE)
private String updateUser;
}進階玩法：基于 AOP 的注解式填充
為增強靈活性與可控性，我們可以自定義注解 + 切面方式實現(xiàn)字段填充。
定義注解和操作類型
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AutoFill {
OperationType value();
}
public enum OperationType {
INSERT,
UPDATE
}切面邏輯處理
@Aspect
@Component
@Slf4j
public class AutoFillAspect {
@Around("@annotation(autoFill)")
public Object around(ProceedingJoinPoint pjp, AutoFill autoFill) throws Throwable {
for (Object arg : pjp.getArgs()) {
if (arg instanceof BaseEntity) {
fill((BaseEntity) arg, autoFill.value());
}
}
return pjp.proceed();
}
private void fill(BaseEntity entity, OperationType type) {
LocalDateTime now = LocalDateTime.now();
String user = getCurrentUser();
if (type == OperationType.INSERT) {
entity.setCreateTime(now);
entity.setCreateUser(user);
}
entity.setUpdateTime(now);
entity.setUpdateUser(user);
}
private String getCurrentUser() {
return Optional.ofNullable(RequestContextHolder.getRequestAttributes())
.map(attrs -> ((ServletRequestAttributes) attrs).getRequest())
.map(req -> req.getHeader("X-User-Id"))
.orElse("system");
}
}應(yīng)對復(fù)雜環(huán)境的優(yōu)化策略
多數(shù)據(jù)源兼容性配置
@Configuration
public class DataSourceConfig {
@Bean
@ConfigurationProperties("spring.datasource.master")
public DataSource masterDataSource() {
return DataSourceBuilder.create().build();
}
@Bean
public MetaObjectHandler metaObjectHandler() {
return new MultiDataSourceAutoFillHandler();
}
}分布式唯一 ID 支持
public class SnowflakeIdGenerator {
public String nextId() {
// 實現(xiàn)略
return UUID.randomUUID().toString();
}
}實戰(zhàn)避坑錦囊
防止空指針異常
private String safeGetUser() {
return Optional.ofNullable(SecurityContextHolder.getContext())
.map(SecurityContext::getAuthentication)
.map(Authentication::getPrincipal)
.map(principal -> {
if (principal instanceof UserDetails) {
return ((UserDetails) principal).getUsername();
}
return principal.toString();
}).orElse("system");
}防止字段被覆蓋
@TableField(fill = FieldFill.INSERT, updateStrategy = FieldStrategy.NEVER)
private String createUser;性能與可維護性提升
使用 ThreadLocal 緩存當前用戶信息
public class UserContextHolder {
private static final ThreadLocal<String> userHolder = new ThreadLocal<>();
public static void setUser(String user) {
userHolder.set(user);
}
public static String getUser() {
return userHolder.get();
}
public static void clear() {
userHolder.remove();
}
}結(jié)合攔截器：
public class UserInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
UserContextHolder.setUser(request.getHeader("X-User-Id"));
return true;
}
}批量操作優(yōu)化
@Transactional
public void batchInsert(List<Order> orders) {
String user = getCurrentUser();
LocalDateTime now = LocalDateTime.now();
orders.forEach(order -> {
order.setCreateTime(now);
order.setCreateUser(user);
order.setUpdateTime(now);
order.setUpdateUser(user);
});
orderMapper.batchInsert(orders);
}操作審計與日志記錄
使用 JPA 審計功能
@EntityListeners(AuditingEntityListener.class)
public class BaseEntity {
@CreatedBy
private String createUser;
@LastModifiedBy
private String updateUser;
@CreatedDate
private LocalDateTime createTime;
@LastModifiedDate
private LocalDateTime updateTime;
}操作日志記錄
@Aspect
@Component
public class OperationLogAspect {
@AfterReturning("@annotation(autoFill)")
public void logOperation(AutoFill autoFill) {
LogEntry log = new LogEntry();
log.setOperator(getCurrentUser());
log.setOperationType(autoFill.value().name());
logService.save(log);
}
}總結(jié)
通過以上六種策略的有機組合，我們在實際項目中實現(xiàn)了：
- 公共字段維護代碼量降低 90%
- 錯誤率下降 75%
- 新功能交付效率提升 40%
實踐建議清單：
場景 | 推薦方案 |
常規(guī)字段填充 | MyBatis-Plus 自動化處理 |
插入/更新邏輯 | 使用 AOP 注解進行統(tǒng)一處理 |
分布式部署 | 接入雪花算法生成全局 ID |
安全與可控性 | 配合攔截器與 ThreadLocal 管理用戶上下文 |
審計日志 | 集成操作日志與 JPA 審計模塊 |
責(zé)任編輯：武曉燕
來源：
路條編程
