谈国平1. 项目背景与核心价值
在业务系统开发中，数据变更记录（又称审计日志）是刚需功能。传统方案往往需要在每个Service方法中手动插入日志代码，导致业务逻辑与审计逻辑高度耦合。而基于SpringBoot+MyBatis-Plus的注解式方案，可以实现声明式的数据变更追踪。
我在金融级业务系统中实践发现，这种方案能减少约70%的审计相关代码量。更重要的是，当审计规则变更时（如新增需要记录的字段），只需修改注解配置即可完成调整，无需侵入业务代码。
需要模型API调用？ 免费领10W Token，多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 技术选型解析
2.1 基础框架组合
选择SpringBoot 2.7.x + MyBatis-Plus 3.5.x的组合基于以下考量：
- MyBatis-Plus的BaseMapper提供了现成的CRUD操作
- 其内置的MetaObjectHandler接口可自动填充字段
- 与SpringBoot的AutoConfiguration完美集成
2.2 核心实现方案对比
| 方案类型 | 实现方式 | 优点 | 缺点 |
|---|---|---|---|
| AOP切面 | 拦截Service方法 | 无侵入 | 无法获取字段级变更 |
| 触发器 | 数据库层实现 | 性能好 | 维护困难 |
| 本方案 | 实体注解+MyBatis拦截器 | 字段级追踪 | 需处理批量操作 |
3. 核心实现细节
3.1 实体类注解设计
java复制@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface AuditField {
String value() default "";
boolean trackChange() default true;
}
@AuditEntity
public class User {
@AuditField("用户ID")
private Long id;
@AuditField("用户名")
private String username;
// 不追踪密码字段
private String password;
}
3.2 MyBatis拦截器实现
关键点在于实现Interceptor接口，重点处理update操作：
java复制@Intercepts({
@Signature(type= Executor.class, method="update",
args={MappedStatement.class, Object.class})
})
public class AuditInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) {
Object parameter = invocation.getArgs()[1];
if (parameter instanceof Map) {
// 处理批量更新
} else if (hasAuditAnnotation(parameter)) {
// 获取变更前数据
Object original = getOriginalData(parameter);
// 生成变更记录
generateAuditLog(original, parameter);
}
return invocation.proceed();
}
}
4. 完整实现流程
4.1 环境搭建
- 添加依赖：
xml复制<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.3.1</version>
</dependency>
- 配置拦截器：
java复制@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new AuditInterceptor());
return interceptor;
}
}
4.2 审计日志存储设计
建议采用JSON格式存储变更详情：
sql复制CREATE TABLE sys_audit_log (
id BIGINT PRIMARY KEY,
operation_type VARCHAR(20),
entity_type VARCHAR(50),
entity_id VARCHAR(100),
old_value JSON,
new_value JSON,
operate_time DATETIME,
operator VARCHAR(50)
);
5. 高级功能实现
5.1 批量操作处理
对于updateBatchById等批量方法，需要特殊处理：
java复制if (parameter instanceof Map<?,?> paramMap) {
if (paramMap.containsKey("et")) {
Object entity = paramMap.get("et");
// 获取原始数据集合
List<?> originals = batchQuery(entity.getClass(), ids);
// 逐个比对生成日志
}
}
5.2 关联字段追踪
通过自定义注解实现关联实体追踪：
java复制@AuditField(value = "部门", relatedClass = Department.class)
private Long deptId;
6. 性能优化方案
6.1 异步日志记录
使用Spring Event实现异步处理：
java复制@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
public void handleAuditEvent(AuditEvent event) {
auditLogService.asyncSave(event.getLog());
}
6.2 变更比对优化
采用BitSet记录脏字段，避免全字段比对：
java复制BitSet dirtyFields = new BitSet();
// 在拦截器中设置脏字段标记
7. 生产环境问题排查
7.1 常见问题及解决方案
| 问题现象 | 可能原因 | 解决方案 |
|---|---|---|
| 批量更新无日志 | 未处理Map参数 | 实现批量操作拦截 |
| 字段值为null不记录 | 注解配置问题 | 设置@AuditField(nullable=true) |
| 性能下降明显 | 全字段比对 | 启用脏字段标记 |
7.2 监控指标建议
- 日志生成耗时：控制在50ms以内
- 日志队列积压：设置阈值告警
- 存储空间监控：按实体类型统计
8. 源码设计要点
核心类结构设计：
code复制- annotation/
|- AuditEntity.java
|- AuditField.java
- interceptor/
|- AuditInterceptor.java
- handler/
|- AuditMetaObjectHandler.java
- model/
|- AuditLog.java
- service/
|- AuditLogService.java
关键实现技巧：
- 使用ThreadLocal保存原始数据
- 通过反射工具类提升性能
- 采用建造者模式构造日志对象
9. 扩展应用场景
9.1 多租户支持
在审计日志中增加tenant_id字段：
java复制@TableField(fill = FieldFill.INSERT)
private String tenantId;
9.2 敏感数据脱敏
通过注解配置脱敏规则：
java复制@AuditField(value = "手机号", maskPattern = "(\d{3})\d{4}(\d{4})")
private String mobile;
10. 实际应用建议
- 重要核心表建议全字段审计
- 高频操作表可采用采样审计
- 历史审计数据建议定期归档
- 生产环境建议关闭DEBUG日志
在电商订单系统中实践发现，该方案可以完整记录订单状态变更轨迹。当出现售后纠纷时，能快速定位到具体变更节点和操作人，大幅提升问题排查效率。