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

更新時間：2019年02月01日 11:40:37 作者：天啦擼

這篇文章主要介紹了Spring MVC打印@RequestBody、@Response日志的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

問題描述：

使用JSON接收前端參數(shù)時， SpringMVC默認輸出日志如下：

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

如果自己實現(xiàn)參數(shù)打印，則需要從reqeust.getInputStream中獲取JSON內容，但是由于流只能讀取一次，所以會導致后續(xù)SpringMVC解析參數(shù)異常。

網上找到一種比較解決方法：用HttpRequestWrapper重新封裝Reqeust，使打印日志后SpringMVC能正常解析HttpReqeust。這種方法比較麻煩, 這里不去研究

這里主要說說Spring提供的較好的解決方案：

可以通過自定義RequestBodyAdvisor、ResponseBodyAdvisor來實現(xiàn)日志輸出。

RequestBodyAdvisor可以獲取到解析后的Controller方法參數(shù)對象。
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日志輸出實現(xiàn)參考:

RequestBodyAdvisor實現(xiàn)參考：

// CustomerRequestBodyAdvisor.java
/**
* 打印請求參數(shù)日志
*/
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注解了的參數(shù)
    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();
    
    // 參數(shù)對象轉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實現(xiàn)參考:

// 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串輸出到日志系統(tǒng)
    if (logger.isInfoEnabled()) {
      logger.info("{}: {}", request.getURI(), JSON.toJSONString(body, SerializerFeature.UseSingleQuotes));
    }
    return body;
  }

}

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: