Spring MVC 教程-ResponseBodyAdvice：对@ResponseBody进行增强

1、前言

上一篇中介绍了RequestBodyAdvice接口，可以对@RequestBody进行增强，本文介绍另外一个相似的接口：ResponseBodyAdvice，这个可以对@ResponseBody进行增强，可以拦截@ResponseBody标注的方法的返回值，对返回值进行统一处理，比如进行加密、包装等操作；比如通过他可以实现统一的返回值。

2、接口如何实现统一返回值？

要求系统中所有返回json格式数据的接口都需要返回下面格式的数据。

    {
      "success": true,
      "code": null,
      "msg": "操作成功!",
      "data": 具体的数据
    }

但是咱们系统中所有的接口返回值都是下面这种格式的，难道咱们要一个个去手动改一下接口的返回值么？

SpringMVC为我们提供了更简单的方法，此时我们可以使用RequestBodyAdvice来实现，拦截所有@ResponseBody接口，将接口的返回值包装一下，包装为统一的格式返回，下面来看具体代码如何实现。

3、案例：通过RequestBodyAdvice实现统一返回值

3.1、git代码位置

    https://gitee.com/javacode2018/springmvc-series

3.2、定义返回值的通用类型

    package com.javacode2018.springmvc.chat14.dto;
    
    /**
     * rest接口通用返回值数据结构
     *
     * @param <T>
     */
    public class ResultDto<T> {
        //接口状态（成功还是失败）
        private Boolean success;
        //错误码
        private String code;
        //提示信息
        private String msg;
        //数据
        private T data;
    
        public Boolean getSuccess() {
            return success;
        }
    
        public void setSuccess(Boolean success) {
            this.success = success;
        }
    
        public String getCode() {
            return code;
        }
    
        public void setCode(String code) {
            this.code = code;
        }
    
        public String getMsg() {
            return msg;
        }
    
        public void setMsg(String msg) {
            this.msg = msg;
        }
    
        public T getData() {
            return data;
        }
    
        public void setData(T data) {
            this.data = data;
        }
    
        public static <T> ResultDto<T> success(T data) {
            return success(data, "操作成功!");
        }
    
        public static <T> ResultDto<T> success(T data, String msg) {
            ResultDto<T> result = new ResultDto<>();
            result.setSuccess(Boolean.TRUE);
            result.setMsg(msg);
            result.setData(data);
            return result;
        }
    
        public static <T> ResultDto<T> error(String msg) {
            return error(null, msg);
        }
    
        public static <T> ResultDto<T> error(String code, String msg) {
            return error(code, msg, null);
        }
    
        public static <T> ResultDto<T> error(String code, String msg, T data) {
            ResultDto<T> result = new ResultDto<>();
            result.setSuccess(Boolean.FALSE);
            result.setCode(code);
            result.setMsg(msg);
            result.setData(data);
            return result;
        }
    }

3.3、自定义一个ResponseBodyAdvice

    package com.javacode2018.springmvc.chat14.config;
    
    import com.javacode2018.springmvc.chat14.dto.ResultDto;
    import org.springframework.core.MethodParameter;
    import org.springframework.core.io.Resource;
    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 java.util.HashSet;
    import java.util.Set;
    
    @ControllerAdvice
    public class ResultDtoResponseBodyAdvice implements ResponseBodyAdvice<Object> {
    
        //不支持的类型列表
        private static final Set<Class<?>> NO_SUPPORTED_CLASSES = new HashSet<>(8);
    
        static {
            NO_SUPPORTED_CLASSES.add(ResultDto.class);
            NO_SUPPORTED_CLASSES.add(String.class);
            NO_SUPPORTED_CLASSES.add(byte[].class);
            NO_SUPPORTED_CLASSES.add(Resource.class);
            NO_SUPPORTED_CLASSES.add(javax.xml.transform.Source.class);
        }
    
        @Override
        public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
            //如果返回值是NO_SUPPORTED_CLASSES中的类型，则不会被当前类的beforeBodyWrite方法处理，即不会被包装为ResultDto类型
            if (NO_SUPPORTED_CLASSES.contains(returnType.getParameterType())) {
                return false;
            } else {
                return true;
            }
        }
    
        @Override
        public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
            return ResultDto.success(body);
        }
    }

需要实现ResponseBodyAdvice接口

类上需要标注@ControllerAdvice注解

springmvc内部会对@ResponseBody方法的返回值进行处理，会先调用ResponseBodyAdvice的supports方法，如果方法返回true，则会进到其beforeBodyWrite方法中，我们在这个方法中将其包装为需求中统一的格式返回。

大家需要注意supports方法，内部排除NO_SUPPORTED_CLASSES中指定的5种类型，这几种类型的返回值不会被处理。

3.4、来个controller测试效果

    @RestController
    public class UserController {
        @RequestMapping("/user")
        public User user() {
            return new User("路人", 30);
        }
    
        @RequestMapping("/user/list")
        public List<User> list() {
            List<User> result = Arrays.asList(new User("SpringMVC系列", 3), new User("SpringBoot系列", 2));
            return result;
        }
    
        @RequestMapping("/user/m1")
        public String m1() {
            return "ok";
        }
    
        @RequestMapping("/user/m2")
        public Integer m2() {
            return 1;
        }
    
        @RequestMapping("/user/m3")
        public ResultDto<String> m3() {
            return ResultDto.success("ok");
        }
    
        public static class User {
            private String name;
            private Integer age;
    
            public User() {
            }
    
            public User(String name, Integer age) {
                this.name = name;
                this.age = age;
            }
    
            public String getName() {
                return name;
            }
    
            public void setName(String name) {
                this.name = name;
            }
    
            public Integer getAge() {
                return age;
            }
    
            public void setAge(Integer age) {
                this.age = age;
            }
    
            @Override
            public String toString() {
                return "User{" +
                        "name='" + name + '\'' +
                        ", age=" + age +
                        '}';
            }
        }
    }

