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的WeakHashMap源码

    浅谈Java的WeakHashMap源码

    这篇文章主要介绍了浅谈Java的WeakHashMap源码,WeakHashMap,从名字可以看出它是某种 Map,它的特殊之处在于 WeakHashMap 里的entry可能会被GC自动删除,即使程序员没有调用remove()或者clear()方法,需要的朋友可以参考下
    2023-09-09
  • MyBatis if test 判断字符串相等不生效问题

    MyBatis if test 判断字符串相等不生效问题

    这篇文章主要介绍了MyBatis if test 判断字符串相等不生效问题及解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • Java判断是否为闰年的方法示例

    Java判断是否为闰年的方法示例

    这篇文章主要介绍了Java判断是否为闰年的方法示例,本文直接给出示例代码,并讲解了判断原理,需要的朋友可以参考下
    2015-06-06
  • Java 类在 Tomcat 中是如何加载的(过程分析)

    Java 类在 Tomcat 中是如何加载的(过程分析)

    这篇文章主要介绍了Java 类在 Tomcat 中是如何加载的过程分析,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • SpringBoot根据注解动态执行类中的方法实现

    SpringBoot根据注解动态执行类中的方法实现

    本文主要介绍了SpringBoot根据注解动态执行类中的方法实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-08-08
  • java配置多个过滤器优先级以及几个常用过滤器操作

    java配置多个过滤器优先级以及几个常用过滤器操作

    这篇文章主要介绍了java配置多个过滤器优先级以及几个常用过滤器的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • SpringBoot自定义starter实例代码

    SpringBoot自定义starter实例代码

    这篇文章主要给大家介绍了关于SpringBoot自定义starter的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者使用SpringBoot具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-03-03
  • springboot-2.3.x最新版源码阅读环境搭建(基于gradle构建)

    springboot-2.3.x最新版源码阅读环境搭建(基于gradle构建)

    这篇文章主要介绍了springboot-2.3.x最新版源码阅读环境搭建(基于gradle构建),需要的朋友可以参考下
    2020-08-08
  • java枚举类型-Enum

    java枚举类型-Enum

    本文详细介绍了 Java1.5 引入的新特性枚举中的关键字enum,运用大量的代码加以解释,相信可以帮助到正在学习该知识的小伙伴,大家可以参考一下
    2021-08-08
  • Java WebService 简单实例(附实例代码)

    Java WebService 简单实例(附实例代码)

    本篇文章主要介绍了Java WebService 简单实例(附实例代码), Web Service 是一种新的web应用程序分支,他们是自包含、自描述、模块化的应用,可以发布、定位、通过web调用。有兴趣的可以了解一下
    2017-01-01

最新评论