Spring Boot项目中，对接口请求参数打印日志

在Spring Boot项目中，对接口请求参数打印日志是一种常见的做法，这有助于调试和监控API的行为。以下是一些实现这一功能的方法：

1. 使用AOP（面向切面编程）:

   • 通过Spring AOP，你可以定义一个切面，拦截所有进入Controller的方法，并在方法执行前后打印日志。例如：

     @Aspect
     @Component
     public class LogAspect {
         @Before("execution(* com.yourpackage.*.controller.*.*(..))") // 调整为适合你的包路径和需求
         public void logBefore(JoinPoint joinPoint) {
             // 获取请求参数
             Object[] args = joinPoint.getArgs();
             // 打印日志
             log.info("Request: " + Arrays.toString(args));
         }
     }
     1
     2
     3
     4
     5
     6
     7
     8
     9
     10
     11

2. 使用@ControllerAdvice:

   • 你可以创建一个全局异常处理器，来捕获所有请求并打印日志。

     @ControllerAdvice
     public class GlobalExceptionHandler {
         @AfterEach
         public void logAfterEach(WebRequest request) {
             // 获取请求参数
             String params = request.getParameter("params");
             // 打印日志
             log.info("Request Params: " + params);
         }
     }
     1
     2
     3
     4
     5
     6
     7
     8
     9
     10

3. 使用拦截器（HandlerInterceptor）:

   • 创建一个拦截器，在请求处理前后进行日志记录。

     @Component
     public class LoggingInterceptor implements HandlerInterceptor {
         @Override
         public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
             // 打印请求参数
             log.info("Request Params: " + request.getParameterMap());
             return true;
         }
     }
     1
     2
     3
     4
     5
     6
     7
     8
     9

4. 使用Spring的@ModelAttribute:

   • 在Controller方法中使用@ModelAttribute来获取请求参数，并在方法中打印。

     @GetMapping("/example")
     public String exampleMethod(@ModelAttribute("paramName") String paramValue) {
         log.info("Received param: " + paramValue);
         // 处理业务逻辑
         return "response";
     }
     1
     2
     3
     4
     5
     6

5. 使用Spring Boot Actuator:

   • 如果你正在使用Spring Boot Actuator，它可以提供对应用程序的监控和管理，包括请求日志。

6. 使用日志框架的MDC（Mapped Diagnostic Context）:

   • MDC允许你为每个请求创建一个独立的日志上下文，这样你可以在日志中包含请求特定的信息。

7. 自定义过滤器:

   • 创建一个自定义的过滤器，在请求进入Controller之前打印参数。

     public class CustomFilter implements Filter {
         @Override
         public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
             HttpServletRequest httpServletRequest = (HttpServletRequest) request;
             // 打印请求参数
             log.info("Request Params: " + httpServletRequest.getParameterMap());
             chain.doFilter(request, response);
         }
     }
     1
     2
     3
     4
     5
     6
     7
     8
     9

8. 使用Spring Webflux:

   • 如果你的应用程序是基于响应式编程的，你可以使用Webflux的中间件来记录日志。

每种方法都有其适用场景和优缺点。选择哪种方法取决于你的具体需求和项目结构。记得在生产环境中，记录敏感信息时要格外小心，避免记录如密码、个人信息等敏感数据。