controller中定义了5个接口，来看看他们的返回值，顺便看下他们是否会被ResultDtoResponseBodyAdvice处理为统一的格式呢？

方法/接口	返回值	是否会被ResultDtoResponseBodyAdvice处理？
/user	User	是
/user/list	List<User>	是
/user/m1	String	否
/user/m2	Integer	是
/user/m3	ResultDto	否

3.5、验证接口输出

/user接口： 输出如下，说明被统一处理了

    {
      "success": true,
      "code": null,
      "msg": "操作成功!",
      "data": {
        "name": "路人",
        "age": 30
      }
    }

/user/list接口： 输出如下，说明被统一处理了

    {
      "success": true,
      "code": null,
      "msg": "操作成功!",
      "data": [
        {
          "name": "SpringMVC系列",
          "age": 3
        },
        {
          "name": "SpringBoot系列",
          "age": 2
        }
      ]
    }

/user/m1接口： 输出如下，说明没有被统一处理，直接将controller中方法返回的值直接输出了

ok

/user/m2接口： 输出如下，说明也被统一处理了

    {
      "success": true,
      "code": null,
      "msg": "操作成功!",
      "data": 1
    }

/user/m3接口： 直接返回的是ResultDto类型的，没有被统一处理

    {
      "success": true,
      "code": null,
      "msg": "操作成功!",
      "data": "ok"
    }

4、多个ResponseBodyAdvice指定顺序

当程序中定义了多个ResponseBodyAdvice，可以通过下面2种方式来指定顺序。

方式1 ：使用@org.springframework.core.annotation.Order注解指定顺序，顺序按照value的值从小到大

方式2 ：实现org.springframework.core.Ordered接口，顺序从小到大

5、@ControllerAdvice指定增强的范围

@ControllerAdvice注解相当于对Controller的功能进行了增强，目前来看，对所有的controller方法都增强了。

那么，能否控制一下增强的范围呢？比如对某些包中的controller进行增强，或者通过其他更细的条件来控制呢？

确实可以，可以通过@ControllerAdvice中的属性来指定增强的范围，需要满足这些条件的才会被@ControllerAdvice注解标注的bean增强，每个属性都是数组类型的，所有的条件是或者的关系，满足一个即可。

    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Component
    public @interface ControllerAdvice {
    
    	/**
    	 * 用来指定controller所在的包，满足一个就可以
    	 */
    	@AliasFor("basePackages")
    	String[] value() default {};
    
    	/**
    	 * 用来指定controller所在的包，满足一个就可以
    	 */
    	@AliasFor("value")
    	String[] basePackages() default {};
    
    	/**
    	 * controller所在的包必须为basePackageClasses中同等级或者子包中，满足一个就可以
    	 */
    	Class<?>[] basePackageClasses() default {};
    
    	/**
    	 * 用来指定Controller需要满足的类型，满足assignableTypes中指定的任意一个就可以
    	 */
    	Class<?>[] assignableTypes() default {};
    
    	/**
    	 * 用来指定Controller上需要有的注解，满足annotations中指定的任意一个就可以
    	 */
    	Class<? extends Annotation>[] annotations() default {};
    
    }

扩展知识 ：这块的判断对应的源码如下，有兴趣的可以看看。

    org.springframework.web.method.HandlerTypePredicate#test

6、ResponseBodyAdvice原理

有些朋友可能对@ControllerAdvice和ResponseBodyAdvice的原理比较感兴趣，想研究一下他们的源码，关键代码在下面这个方法中，比较简单，有兴趣的可以去翻阅一下，这里就不展开说了。

    org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#afterPropertiesSet
    org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#initControllerAdviceCache

7、留个问题

当系统异常的时候，如何统一异常的输出呢？这里留给大家去思考一下，可以在留言中发表你的想法。

Java 面试宝典是大明哥全力打造的 Java 精品面试题，它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题，而是一套完整的 Java 知识体系，一套你 Java 知识点的扫盲贴。

它的内容包括：

大厂真题：Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
原创内容：Java 面试宝典内容全部都是大明哥原创，内容全面且通俗易懂，回答部分可以直接作为面试回答内容。
持续更新：一次购买，永久有效。大明哥会持续更新 3+ 年，累计更新 1000+，宝典会不断迭代更新，保证最新、最全面。
覆盖全面：本宝典累计更新 1000+，从 Java 入门到 Java 架构的高频面试题，实现 360° 全覆盖。
不止面试：内容包含面试题解析、内容详解、知识扩展，它不仅仅只是一份面试题，更是一套完整的 Java 知识体系。
宝典详情：https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
宝典总览：https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
宝典进展：https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw

目前 Java 面试宝典累计更新 400+ 道，总字数 42w+。大明哥还在持续更新中，下图是大明哥在 2024-12 月份的更新情况：

想了解详情的小伙伴，扫描下面二维码加大明哥微信【daming091】咨询

同时，大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ，回复【面试题】即可免费领取。

阅读全文