springboot aop方式打印请求参数与结果(支持POST请求)

本文介绍了一种在SpringBoot中打印HTTP请求参数的方法,适用于GET和POST请求。通过AOP技术实现了请求参数的统一捕获与格式化输出,便于调试。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

    最近用springboot 的方式打印请求参数,网上大多只写了get方式,如果是post请求只打印出了对象,所以我修改了一下,并且为了方便post调试,重写hashmap的toString方法,打印出得参数直接可以放在postman里面进行调试。

    访问目标方法最简单的做法是定义增强处理方法时,将第一个参数定义为JoinPoint类型,当该增强处理方法被调用时,该JoinPoint参数就代表了织入增强处理的连接点。JoinPoint里包含了如下几个常用的方法:

  • Object[] getArgs:返回目标方法的参数

  • Signature getSignature:返回目标方法的签名

  • Object getTarget:返回被织入增强处理的目标对象

  • Object getThis:返回AOP框架为目标对象生成的代理对象

    注意:当使用@Around处理时,我们需要将第一个参数定义为ProceedingJoinPoint类型,该类是JoinPoint的子类。

    写的不好的地方欢迎拍砖,谢谢赐教。


@Aspect
@Configuration//定义一个切面
public class LogRecordAspect {

    private static final Logger logger = LoggerFactory.getLogger(LogRecordAspect.class);

    // 定义切点Pointcut
    @Pointcut("execution(* com.qkhc.chedai.controller..*.*(..))")
    public void excudeService() {
    }




    @Around("excudeService()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();

        String url = request.getRequestURL().toString();
        String method = request.getMethod();
        String uri = request.getRequestURI();
        String queryString = request.getQueryString();
        Object[] args = pjp.getArgs();
        String params = "";
        //获取请求参数集合并进行遍历拼接
        if(args.length>0){
            if("POST".equals(method)){
                Object object = args[0];
                Map map = getKeyAndValue(object);
                params = JSON.toJSONString(map);
;
            }else if("GET".equals(method)){
                params = queryString;
            }
        }


        logger.info("请求开始===地址:"+url);
        logger.info("请求开始===类型:"+method);
        logger.info("请求开始===参数:"+params);

        // result的值就是被拦截方法的返回值
        Object result = pjp.proceed();
        Gson gson = new Gson();
        logger.info("请求结束===返回值:" + gson.toJson(result));
        return result;
    }

    public static Map<String, Object> getKeyAndValue(Object obj) {
        Map<String, Object> map = new MyHashMap<>();
        // 得到类对象
        Class userCla = (Class) obj.getClass();
        /* 得到类中的所有属性集合 */
        Field[] fs = userCla.getDeclaredFields();
        for (int i = 0; i < fs.length; i++) {
            Field f = fs[i];
            f.setAccessible(true); // 设置些属性是可以访问的
            Object val = new Object();
            try {
                val = f.get(obj);
                // 得到此属性的值
                map.put(f.getName(), val);// 设置键值
            } catch (IllegalArgumentException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }

            }
        return map;
    }
}


参考:https://my.oschina.net/itblog/blog/211693 可以了解一下关于aop的详细信息。


