Spring MVC打印@RequestBody、@Response日志的方法

 更新时间:2019年02月01日 11:40:37   作者:天啦撸  
这篇文章主要介绍了Spring MVC打印@RequestBody、@Response日志的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

问题描述:

使用JSON接收前端参数时, SpringMVC默认输出日志如下:

o.s.web.servlet.DispatcherServlet : POST "/example_project/app/login", parameters={}
parameters={}无法打印出JSON消息内容。

如果自己实现参数打印, 则需要从reqeust.getInputStream中获取JSON内容, 但是由于流只能读取一次, 所以会导致后续SpringMVC解析参数异常。

网上找到一种比较解决方法: 用HttpRequestWrapper重新封装Reqeust, 使打印日志后SpringMVC能正常解析HttpReqeust。这种方法比较麻烦, 这里不去研究

这里主要说说Spring提供的较好的解决方案:

可以通过自定义RequestBodyAdvisor、ResponseBodyAdvisor来实现日志输出。

  • RequestBodyAdvisor可以获取到解析后的Controller方法参数对象。
  • ResponseBodyAdvisor可以获取到Controller方法返回值对象。

然后将他们注册到requestMappingHandlerAdapter:

// 继承WebMvcConfigurationSupport, 重写该方法
@Override
@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
  RequestMappingHandlerAdapter adapter = super.requestMappingHandlerAdapter();
  adapter.setRequestBodyAdvice(Lists.newArrayList(new CustomerRequestBodyAdvisor()));
  adapter.setResponseBodyAdvice(Lists.newArrayList(new CustomerResponseBodyAdvisor()));
  return adapter;
}

另附CustomerRequestBodyAdvisor、CustomerResponseBodyAdvisor日志输出实现参考:

RequestBodyAdvisor实现参考:

// CustomerRequestBodyAdvisor.java
/**
* 打印请求参数日志
*/
public class CustomerRequestBodyAdvisor extends RequestBodyAdviceAdapter {

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

  @Override
  public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 只处理@RequestBody注解了的参数
    return methodParameter.getParameterAnnotation(RequestBody.class) != null;
  }

  @Override
  public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
    Method method = parameter.getMethod();
    
    // 参数对象转JSON字符串
    String jsonBody;
    if (StringHttpMessageConverter.class.isAssignableFrom(converterType)) {
      jsonBody = body.toString();
    } else {
      jsonBody = JSON.toJSONString(body, SerializerFeature.UseSingleQuotes);
    }
    
    // 自定义日志输出
    if (logger.isInfoEnabled()) {
      logger.info("{}#{}: {}", parameter.getContainingClass().getSimpleName(), method.getName(), jsonBody);
      //      logger.info("json request<=========method:{}#{}", parameter.getContainingClass().getSimpleName(), method.getName());
    }
    return super.afterBodyRead(body, inputMessage, parameter, targetType, converterType);
  }
}

ResponseBodyAdvisor实现参考:

// CustomerResponseBodyAdvisor.java
/**
* 打印响应值日志
*/
public class CustomerResponseBodyAdvisor implements ResponseBodyAdvice<Object> {
  private static final Logger logger = LoggerFactory.getLogger(CustomerResponseBodyAdvisor.class);

  @Override
  public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    return AbstractJackson2HttpMessageConverter.class.isAssignableFrom(converterType)
        || returnType.getMethod().isAnnotationPresent(ResponseBody.class);
  }

  @Override
  public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    // 响应值转JSON串输出到日志系统
    if (logger.isInfoEnabled()) {
      logger.info("{}: {}", request.getURI(), JSON.toJSONString(body, SerializerFeature.UseSingleQuotes));
    }
    return body;
  }

}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • java使用RSA工具进行信息加解密

    java使用RSA工具进行信息加解密

    我们在开发中需要对用户敏感数据进行加解密,比如密码等信息,这篇文章主要为大家详细介绍了java如何使用RSA工具进行信息加解密,感兴趣的小伙伴可以了解下
    2023-12-12
  • 使用SpringBoot与Thrift实现RPC通信的方式详解

    使用SpringBoot与Thrift实现RPC通信的方式详解

    在微服务架构的世界里,服务间的通信机制选择成为了关键决策之一,RPC因其简洁、高效的特点备受青睐,本文将详细探讨如何利用Spring Boot和Thrift框架构建RPC通信,让读者理解其内在原理及实现方式,需要的朋友可以参考下
    2023-10-10
  • 简单谈谈Spring Ioc原理解析

    简单谈谈Spring Ioc原理解析

    学习过Spring框架的人一定都会听过Spring的IoC(控制反转) 、DI(依赖注入)这两个概念,对于初学Spring的人来说,总觉得IoC 、DI这两个概念是模糊不清的,是很难理解的,今天和大家分享网上的一些技术大牛们对Spring框架的IOC的理解以及谈谈我对Spring Ioc的理解。
    2018-09-09
  • 深入Java Final

    深入Java Final

    本篇文章,小编将为大家介绍Java Final,有需要的朋友可以参考一下
    2013-04-04
  • java子线程解决获取主线程的request对象问题

    java子线程解决获取主线程的request对象问题

    这篇文章主要介绍了java子线程解决获取主线程的request对象问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • SpringBoot集成SOL链的详细过程

    SpringBoot集成SOL链的详细过程

    Solanaj 是一个用于与 Solana 区块链交互的 Java 库,它为 Java 开发者提供了一套功能丰富的 API,使得在 Java 环境中可以轻松构建与 Solana 区块链交互的应用程序,这篇文章主要介绍了SpringBoot集成SOL链的详细过程,需要的朋友可以参考下
    2025-01-01
  • Java身份证号码校验工具类详解

    Java身份证号码校验工具类详解

    这篇文章主要为大家详细介绍了Java身份证号码校验工具类,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-10-10
  • Java调用GPU算力的实现示例

    Java调用GPU算力的实现示例

    本文主要介绍了Java调用GPU算力的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-03-03
  • Java16 JDK安装并设置环境变量的方法步骤

    Java16 JDK安装并设置环境变量的方法步骤

    突然想起自己大学刚接触java的时候,要下载JDK和配置环境变量,那时候我上网找了很多教学,本文就详细的介绍一下Java16 JDK安装并设置环境变量,感兴趣的可以了解一下
    2021-09-09
  • Java线程的生命周期和状态控制_动力节点Java学院整理

    Java线程的生命周期和状态控制_动力节点Java学院整理

    这篇文章主要介绍了Java线程的生命周期和状态控制,需要的朋友可以参考下
    2017-05-05

最新评论