aop如何优雅记录操作日志到数据库？

AOP记录操作到数据库的核心概念

AOP（Aspect-Oriented Programming，面向切面编程）是一种编程范式，它通过将横切关注点（如日志、事务管理、权限控制等）与业务逻辑分离，实现代码的高内聚低耦合，在系统中记录操作日志到数据库是AOP的典型应用场景，其核心思想是通过预定义的切面，在方法执行前后自动捕获操作信息（如操作人、操作时间、方法参数、执行结果等），并持久化到数据库，无需在业务代码中手动插入日志逻辑。

这种模式的优势在于：

1. 非侵入性：业务代码无需关注日志记录逻辑，降低耦合度；
2. 统一管理：所有操作日志通过切面统一处理，避免重复代码；
3. 可扩展性：通过修改切面配置即可调整日志记录规则，适应不同业务需求。

实现AOP记录操作日志的技术步骤

1 环境准备与依赖引入

以Java Spring Boot为例，需引入以下核心依赖：

• Spring Boot AOP Starter（spring-boot-starter-aop）
• 数据库驱动（如MySQL的mysql-connector-java）
• ORM框架（如MyBatis或JPA，此处以MyBatis为例）

<!-- pom.xml核心依赖 -->  
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-aop</artifactId>  
</dependency>  
<dependency>  
    <groupId>mysql</groupId>  
    <artifactId>mysql-connector-java</artifactId>  
    <scope>runtime</scope>  
</dependency>  
<dependency>  
    <groupId>org.mybatis.spring.boot</groupId>  
    <artifactId>mybatis-spring-boot-starter</artifactId>  
    <version>2.2.0</version>  
</dependency>  

2 数据库表结构设计

操作日志表需包含关键字段，以记录完整的操作信息，以下是典型表结构设计：

3 实体类与Mapper接口定义

根据表结构创建实体类OperationLog，并定义对应的Mapper接口：

// OperationLog.java  
@Data  
public class OperationLog {  
    private Long id;  
    private String operation;  
    private String method;  
    private String params;  
    private String result;  
    private String operator;  
    private Date operationTime;  
    private Integer status;  
    private String errorMsg;  
}  
// OperationLogMapper.java  
@Mapper  
public interface OperationLogMapper {  
    @Insert("INSERT INTO operation_log(operation, method, params, result, operator, operation_time, status, error_msg) " +  
            "VALUES(#{operation}, #{method}, #{params}, #{result}, #{operator}, #{operationTime}, #{status}, #{errorMsg})")  
    int insert(OperationLog operationLog);  
}  

4 定义切面与通知类型

通过@Aspect和@Component注解定义切面，结合@Before、@AfterReturning、@AfterThrowing等通知类型捕获方法执行的不同阶段信息。

@Aspect  
@Component  
@Slf4j  
public class LogAspect {  
    // 定义切点：拦截Service层所有public方法  
    @Pointcut("execution(public * com.service.*.*(..))")  
    public void logPointCut() {}  
    // 前置通知：记录方法执行前的参数  
    @Before("logPointCut()")  
    public void doBefore(JoinPoint joinPoint) {  
        // 获取请求参数  
        Object[] args = joinPoint.getArgs();  
        String className = joinPoint.getTarget().getClass().getName();  
        String methodName = joinPoint.getSignature().getName();  
        log.info("执行方法：{}.{}，参数：{}", className, methodName, JSON.toJSONString(args));  
    }  
    // 后置通知：方法正常返回后记录结果  
    @AfterReturning(pointcut = "logPointCut()", returning = "result")  
    public void doAfterReturning(JoinPoint joinPoint, Object result) {  
        String className = joinPoint.getTarget().getClass().getName();  
        String methodName = joinPoint.getSignature().getName();  
        log.info("方法 {}.{} 执行成功，返回结果：{}", className, methodName, JSON.toJSONString(result));  
    }  
    // 异常通知：方法抛出异常后记录错误信息  
    @AfterThrowing(pointcut = "logPointCut()", throwing = "exception")  
    public void doAfterThrowing(JoinPoint joinPoint, Exception exception) {  
        String className = joinPoint.getTarget().getClass().getName();  
        String methodName = joinPoint.getSignature().getName();  
        log.error("方法 {}.{} 执行异常，异常信息：{}", className, methodName, exception.getMessage());  
    }  
}  

5 日志信息持久化到数据库

在通知中获取操作信息后，调用OperationLogMapper将数据插入数据库，需注意线程安全问题，建议使用@Async异步执行日志插入，避免阻塞主业务流程。

@Async  
public void saveLog(OperationLog log) {  
    operationLogMapper.insert(log);  
}  

关键优化与注意事项

1 性能优化策略

日志记录属于非核心业务，若同步插入可能导致主流程性能下降，可通过以下方式优化：

1. 异步插入：结合@Async注解或线程池异步执行日志保存；
2. 批量插入：高频操作场景下，缓存日志数据后批量提交，减少数据库IO；
3. 字段精简：避免记录过长文本（如大对象参数），仅保留关键字段。

2 敏感信息处理

方法参数中可能包含密码、身份证号等敏感信息，需在记录前进行脱敏处理。

String sensitiveParams = maskSensitive(JSON.toJSONString(args));  
private String maskSensitive(String params) {  
    // 使用正则表达式替换敏感字段，如手机号、身份证号等  
    return params.replaceAll("(\"mobile\":\")(\\d{3})\\d{4}(\\d{4})", "$1****$3");  
}  

3 异常捕获与容错

日志记录失败不应影响主业务流程，需在切面中添加try-catch，确保异常被捕获并记录到系统日志：

@After("logPointCut()")  
public void doAfter(JoinPoint joinPoint) {  
    try {  
        // 获取操作信息并保存  
    } catch (Exception e) {  
        log.error("日志记录失败", e);  
    }  
}  

应用场景与扩展方向

AOP记录操作日志广泛应用于以下场景：

1. 审计追踪：金融、政务等对操作可追溯性要求高的系统；
2. 问题排查：通过日志定位业务异常，快速定位问题代码；
3. 行为分析：统计用户操作行为，优化产品功能。

未来可结合ELK（Elasticsearch、Logstash、Kibana）实现日志的实时分析，或通过消息队列（如Kafka）解耦日志记录与业务系统,进一步提升系统的可维护性和扩展性。