用AOP+自定义注解重构代码：告别重复逻辑，实现优雅日志记录

在日常开发中，我们经常遇到这样的场景：多个方法需要相同的日志记录逻辑。传统做法会导致大量重复代码：每个业务方法都包含相同的日志模板，导致：步骤2：编写切面逻辑步骤3：应用注解三、方案优势分析1. 技术优势对比方案类型代码侵入性维护成本可读性复用性传统硬编码高高差低AOP+注解低低优高2. 实际效果提升代码量减少40%-60%日志格式统一化业务方法专注核心逻辑功能开关灵活配置（如耗时统计）

嘵奇

1340人浏览 · 2025-04-09 18:06:42

嘵奇 · 2025-04-09 18:06:42 发布

精心整理了最新的面试资料和简历模板，有需要的可以自行获取

点击前往百度网盘获取
 点击前往夸克网盘获取

一、传统开发的痛点：重复代码的困扰

在日常开发中，我们经常遇到这样的场景：多个方法需要相同的日志记录逻辑。传统做法会导致大量重复代码：

public void createOrder(Order order) {
    long start = System.currentTimeMillis();
    log.info("开始创建订单，参数：{}", order);
    
    try {
        // 业务逻辑...
        log.info("创建订单成功，耗时：{}ms", System.currentTimeMillis()-start);
    } catch (Exception e) {
        log.error("创建订单失败", e);
        throw e;
    }
}

每个业务方法都包含相同的日志模板，导致：

代码冗余度高
维护成本增加
核心逻辑被非功能代码淹没

二、AOP+注解解决方案

1. 核心组件解析

AOP（面向切面编程）：通过动态代理实现横切关注点分离
自定义注解：声明式标记需要增强的方法
四大核心概念：
- Aspect（切面）：模块化横切逻辑
- JoinPoint（连接点）：方法执行点
- Pointcut（切点）：匹配连接点的表达式
- Advice（通知）：增强逻辑的具体实现

2. 实现步骤详解

步骤1：创建自定义注解

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

步骤2：编写切面逻辑

@Aspect
@Component
public class LogAspect {
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    @Around("@annotation(methodLog)")
    public Object aroundAdvice(ProceedingJoinPoint joinPoint, MethodLog methodLog) throws Throwable {
        String methodName = joinPoint.getSignature().getName();
        Object[] args = joinPoint.getArgs();
        
        // 前置通知
        log.info("[{}] 方法开始 | 参数: {}", methodLog.value(), Arrays.toString(args));
        
        long start = System.currentTimeMillis();
        try {
            Object result = joinPoint.proceed();
            // 返回通知
            if(methodLog.trackTime()) {
                log.info("[{}] 方法成功 | 耗时: {}ms", methodLog.value(), 
                        System.currentTimeMillis()-start);
            }
            return result;
        } catch (Exception e) {
            // 异常通知
            log.error("[{}] 方法异常 | 错误信息: {}", methodLog.value(), e.getMessage());
            throw e;
        }
    }
}

步骤3：应用注解

@Service
public class OrderService {

    @MethodLog("创建订单")
    public Order createOrder(Order order) {
        // 纯净的业务逻辑
    }

    @MethodLog(value = "订单支付", trackTime = false)
    public void payOrder(String orderId) {
        // 支付逻辑
    }
}

三、方案优势分析

1. 技术优势对比

方案类型	代码侵入性	维护成本	可读性	复用性
传统硬编码	高	高	差	低
AOP+注解	低	低	优	高

2. 实际效果提升

代码量减少40%-60%
日志格式统一化
业务方法专注核心逻辑
功能开关灵活配置（如耗时统计）

四、高级应用扩展

1. 组合注解实现

@MethodLog("权限校验")
@PreAuthorize("hasRole('ADMIN')")
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AdminOperation {}

2. 动态参数处理

// 在切面中解析特定参数
if(args.length > 0 && args[0] instanceof User){
    User user = (User)args[0];
    MDC.put("userId", user.getId());
}

3. 性能监控整合

@Pointcut("@annotation(methodLog)")
public void monitorPointcut(MethodLog methodLog) {}

@AfterReturning(pointcut = "monitorPointcut(methodLog)", returning = "result")
public void sendMetrics(MethodLog methodLog, Object result) {
    Metrics.counter(methodLog.value()).increment();
}

五、最佳实践建议

注解设计原则
- 保持注解语义明确
- 设置合理的默认值
- 避免过度设计
切面编程注意点
- 控制切面粒度（单个切面不超过300行）
- 处理ProceedingJoinPoint.proceed()的异常
- 注意线程安全问题
- 避免循环代理
性能优化技巧
- 使用条件化的切点表达式
- 异步记录非关键日志
- 合理设置切面执行顺序

六、应用场景拓展

场景类型	实现方案	业务价值
接口限流	@RateLimit + 令牌桶算法	系统过载保护
数据脱敏	@DataMasking + Jackson序列化切面	隐私合规保障
操作审计	@OperationAudit + 审计事件发布	满足安全审计要求
缓存优化	@Cacheable + 多级缓存策略	提升系统响应速度
幂等控制	@Idempotent + Token校验机制	防止重复提交