在 spring 中记录请求日志,最直接且标准的方法是使用 aop(面向切面编程)结合 @around 注解来拦截控制器方法。通过这种方式,可以在请求进入和返回时自动提取 url、参数、耗时及响应状态,而无需在每个 controller 中手动编写日志代码。核心实现依赖于 requestcontextholder 获取当前请求上下文,并利用 proceedingjoinpoint 计算执行时间。

如何配置 AOP 切面以捕获 Controller 输入输出
要捕获 Controller 的输入输出,需要定义一个带有 @Aspect 和 @Component 注解的类,并在方法上使用 @Around("execution(* com.example.controller..*(..))") 这样的切入点表达式。在切面方法内部,通过 RequestContextHolder.getRequestAttributes() 获取 HttpServletRequest 对象,从而读取请求头、URI 和参数。对于返回值,可以通过 proceed() 方法的返回结果直接获取,或者在异常发生时捕获异常信息。这种方法能确保所有经过该包路径的请求都被统一处理。

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
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 RequestLogAspect {
@Around("execution(* com.example.controller.*.*(..))")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
String method = request.getMethod();
String uri = request.getRequestURI();
long start = System.currentTimeMillis();
try {
Object result = joinPoint.proceed();
long duration = System.currentTimeMillis() - start;
System.out.println(String.format("[REQ] %s %s | Duration: %dms", method, uri, duration));
return result;
} catch (Throwable e) {
long duration = System.currentTimeMillis() - start;
System.err.println(String.format("[ERR] %s %s | Error: %s | Duration: %dms", method, uri, e.getMessage(), duration));
throw e;
}
}
}
上述代码展示了完整的切面实现。它首先从上下文中安全地获取当前线程绑定的 Servlet 请求。接着,记录开始时间并执行原始方法 joinPoint.proceed()。如果执行成功,打印请求方法和 URI 以及耗时;如果抛出异常,则记录错误信息和耗时。这种结构保证了无论请求成功与否,都能获得准确的执行时长。
如何处理动态参数与敏感数据脱敏
在实际生产中,直接打印所有参数可能包含密码等敏感信息,且动态参数(如 JSON Body)难以直接通过 HttpServletRequest.getParameterMap() 获取。为了解决这个问题,可以使用 RequestBodyAdvice 或自定义注解配合反射来获取解析后的参数对象。更简单的做法是仅记录非敏感字段,或使用工具类对特定字段进行掩码处理。例如,可以将 password 或 token 字段替换为 ***。此外,对于 GET 请求,URL 中的查询参数可以直接从 request.getQueryString() 获取,但需注意 URL 长度限制和编码问题。
FilePond 是一个 JavaScript 文件上传库,支持通过拖拽、粘贴和 API 方式处理文件、目录、URL 和 Data URI。它包含内置的图像优化功能、异步分块上传功能,并提供了适用于 React、Vue、Angular 和 Svelte 的适配器。

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdviceAdapter;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
@ControllerAdvice
public class SensitiveDataAdvice extends RequestBodyAdviceAdapter {
private final ObjectMapper objectMapper = new ObjectMapper();
@Override
public boolean supports(MethodParameter methodParameter, Type targetType, Class extends HttpMessageConverter>> converterType) {
return methodParameter.hasMethodAnnotation(RequestBody.class);
}
@Override
public Object afterBodyRead(Object body, MethodParameter returnType, MediaType selectedContentType, Class extends HttpMessageConverter>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
if (body instanceof String) {
try {
JsonNode json = objectMapper.readTree((String) body);
if (json.has("password")) {
((ObjectNode) json).put("password", "***");
}
System.out.println("[BODY] " + json.toString());
} catch (Exception e) {
System.out.println("[BODY] Raw string received");
}
}
return body;
}
}
这段代码演示了如何通过 ControllerAdvice 拦截请求体。虽然 RequestBodyAdvice 主要用于转换,但在这里我们利用它在身体读取后进行处理。注意,实际项目中更推荐使用专门的日志框架如 Logback 的 MDC 或自定义 Appender 来处理脱敏,而不是在业务逻辑中硬编码。对于 GET 请求,建议在 AOP 中直接解析 QueryString 并进行简单的关键字过滤。这种分层处理方式确保了敏感数据不会泄露到日志文件中,同时保留了调试所需的上下文信息。
当请求体为空或格式错误时日志记录会怎样
当请求体为空或格式错误(如 JSON 解析失败)时,Spring MVC 会在进入 Controller 之前由 HttpMessageConverter 抛出异常,通常表现为 HttpMediaTypeNotSupportedException 或 HttpMessageNotReadableException。在这种情况下,AOP 切面中的 joinPoint.proceed() 会直接抛出异常,导致无法获取正常的返回值。因此,必须在切面的 catch 块中处理这些异常。此时,日志记录应侧重于记录原始的请求 URI、HTTP 方法以及异常类型,而不是尝试解析无效的请求体。这有助于快速定位客户端发送的数据格式问题,而不是陷入复杂的反序列化逻辑中。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










