前言

在现代企业级应用开发中，数据安全和审计追踪是至关重要的环节。无论是金融系统、电商平台，还是管理系统，我们都需要对数据的变更进行详细记录，以便后续的审计、回滚或问题排查。今天，我们就来聊聊如何使用Spring Boot和MyBatis-Plus开发一个高效的数据追踪插件，实现对数据变更的自动记录与管理。

为什么需要数据追踪？

在实际项目中，我们经常会遇到以下场景：

1. 数据审计：记录谁在什么时候修改了什么数据
2. 数据恢复：当数据被误操作后，能够快速恢复到之前的状态
3. 操作追踪：追踪关键业务数据的变更历史
4. 合规要求：满足行业监管对数据变更的记录要求

传统的做法是手动在每个业务方法中添加日志记录代码，但这种方式存在以下问题：

• 代码重复，维护成本高
• 容易遗漏，造成审计盲区
• 侵入性强，影响业务代码的简洁性

因此，我们需要一个自动化的数据追踪解决方案。

MyBatis-Plus拦截器机制

MyBatis-Plus提供了强大的拦截器机制，允许我们在SQL执行前后进行拦截和处理。这是实现数据追踪的核心技术。

MyBatis-Plus拦截器可以拦截以下方法：

• Executor：执行SQL的核心接口
• StatementHandler：处理SQL语句
• ParameterHandler：处理参数
• ResultSetHandler：处理结果集

对于数据追踪，我们主要关注Executor接口，因为它包含了数据的增删改查操作。

核心实现思路

数据追踪插件的核心实现思路如下：

1. 拦截数据操作：使用MyBatis-Plus拦截器拦截INSERT、UPDATE、DELETE操作
2. 获取变更信息：解析SQL和参数，获取变更前后的数据
3. 记录变更日志：将变更信息保存到审计表中
4. 提供查询接口：提供数据变更历史的查询功能

拦截器实现

1. 审计实体类设计

首先，我们需要设计一个审计实体类来存储变更记录：

@Data
@Entity
@Table(name = "data_audit_log")
public class DataAuditLog {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String tableName;      // 表名
    private String operationType;  // 操作类型：INSERT、UPDATE、DELETE
    private String recordId;       // 记录ID
    private String beforeData;     // 变更前的数据
    private String afterData;      // 变更后的数据
    private String operator;       // 操作人
    private String operationTime;  // 操作时间
    private String businessInfo;   // 业务信息
}

2. 拦截器实现

@Intercepts({
    @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),
    @Signature(type = Executor.class, method = "insert", args = {MappedStatement.class, Object.class}),
    @Signature(type = Executor.class, method = "delete", args = {MappedStatement.class, Object.class})
})
@Component
public class DataAuditInterceptor implements Interceptor {
    
    @Autowired
    private DataAuditService dataAuditService;
    
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        MappedStatement ms = (MappedStatement) args[0];
        Object parameter = args[1];
        
        String sqlType = ms.getSqlCommandType().name();
        String tableName = getTableName(ms);
        
        // 记录变更前的数据（对于UPDATE和DELETE操作）
        String beforeData = null;
        if ("UPDATE".equals(sqlType) || "DELETE".equals(sqlType)) {
            beforeData = getBeforeData(ms, parameter);
        }
        
        // 执行原始操作
        Object result = invocation.proceed();
        
        // 记录变更后的数据
        String afterData = null;
        if ("INSERT".equals(sqlType) || "UPDATE".equals(sqlType)) {
            afterData = getAfterData(parameter);
        }
        
        // 保存审计日志
        if ("INSERT".equals(sqlType) || "UPDATE".equals(sqlType) || "DELETE".equals(sqlType)) {
            DataAuditLog auditLog = new DataAuditLog();
            auditLog.setTableName(tableName);
            auditLog.setOperationType(sqlType);
            auditLog.setBeforeData(beforeData);
            auditLog.setAfterData(afterData);
            auditLog.setOperator(getCurrentOperator());
            auditLog.setOperationTime(LocalDateTime.now().toString());
            
            dataAuditService.saveAuditLog(auditLog);
        }
        