<think>嗯,用户问的是如何在Spring Boot中打印请求参数和返回结果。首先,我得回想一下自己以前处理类似需求的经验。记得Spring Boot有拦截器或者过滤器可以用,或者用AOP面向切面编程。不过具体怎么操作呢? 首先,打印请求参数。可能需要获取HTTP请求中的参数,比如GET请求的查询参数,或者POST请求的body体内容。对于GET请求,可以通过HttpServletRequest的getParameterMap来获取参数。对于POST请求,如果是表单提交,也可以用同样的方法,但如果是JSON格式,可能需要读取输入流来获取body内容。不过要注意,输入流一旦读取了,后续处理可能会出问题,所以可能需要用ContentCachingRequestWrapper来缓存请求内容。 然后是关于返回结果。返回结果可能在处理完控制器方法之后,所以可以在拦截器的afterCompletion方法里处理,或者使用ResponseBodyAdvice接口来拦截响应体。或者用AOP的环绕通知,在方法执行前后记录请求和响应。 另外,用户可能需要简单的配置,所以是否有一些现成的库或者注解可以用?比如Spring自带的日志功能,或者使用actuator端点?不过可能用户想要的是自定义的日志输出,所以还是自己实现比较靠谱。 接下来,步骤大概是这样的:创建一个拦截器,在preHandle方法里记录请求的信息,包括URL、方法类型、参数等。对于POST的body,需要用缓存请求包装类,否则输入流只能读一次。然后在afterCompletion方法里记录响应的数据,这时候响应已经发送给客户端了,可以通过ContentCachingResponseWrapper来获取响应内容。 另外,ResponseBodyAdvice可以用来处理返回的对象,这样可以在写入响应之前记录日志。或者使用@ControllerAdvice配合@ResponseBody来修改响应,不过记录日志的话可能用这个不太合适。 对了,还有过滤器(Filter)的方式,比如使用OncePerRequestFilter,在过滤器中包装请求和响应,然后记录日志。不过过滤器是在拦截器之前执行的,可能更底层一些。 具体实现的话,可能需要考虑以下几点: 1. 创建拦截器类实现HandlerInterceptor,重写preHandle和afterCompletion方法。 2. 在preHandle中记录请求参数,处理GET和POST的不同情况。 3. 使用ContentCachingRequestWrapper和ContentCachingResponseWrapper来缓存请求和响应的内容,以便多次读取。 4. 在afterCompletion中获取响应状态码和响应内容。 5. 配置拦截器,将其注册到Spring Boot的拦截器链中。 另外,处理请求体的时候需要注意字符编码问题,否则读取的内容可能会乱码。同时,文件上传之类的请求可能需要特殊处理,避免将文件内容全部记录到日志中,影响性能。 还有,响应内容如果是JSON格式,可能需要将其转换为字符串记录。使用Jackson的ObjectMapper可以做到这一点,或者直接读取缓存的响应内容字节数组,转换成字符串。 测试的时候,可能需要发送不同的请求类型(GET、POST)来验证日志是否正确输出。同时,确保拦截器不会对性能造成太大影响,特别是在高并发的情况下,日志记录应该尽量高效。 可能用户还希望排除某些特定的路径,比如健康检查的端点,或者静态资源,这时候在注册拦截器时可以配置排除的路径模式。 总结下来,实现方法大致有两种:拦截器配合包装类,或者使用AOP。拦截器的方法可能更直接,而AOP可以更灵活地针对特定的控制器方法进行处理。不过用户可能更倾向于使用拦截器的方式,因为能统一处理所有请求。 最后,代码示例应该包括拦截器的实现、包装类的使用、以及如何注册拦截器。同时提醒用户注意性能和大请求体的处理,避免内存溢出。</think>在 Spring Boot 中打印请求参数和返回结果,可以通过以下两种常用方式实现: --- ### **方法一:使用拦截器(Interceptor)** 通过实现 `HandlerInterceptor` 接口,结合请求/响应包装类,记录请求和响应信息。 #### 1. 创建拦截器类 ```java import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @Component public class LogInterceptor implements HandlerInterceptor { // 请求处理前记录参数 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { // 包装请求以缓存请求体(用于后续读取) if (request instanceof ContentCachingRequestWrapper) { ContentCachingRequestWrapper requestWrapper = (ContentCachingRequestWrapper) request; logRequest(requestWrapper); } return true; } // 请求完成后记录响应 @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { ContentCachingResponseWrapper responseWrapper = (ContentCachingResponseWrapper) response; logResponse(responseWrapper); } private void logRequest(ContentCachingRequestWrapper request) { String requestBody = new String(request.getContentAsByteArray(), StandardCharsets.UTF_8); System.out.println("请求参数: " + requestBody); } private void logResponse(ContentCachingResponseWrapper response) { String responseBody = new String(response.getContentAsByteArray(), StandardCharsets.UTF_8); System.out.println("返回结果: " + responseBody); } } ``` #### 2. 配置拦截器注册 ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LogInterceptor()) .addPathPatterns("/**") .excludePathPatterns("/static/**"); // 排除静态资源 } } ``` #### 3. 配置请求/响应包装过滤器 确保请求和响应被包装,以便多次读取内容: ```java import javax.servlet.*; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.stereotype.Component; import org.springframework.web.util.ContentCachingRequestWrapper; import org.springframework.web.util.ContentCachingResponseWrapper; @Component public class ContentCachingFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) { HttpServletRequest req = new ContentCachingRequestWrapper((HttpServletRequest) request); HttpServletResponse res = new ContentCachingResponseWrapper((HttpServletResponse) response); chain.doFilter(req, res); // 确保响应内容写入客户端 res.copyBodyToResponse(); } } ``` --- ### **方法二:使用 AOP 面向切面** 通过 AOP 拦截 Controller 方法,记录入参和返回值。 #### 1. 添加 AOP 依赖 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> ``` #### 2. 定义切面类 ```java import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.springframework.stereotype.Component; @Aspect @Component public class LogAspect { @Around("execution(* com.example.demo.controller.*.*(..))") // 拦截指定包下的Controller public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable { // 打印请求参数 Object[] args = joinPoint.getArgs(); System.out.println("请求参数: " + Arrays.toString(args)); // 执行方法并获取返回值 Object result = joinPoint.proceed(); // 打印返回结果 System.out.println("返回结果: " + result); return result; } } ``` --- ### **注意事项** 1. **性能影响**:频繁记录大请求体或响应体可能影响性能,建议生产环境按需使用。 2. **敏感信息**:避免打印敏感数据(如密码、Token)。 3. **文件上传**:不适用于文件上传请求(避免内存溢出)。 --- 两种方法各有优劣: - **拦截器**:适合全局统一处理,但需处理请求/响应包装。 - **AOP**:更灵活,可针对特定 Controller 或方法,但需依赖 AOP 配置。 根据实际场景选择合适方案即可。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值