springboot ResponseBodyAdvice说明

逃离我推掉我的手 2022-08-29 00:26 112阅读 0赞

--------------------

## **springboot ResponseBodyAdvice说明** ##

**应用：处理控制器返回的json数据**

## \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ##

**相关类与接口**

**ResponseBodyAdvice**

public interface ResponseBodyAdvice<T> {
        boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2);
                         //beforeBodyWrite之前调用，判断是否执行beforeBodyWrite方法
    
        @Nullable
        T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6);
    }

## \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ##

**示例**

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**dto 层**

**ResponseResult**

@Data
    public class ResponseResult {
    
        private String status;
        private String code;
        private String errorMsg;
        private Object data;
    
        public ResponseResult(String status, String code, String errorMsg, Object data){
            this.status=status;
            this.code=code;
            this.errorMsg=errorMsg;
            this.data=data;
        }
    
        public static ResponseResult success(Object data){
            return new ResponseResult("success","000000",null,data);
        }
    
        public static ResponseResult error(Exception e){
            return new ResponseResult("error","111111",e.getMessage(),null);
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**advice 层**

**CustomResponseBodyAdvice**

@RestControllerAdvice(basePackages = {"com.example.demo.controller"})
    public class CustomResponseBodyAdvice implements ResponseBodyAdvice {
    
        @Override
        public boolean supports(MethodParameter methodParameter, Class aClass) {
            System.out.println("supports "+aClass.getSimpleName());
            return true;
        }
    
        @Override
        public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
            System.out.println("beforeBodyWrite "+o);
            System.out.println("beforeBodyAdvice "+mediaType.getType());
    
            if (MediaType.APPLICATION_JSON.equals(mediaType)){
                return JSON.toJSONString(ResponseResult.success(o));
            }
    
            return o;
        }
    
        @ExceptionHandler
        public ResponseResult handleError(Exception e){
            return ResponseResult.error(e);
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**controller 层**

**HelloController**

@RestController
    public class Hello2Controller {
    
        @RequestMapping("/get")
        public String hello(){
            return "success";
        }
    
        @RequestMapping("/get2")
        public String hello2(){
            throw new RuntimeException("出错了");
        }
    }

## \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ##

**测试输出**

**localhost:8080/hello，控制台输出：**

supports StringHttpMessageConverter
    beforeBodyWrite success
    beforeBodyAdvice application

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70][]

**localhost:8080/hello2，由于报错控制台无输出**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70]: /images/20220829/e0cd8f6a40454598a37085a903a9028d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1]: /images/20220829/90fa9bdb276945d0809c0d9b614dd685.png