SpringBoot AOP实现操作日志记录的最佳实践

1. 为什么需要AOP记录操作日志

在传统的SpringBoot项目中，记录操作日志通常需要在每个业务方法中手动添加日志代码。这种方式存在几个明显问题：

1. 代码重复：相同的日志记录逻辑会分散在各个业务方法中
2. 核心业务与非功能性需求耦合：日志记录与业务逻辑混杂在一起
3. 维护困难：当需要修改日志格式或策略时，需要修改所有相关方法

AOP（面向切面编程）正是解决这类问题的利器。通过AOP，我们可以将日志记录这类横切关注点（Cross-Cutting Concern）从业务逻辑中剥离出来，实现关注点分离。

实际项目中，操作日志通常需要记录：操作人、操作时间、操作类型、方法入参、返回结果、执行耗时等关键信息。

2. AOP日志记录实现方案选型

2.1 Spring AOP vs AspectJ

SpringBoot支持两种AOP实现方式：

对于大多数操作日志记录场景，Spring AOP已经完全够用，且配置更简单，是首选方案。

2.2 注解驱动 vs 表达式匹配

定义切点有两种主要方式：

1. 注解驱动：自定义注解标记需要记录日志的方法

java复制@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateLog {
    String value() default "";
}

2. 表达式匹配：通过execution表达式匹配方法

java复制@Pointcut("execution(* com.example.service.*.*(..))")
public void serviceLayer() {}

注解方式更精确但需要修改代码，表达式方式更灵活但可能误匹配。实际项目中可以结合使用。

3. 完整实现步骤

3.1 基础环境准备

确保pom.xml中包含必要依赖：

xml复制<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.6</version>
</dependency>

3.2 定义日志注解

创建自定义注解用于标记需要记录日志的方法：

java复制@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperateLog {
    // 操作模块
    String module() default "";
    // 操作类型
    String type() default "";
    // 操作描述
    String desc() default "";
}

3.3 实现切面逻辑

创建切面类处理日志记录：

java复制@Aspect
@Component
@Slf4j
public class OperateLogAspect {
    
    @Autowired
    private OperateLogService logService;
    
    // 定义切点：所有带有@OperateLog注解的方法
    @Pointcut("@annotation(com.example.annotation.OperateLog)")
    public void operateLogPointCut() {}
    
    @Around("operateLogPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        
        // 获取方法签名
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        
        // 获取注解
        OperateLog operateLog = method.getAnnotation(OperateLog.class);
        
        // 构建日志对象
        OperateLogEntity logEntity = new OperateLogEntity();
        logEntity.setModule(operateLog.module());
        logEntity.setType(operateLog.type());
        logEntity.setDesc(operateLog.desc());
        logEntity.setOperateTime(new Date());
        logEntity.setOperateUser(getCurrentUser());
        
        // 获取请求参数
        Object[] args = joinPoint.getArgs();
        try {
            logEntity.setParams(new Gson().toJson(args));
        } catch (Exception e) {
            log.error("记录操作日志参数序列化失败", e);
        }
        
        // 执行目标方法
        Object result;
        try {
            result = joinPoint.proceed();
            logEntity.setResult(new Gson().toJson(result));
            logEntity.setSuccess(true);
        } catch (Exception e) {
            logEntity.setResult(e.getMessage());
            logEntity.setSuccess(false);
            throw e;
        } finally {
            long endTime = System.currentTimeMillis();
            logEntity.setCostTime(endTime - startTime);
            
            // 异步保存日志
            logService.saveLog(logEntity);
        }
        
        return result;
    }
    
    private String getCurrentUser() {
        // 从安全上下文中获取当前用户
        // 实际项目中根据具体安全框架实现
        return "admin";
    }
}

3.4 日志实体类设计

java复制@Data
public class OperateLogEntity {
    private Long id;
    private String module;     // 操作模块
    private String type;       // 操作类型
    private String desc;       // 操作描述
    private String params;     // 方法参数
    private String result;     // 返回结果
    private Boolean success;   // 是否成功
    private String operateUser;// 操作人
    private Date operateTime;  // 操作时间
    private Long costTime;     // 耗时(ms)
}

4. 高级优化与最佳实践

4.1 性能优化方案

1. 异步记录日志：使用@Async或消息队列异步处理

java复制@Async
public void saveLog(OperateLogEntity logEntity) {
    // 保存日志到数据库
}

2. 批量插入：使用JPA的saveAll或MyBatis的批量插入

3. 日志数据压缩：对大文本参数进行压缩存储

4.2 敏感信息处理

对密码等敏感参数进行脱敏：

java复制private String handleSensitiveParams(String params) {
    // 使用正则表达式匹配敏感字段
    return params.replaceAll("(\"password\":\")(.*?)(\")", "$1******$3");
}

4.3 日志查询优化

1. 为常用查询字段添加索引
2. 考虑使用Elasticsearch存储和检索日志
3. 实现日志分表策略（按时间或模块分表）

5. 常见问题与解决方案

5.1 切面不生效排查步骤

1. 检查类是否被Spring管理（是否有@Component等注解）
2. 确认方法调用是否经过Spring代理（同类内调用不生效）
3. 检查切点表达式是否正确匹配目标方法
4. 确认是否启用了AOP（@EnableAspectJAutoProxy）

5.2 循环依赖问题

当切面依赖的Service又依赖切面时会产生循环依赖。解决方案：

1. 使用@Lazy延迟加载
2. 重构代码消除循环依赖
3. 将日志记录逻辑移到切面内部

5.3 大参数处理

当方法参数很大时，直接序列化可能影响性能。解决方案：

1. 限制参数记录长度

java复制if(params.length() > 1000) {
    params = params.substring(0, 1000) + "...[truncated]";
}

2. 只记录关键字段而非整个对象
3. 使用二进制格式而非JSON存储

6. 生产环境建议

1. 日志采样：在高并发场景下，考虑采样记录而非全量记录
2. 熔断机制：当日志记录出现异常时，应有降级策略不影响主流程
3. 监控报警：监控日志记录失败情况，设置适当报警
4. 定期归档：建立日志归档机制，避免主表数据过大

实际项目中，我们团队采用AOP记录操作日志后，日志相关代码量减少了70%，新功能的开发效率提升了约30%，同时日志的一致性和完整性也得到了显著提高。特别是在排查线上问题时，完整的操作日志能快速定位问题原因。