十九、springboot使用@ControllerAdvice深入理解

前言:

接口类项目开发时,为了便于后期查找问题,一般会拦截器或过滤器中记录每个接口请求的参数与响应值记录,
请求参数很容易从request中获取,但controller的返回值无法从response中获取,有一个简单的方法,在controller接口的最后将返回值保存到request域中,这种方法虽然简单,但是开发起来太麻烦,需要在每个controller的最后添加一行代码,且该功能不属于业务功能,不应该接口中去实现,应该有个全局的处理方法。
 
ControllerAdvice是springmvc controller增强器
 
ControllerAdvice三个用处:
1. ModelAttribute: 暴露@RequestMapping 方法返回值为模型数据:放在功能处理方法的返回值上时,是暴露功能处理方法的返回值为模型数据,用于视图页面展示时使用。
2. InitBinder : 用于自定义@RequestMapping 方法参数绑定
3. ResponseBodyAdvice : 用于@ResponseBody返回值增加处理
ControllerAdvice初始化:
Spring mvc 启动时调用RequestMappingHandlerAdapter类的initControllerAdviceCache()方法进行初始化
 
ResponseBodyAdvice : 可以对@ResponseBody的返回值进行加工处理,它是一个接口类,具体处理可以自定义实现类注入到responseBodyAdviceBeans中既可,注入过程由RequestMappingHandlerAdapter类的initControllerAdviceCache去做,开发者只需要自定义实现类实现ResponseBodyAdvice 接口并添加类注解@ControllerAdvice
 

ResponseBodyAdvice

ResponseBodyAdvice是spring4.1的新特性,其作用是在响应体写出之前做一些处理;比如,修改返回值、加密等。

我在项目中的用到@ControllerAdvice,ResponseBodyAdvice的目的,是为每个请求的返回json中修改一个属性值。

  介绍:https://blog.csdn.net/u012852374/article/details/53837156

项目中:

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import com.generalichina.wolong.base.BaseResponse;

@ControllerAdvice
public class ResponseAdvisor implements ResponseBodyAdvice<Object> {

    /**
     * 判断支持的类型 
     */
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    /**
     * 过滤
     * 
     * 此处获取到request 是为了取到在拦截器里面设置的一个对象
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
            Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
            ServerHttpResponse response) {

        String requestPath = request.getURI().getPath();
        
        // 普通response不进行过滤
        if (!requestPath.startsWith("/credit") && !requestPath.startsWith("/product") && !requestPath.startsWith("/user") && !requestPath.startsWith("/jdAfterSale") && !requestPath.startsWith("/commodity") && !requestPath.startsWith("/jdOrder") && !requestPath.startsWith("/jdAddress")) {
            return body;
        }

        //如果是返回客户端模板类不进行过滤
        if (body instanceof BaseResponse) {
            return body;
        }

        return new BaseResponse(body);
    }

}

RequestBodyAdvice和ResponseBodyAdvice

  介绍:https://blog.csdn.net/qq_16504067/article/details/73225005

猜你喜欢

转载自www.cnblogs.com/soul-wonder/p/9084318.html
今日推荐