在spring boot中记录rest接口请求日志,最直接且标准的方法是使用aop(面向切面编程)结合自定义注解或全局拦截器。通过定义一个切面类,拦截所有被`@restcontroller`标记的控制器方法,可以在请求进入和返回时自动提取http方法、url、参数、耗时及响应状态,并统一输出到日志文件中。这种方式解耦了业务代码与日志逻辑,无需在每个controller方法中手动编写日志打印语句。

如何配置AOP切面以捕获Controller层的输入输出
要实现这一功能,需要引入Spring AOP依赖,并创建一个切面类。在该类中使用`@Around`注解包裹目标方法,利用`ProceedingJoinPoint`获取方法签名、参数以及执行结果。对于GET请求,参数通常位于查询字符串中;对于POST/PUT请求,参数可能位于请求体中。通过反射或工具类解析这些参数,并结合`StopWatch`或时间戳计算执行耗时,即可构建完整的日志条目。关键在于处理异常,确保即使接口报错也能记录错误信息。

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
@Aspect
@Component
public class ControllerLogAspect {
private static final Logger logger = LoggerFactory.getLogger(ControllerLogAspect.class);
@Around("execution(* com.example.demo.controller..*(..))")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
String method = request.getMethod();
String uri = request.getRequestURI();
long start = System.currentTimeMillis();
logger.info("Start: {} {} | Params: {}", method, uri, Arrays.toString(joinPoint.getArgs()));
try {
Object result = joinPoint.proceed();
long duration = System.currentTimeMillis() - start;
logger.info("End: {} {} | Duration: {}ms | Result: {}", method, uri, duration, result);
return result;
} catch (Throwable e) {
long duration = System.currentTimeMillis() - start;
logger.error("Error: {} {} | Duration: {}ms | Exception: {}", method, uri, duration, e.getMessage());
throw e;
}
}
}
如何处理敏感数据脱敏与日志格式标准化
在实际生产环境中,直接记录原始请求参数可能导致密码、Token等敏感信息泄露。因此,需要在切面中对特定字段进行脱敏处理,例如将密码替换为`******`。同时,为了便于ELK等日志系统解析,建议将日志输出格式化为JSON结构。可以通过实现`JsonLayout`或使用`logback-spring.xml`配置PatternLayout来实现。此外,对于大体积的请求体,应设置阈值限制,避免日志文件过大影响性能。通过自定义`HttpServletRequestWrapper`可以缓存请求体内容,以便多次读取而不破坏流机制。

import com.fasterxml.jackson.databind.ObjectMapper;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
@Aspect
@Component
public class SensitiveDataLogAspect {
private static final Logger logger = LoggerFactory.getLogger(SensitiveDataLogAspect.class);
private static final ObjectMapper mapper = new ObjectMapper();
@Around("execution(* com.example.demo.controller..*(..))")
public Object logWithMasking(ProceedingJoinPoint joinPoint) throws Throwable {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
Map<String, Object> logData = new HashMap<>();
logData.put("method", request.getMethod());
logData.put("uri", request.getRequestURI());
// 简单脱敏示例:如果参数包含password,则隐藏
Object[] args = joinPoint.getArgs();
for (Object arg : args) {
if (arg instanceof String && arg.toString().contains("password")) {
logData.put("maskedParam", "******");
} else {
logData.put("param", arg);
}
}
logger.info("Request Log: {}", mapper.writeValueAsString(logData));
return joinPoint.proceed();
}
}
基于程序中某个输入、条件或结果的具体问题
当请求体较大或包含嵌套对象时,直接调用`joinPoint.getArgs()`可能会因为序列化开销导致性能下降,或者在某些情况下无法正确获取已消费过的InputStream。此时,若需记录详细的JSON Body,必须使用`ContentCachingRequestWrapper`包装原始请求,并在Filter阶段缓存Body内容。否则,在切面中尝试读取Body会导致后续Controller无法读取,引发“Stream closed”或空指针异常。通过在WebConfig中注册该Filter,可以确保日志记录不干扰正常业务流程,同时准确捕获复杂JSON结构的输入。


