        return result;
    }
    
    private String getTableName(MappedStatement ms) {
        // 从MappedStatement中解析表名
        String sqlSource = ms.getBoundSql(null).getSql();
        // 简化实现，实际项目中需要更复杂的SQL解析
        return "unknown_table";
    }
    
    private String getBeforeData(MappedStatement ms, Object parameter) {
        // 获取变更前的数据
        // 实际项目中可能需要查询数据库获取原始数据
        return JSON.toJSONString(parameter);
    }
    
    private String getAfterData(Object parameter) {
        // 获取变更后的数据
        return JSON.toJSONString(parameter);
    }
    
    private String getCurrentOperator() {
        // 获取当前操作人
        // 可以从SecurityContext、ThreadLocal等获取
        return "system";
    }
    
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    
    @Override
    public void setProperties(Properties properties) {
        // 设置插件属性
    }
}

3. 优化的SQL解析

为了更准确地获取表名和变更数据，我们需要优化SQL解析逻辑：

public class SqlParser {
    
    public static String getTableName(String sql) {
        // 使用SQL解析库解析表名
        // 这里使用简单的正则表达式演示
        sql = sql.toUpperCase();
        
        if (sql.contains("INSERT INTO")) {
            int start = sql.indexOf("INSERT INTO") + "INSERT INTO".length();
            int end = sql.indexOf(' ', start);
            return sql.substring(start, end).trim();
        } else if (sql.contains("UPDATE")) {
            int start = sql.indexOf("UPDATE") + "UPDATE".length();
            int end = sql.indexOf(' ', start);
            return sql.substring(start, end).trim();
        } else if (sql.contains("DELETE FROM")) {
            int start = sql.indexOf("DELETE FROM") + "DELETE FROM".length();
            int end = sql.indexOf(' ', start);
            return sql.substring(start, end).trim();
        }
        
        return null;
    }
}

高级功能实现

1. 数据脱敏

对于敏感数据，我们需要在审计日志中进行脱敏处理：

public class DataMaskingUtil {
    
    public static String maskSensitiveData(String data) {
        if (data == null) return null;
        
        // 对手机号进行脱敏
        data = data.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2");
        
        // 对身份证进行脱敏
        data = data.replaceAll("(\\d{6})\\d{8}(\\w{4})", "$1********$2");
        
        // 对邮箱进行脱敏
        data = data.replaceAll("(\\w{2})\\w+@(\\w+)", "$1***@$2");
        
        return data;
    }
}

2. 异步记录

为了不影响业务性能，审计日志的记录可以采用异步方式：

@Service
public class AsyncDataAuditService {
    
    @Async
    public void saveAuditLogAsync(DataAuditLog auditLog) {
        // 异步保存审计日志
        saveAuditLog(auditLog);
    }
}

3. 配置化控制

我们可以使用注解来控制哪些操作需要审计：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataAudit {
    String value() default "";
    boolean enable() default true;
}

性能优化策略

1. 批量记录：将多个审计日志批量写入数据库
2. 异步处理：使用消息队列异步处理审计日志
3. 数据压缩：对审计数据进行压缩存储
4. 索引优化：为审计表建立合适的索引
5. 数据归档：定期归档历史审计数据

安全考虑

1. 权限控制：只有授权用户才能访问审计日志
2. 数据加密：对敏感审计数据进行加密存储
3. 防篡改：确保审计日志不能被修改
4. 访问日志：记录对审计数据的访问行为

实际应用案例

1. 金融系统

在金融系统中，每一笔资金变动都需要详细记录：

@Service
public class AccountService {
    
    @DataAudit("资金变动记录")
    public void transfer(Long fromAccountId, Long toAccountId, BigDecimal amount) {
        // 执行转账逻辑
        // 拦截器自动记录变更
    }
}

2. 电商系统

在电商系统中，商品信息的变更需要追踪：

@Service
public class ProductService {
    
    @DataAudit("商品信息变更")
    public void updateProduct(Product product) {
        // 更新商品信息
        // 拦截器自动记录变更
    }
}

监控与告警

我们可以为数据追踪插件添加监控功能：

@Component
public class AuditMetrics {
    
    private final MeterRegistry meterRegistry;
    
    public AuditMetrics(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
    }
    
    public void recordAuditEvent(String operationType) {
        Counter.builder("data_audit_events")
               .tag("operation", operationType)
               .register(meterRegistry)
               .increment();
    }
}

总结

本文详细介绍了如何使用Spring Boot和MyBatis-Plus开发数据追踪插件，实现对数据库变更的自动记录与管理。通过MyBatis-Plus的拦截器机制，我们可以无侵入地实现数据审计功能。

在实际项目中，还需要考虑更多的细节，如性能优化、安全控制、监控告警等。数据追踪插件作为系统的重要组成部分，能够有效提升系统的可追溯性和安全性。

服务端技术精选，专注后端技术分享，欢迎关注！