Spring MVC开发RESTful服务：方法内日志追踪是否为不良实践？

Great question—logging as a cross-cutting concern is something a lot of us grapple with when building Spring MVC REST services. Let’s break this down step by step.

一、服务门面方法中的日志语句是否属于不良实践？要不要移到拦截器？ #

答案是不要一刀切，得看日志的类型：

• 业务相关日志：比如 log.info("用户{}提交了订单，订单ID：{}", userId, orderId) 这类和业务逻辑强相关的日志，完全可以留在门面方法里。因为这类日志需要业务上下文的具体数据（比如用户ID、订单号），拦截器或通用切面很难直接获取这些业务细节，强行移走反而会让日志失去意义，还可能增加不必要的复杂度。
• 通用横切日志：比如 log.info("方法{}开始执行，参数：{}", methodName, params)、log.info("方法{}执行完成，耗时{}ms", methodName, costTime) 这类重复的、和业务无关的追踪日志，确实属于不良实践。这类日志是典型的横切关注点，应该抽离到AOP切面或Spring MVC拦截器中统一处理，这样既能避免代码重复，又能让业务方法更专注于核心逻辑。

举个Spring AOP的简单示例，用来处理通用方法日志：

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

    @Around("execution(* com.yourpackage.service..*(..))")
    public Object logMethodExecution(ProceedingJoinPoint joinPoint) throws Throwable {
        String methodName = joinPoint.getSignature().getName();
        Object[] args = joinPoint.getArgs();
        log.debug("方法{}开始执行，参数：{}", methodName, Arrays.toString(args));
        
        long startTime = System.currentTimeMillis();
        Object result = joinPoint.proceed();
        long costTime = System.currentTimeMillis() - startTime;
        
        log.debug("方法{}执行完成，耗时{}ms，返回值：{}", methodName, costTime, result);
        return result;
    }
}

二、充斥log.debug追踪语句的方法是否属于不良实践？该如何处理？ #

是的，这种做法确实是不良实践——大量的log.debug会让业务代码变得臃肿不堪，可读性大幅下降，而且维护起来非常麻烦。可以通过以下方式优化：

1. 用AOP统一处理方法级调试追踪
   就像上面的切面示例一样，把方法的进入、退出、参数、返回值等调试日志统一交给AOP处理。这样业务方法里完全不需要写这些重复的追踪代码，只需要通过日志配置（比如logback.xml）开启debug级别就能自动输出这些信息。

2. 保留必要的细粒度调试日志，但要做优化
   如果某些业务流程中需要追踪特定变量的变化（比如某个计算过程的中间值），可以保留少量log.debug，但要注意：

   • 用条件判断包裹：避免不必要的字符串拼接性能损耗，比如：

     if (log.isDebugEnabled()) {
         log.debug("计算后的中间值：{}", intermediateValue);
     }
     

   • 不要过度添加：只保留真正有助于排查问题的关键节点日志，避免无意义的“变量X的值是Y”这类日志。

3. 利用日志框架的高级特性
   比如使用Logback的Marker功能，给调试日志打上特定标记，方便后续过滤和分析；或者使用结构化日志（比如JSON格式），让调试日志更容易被工具解析。

总结 #

• 日志不是必须全部抽离，区分业务日志和通用横切日志，分别处理；
• 避免业务方法被大量调试追踪日志淹没，用AOP统一处理这类横切逻辑；
• 必要的细粒度调试日志要精简并做性能优化。

内容的提问来源于stack exchange，提问作者Andres Romero