springboot对返回值作统一处理方式(@RestControllerAdvice+ResponseBodyAdvice接口)

最新推荐文章于 2025-04-10 20:07:05 发布
最新推荐文章于 2025-04-10 20:07:05 发布
阅读量1w 收藏 15
点赞数 3
文章标签： spring boot java 返回值处理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xueyijin/article/details/122524335
版权

文章目录

1. 需求

  1. 在使用springboot的使用，我们更加多的方式是返回json数据，直接返回，如下(比如返回一个对象)：

    {
	"username":"小明",
	"sex":"男"
}

  2. 如上例子，是正常的情况下获取的，那如果不正常的情况下，则会抛异常。

  3. 而如今，调用方A调用系统B的时候，系统B出现错误，无法正常返回(如果不特殊处理)json数据，而我调用方A又只想接收json数据，即使报错了，也很想知道到底调用成功与否，能不能统一一下返回值，有什么标志告诉我调用是否成功呢？

  4. 因此，实际上对于系统的返回值，我们可以双方做一些统一，如下：

    {
	"code":"", // 若code 为success则表示调用成功，若不为success说明调用不成功
	"message":"",// 这是专门为了报错的时候，存放报错信息
	"data":"" // 这是专门存放 正常情况下的返回值
}

2. 统一返回值快速入门(代码)

  1. 按照第一大点所说，我们协商定，统一返回值是以如下格式：

    {
	"code":"", // 若code 为success则表示调用成功，若不为success说明调用不成功
	"message":"",// 这是专门为了报错的时候，存放报错信息
	"data":"" // 这是专门存放 正常情况下的返回值
}

  2. 代码：

    @RestController
public class TestController {

    @GetMapping("/test")
    public User test() {
        return new User("小明","男");
    }

}

    @Data
@AllArgsConstructor
public class User {
    private String username;
    private String sex;
}

    @RestControllerAdvice
public class ResponseBodyAdviceTest implements ResponseBodyAdvice<Object> {

    //判断是否要执行beforeBodyWrite方法，true为执行，false不执行
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    //对response处理的执行方法
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 这里面参数很多，一般使用如下几个：
        // body 返回的内容 request 请求 response 响应
        return Response.createResponse(body);
    }

    @Data
    @Builder
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @AllArgsConstructor
    public static class Response<T> {
        private final String code;
        private String message;
        private T data;

        private Response() {
            this.code = "success";
        }

        private Response(T data) {
            this();
            this.data = data;
        }

        public static <T> Response<T> createResponse(T data) {
            return new Response<>(data);
        }

    }
}

    在这里插入图片描述

3. ResponseBodyAdvice接口的细节

0. 实现该接口的类必须要加上@ControllerAdvice或者@RestControllerAdvice controller的切面。

1. ResponseBodyAdvice的supports方法使用

  1. 代码：

    @RestController
public class TestController {

    @GetMapping("/test")
    public User test() {
        return new User("小明","男");
    }

    @GetMapping("/test2")
    public User test2() {
        return new User("小红","男");
    }
}

    package com.king.learning;

import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
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.util.ObjectUtils;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import java.util.Objects;

/**
 * @author JIN
 * @description
 * @createTime 2022-01-16 21:00
 **/
@RestControllerAdvice
public class ResponseBodyAdviceTest implements ResponseBodyAdvice<Object> {

    //判断是否要执行beforeBodyWrite方法，true为执行，false不执行
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    	// 如果方法名字是test则返回true，则执行下面的beforeBodyWrite方法
    	// 如何方法名字不是test，则不执行下面的beforeBodyWrite方法
        return Objects.equals("test", returnType.getMethod().getName());
    }

    //对response处理的执行方法
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        return Response.createResponse(body);
    }

    @Data
    @Builder
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @AllArgsConstructor
    public static class Response<T> {
        private final String code;
        private String message;
        private T data;

        private Response() {
            this.code = "success";
        }

        private Response(T data) {
            this();
            this.data = data;
        }

        public static <T> Response<T> createResponse(T data) {
            return new Response<>(data);
        }

    }
}

    在这里插入图片描述
    在这里插入图片描述

2. 对于String类型的返回值需要特殊处理

  1. 我们知道spring对于controller层返回值是String类型的时候，是使用了StringHttpMessageConverter转换器，无法转换为Json格式。

  2. 代码例子验证：

    @RestController
public class TestController {

    @GetMapping("/test")
    public String test() {
        return "hello world";
    }

    @GetMapping("/test2")
    public String test2() {
        return "hello world";
    }

    @GetMapping("/test3")
    public int test3() {
        return 3;
    }
}

    在这里插入图片描述
    在这里插入图片描述
    由上两个图片，可以看出，String类型的返回值确实没有转json类型。

  3. 因此，在使用封装统一返回值的时候，如果出现String类型的返回值body的时候，且没有特殊处理(即手动转json)，则会报错如下：
    在这里插入图片描述

  4. 因此，再处理返回值的时候，要判如果是String类型，则手动转json，如下：

    @RestControllerAdvice
public class ResponseBodyAdviceTest implements ResponseBodyAdvice<Object> {

    //判断是否要执行beforeBodyWrite方法，true为执行，false不执行
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
//        return Objects.equals("test", returnType.getMember().getName());
        return Objects.equals("test", returnType.getMember().getName());
    }

    //对response处理的执行方法
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    	// 判是否为String
        if (body instanceof String) {
        	// 手动转json 并且返回String，这样子spring不会再处理，直接返回的String即就是json数据了
            return toJson(Response.createResponse(body));
        }
        return Response.createResponse(body);
    }

    private Object toJson(Response response) {
        try {
            return new ObjectMapper().writeValueAsString(response);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("无法转发json格式", e);
        }
    }

    @Data
    @Builder
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @AllArgsConstructor
    public static class Response<T> {
        private final String code;
        private String message;
        private T data;

        private Response() {
            this.code = "success";
        }

        private Response(T data) {
            this();
            this.data = data;
        }

        public static <T> Response<T> createResponse(T data) {
            return new Response<>(data);
        }

    }
}

    在这里插入图片描述

3. 对于出现异常的返回值统一封装注意事项

  1. 如下：在出现错误，则会产生RuntimeException异常，并抛出。

    @RestController
public class TestController {

    @GetMapping("/test")
    public String test() {
        int i = 1/0;
        return "hello world";
    }
    
}

    @RestControllerAdvice
public class ResponseBodyAdviceTest implements ResponseBodyAdvice<Object> {

    //判断是否要执行beforeBodyWrite方法，true为执行，false不执行
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
//        return Objects.equals("test", returnType.getMember().getName());
        return Objects.equals("test", returnType.getMember().getName());
    }

    //对response处理的执行方法
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String) {
            return toJson(Response.createResponse(body));
        }
        return Response.createResponse(body);
    }

    private Object toJson(Response response) {
        try {
            return new ObjectMapper().writeValueAsString(response);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("无法转发json格式", e);
        }
    }

    @Data
    @Builder
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @AllArgsConstructor
    public static class Response<T> {
        private final String code;
        private String message;
        private T data;

        private Response() {
            this.code = "success";
        }

        private Response(T data) {
            this();
            this.data = data;
        }

        public static <T> Response<T> createResponse(T data) {
            return new Response<>(data);
        }

    }
}

    在这里插入图片描述
    完全没有封装统一返回值，为什么呢？
    因为出现错误的时候，是抛出一个异常，抛出异常，然后到RestControllerAdvice，而又没有对异常进行捕捉什么操作，自然继续抛异常，压根就不会进行执行返回值处理方法。

  2. 一种解决方法（不太建议)
    在controller层直接try catch 如果有异常，直接返回e

    @RestController
public class TestController {

    @GetMapping("/test")
    public Object test() {
        try {
            int i = 1/0;
            return "hello world";
        } catch (Exception e){
            return e;
        }
    }
}

    在这里插入图片描述
    虽然这样子可以封装数据，但是controller层的代码变得太啰嗦了，因此我们需要使用spring对异常的统一处理。

  3. 推荐方式(结合spring对异常的统一处理方法)
    spring对异常的统一处理方法可以参考：https://blog.csdn.net/xueyijin/article/details/122527688
    优化代码：

    @RestController
public class TestController {

    @GetMapping("/test")
    public String test() {
        int i = 1 / 0;
        return "hello world";
    }

}

    @RestControllerAdvice
public class MyException {

    @ExceptionHandler(Exception.class)
    public Throwable handleException(Exception e) {
        return e;
    }
}

    @RestControllerAdvice
public class ResponseBodyAdviceTest implements ResponseBodyAdvice<Object> {

    //判断是否要执行beforeBodyWrite方法，true为执行，false不执行
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    	// 这里默认都执行下面beforeBodyWrite 方法，因为我们是作整个系统统一返回值的处理
    	// 反正String问题，异常问题都处理了
        return true;
    }

    //对response处理的执行方法
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof Throwable) {
            return handleException((Throwable) body);
        } else if (body instanceof String) {
            return toJson(Response.createResponse(body));
        }
        return Response.createResponse(body);
    }

    // 针对异常的时候，统一返回值的处理
    private Response<?> handleException(Throwable throwable) {
        return Response.builder()
                .code("failed")
                .message(throwable.getMessage())
                .build();
    }

    private Object toJson(Response<?> response) {
        try {
            return new ObjectMapper().writeValueAsString(response);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("无法转发json格式", e);
        }
    }

    @Data
    @Builder
    @JsonInclude(JsonInclude.Include.NON_NULL)
    @AllArgsConstructor
    public static class Response<T> {
        private final String code;
        private String message;
        private T data;

        private Response() {
            this.code = "success";
        }

        private Response(T data) {
            this();
            this.data = data;
        }

        public static <T> Response<T> createResponse(T data) {
            return new Response<>(data);
        }

    }
}

    在这里插入图片描述

4. 针对访问路径不存在(404)时候的特殊处理

下次再补啦，睡觉觉，明天上班

搏·梦
关注
Spring Boot进阶(45): Spring Boot 开发必备技能：如何优雅地返回统一结果包装！
**My Coding Family**
06-15 2205
Spring Boot 如何返回统一结果包装？一文教会你。
使用@RestControllerAdvice统一处理@ResponseBody的返回前端数据
世间本无路，恒走坦途出
09-08 698
使用@RestControllerAdvice统一处理@ResponseBody的返回前端数据
深入理解 ResponseBodyAdvice 及其应用
最新发布
lcy57__的博客
04-10 1189
ResponseBodyAdvice
@RestControllerAdvice注解和ResponseBodyAdvice接口实现统一处理controller返回
qq_36599564的博客
08-22 5442
@RestControllerAdvice注解可用于扩展Controller层次结构
ResponseBodyAdvice、RequestBodyAdvice与@RestControllerAdvice
Life And Code
08-02 1219
RestControllerAdvice是一个组合注解，由@ControllerAdvice、@ResponseBody组成，而@ControllerAdvice继承了@Component，因此@RestControllerAdvice本质上是个Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法。一个全局的解决方案，免去了我们在Controller处理的繁琐。省略时，默认全局生效。
SpringBoot使用@ControllerAdvice配合ResponseBodyAdvice记录接口请求参数以及返回数据
光滑的秃头
11-20 3029
最近在项目当中需要记录接口请求参数以及返回数据，本来是打算通过自定义切面来实现的，后来发现可以使用@ControllerAdvice配合ResponseBodyAdvice来进行记录数据，特此记录，完整代码如下： /** * @author yichaofan * @since 2020/11/20 12:47 * @apiNote 统一打印请求参数和返回参数日志 */ @ControllerAdvice @Slf4j public class ResponseBodyAnalysis imple
springBoot对返回结果，进行统一处理---ResponseBodyAdvice
weixin_43758193的博客
11-22 9063
ResponseBodyAdvice 是对返回结果进行处理 package com.hq.zhuanche.redisweb.advice; import java.lang.reflect.Method; import org.springframework.core.MethodParameter; import org.springframework.http.MediaType; im...
Spring Boot学习笔记（十九）使用@RestControllerAdvice 统一返回信息格式，统一处理错误返回给前端的信息
TUTsmile的博客
08-25 3874
参考Spring Boot @RestControllerAdvice 统一异常处理、@RestControllerAdvice构造统一返回值格式和统一异常处理、SpringBoot 使用 beforeBodyWrite 实现统一的接口返回类型 1.创建好我们的统一返回格式 //这些是lombok的注解 @Data @NoArgsConstructor @AllArgsConstructor public class CommonResponse<T> { private boolea
Springboot全局异常处理器 @RestControllerAdvice @ExceptionHandler
shenhuxi10000的博客
03-08 652
一、目标： 弄懂为什么springboot需要《全局异常处理器》？ 编码实战一个springboot《全局异常处理器》 封装一个自定义异常 ，并集成进《局异常处理器》 把《全局异常处理器》集成进《接口返回值统一标准格式》 二、springboot为什么需要全局异常处理器？ 先讲下什么是全局异常处理器？ 全局异常处理器就是把整个系统的异常统一自动处理，程序员可以做到不用写try…catch 那...
SpringBoot统一返回值及异常包装
Lailai Monkey的博客
01-29 1170
欢迎使用Markdown编辑器写博客 在项目开发过程中，我们希望所有接口返回值都包含四个元素。 a、code：请求接口的返回码，成功或者异常等返回编码，例如定义请求成功，code = “0000”，code = “1111”; b、message：请求接口的描述，也就是对返回编码的描述，“0000”：表示请求结果为成功，“1111”：表示请求结果为失败，可以根据业务返回异常信息； c、success：true表示接口请求成功，false表示接口请求失败。 d、data：请求接口成功，返回的结果。 自定义返
《框架封装 · 统一异常处理和返回值包装》
山人行
07-07 1445
此篇博文继续介绍框架封装过程在，关于统一异常的处理和返回值包装处理，这本是一个相对常见的需求场景，此处结合实战情况说明，各位看官可一睹为快。技术栈：后端 SpringCloud + 前端 Vue/Nuxt。
一文教你处理SpringBoot统一返回格式
m0_71777195的博客
08-11 2318
复制代码/*** @Description 统一返回值封装*/@Data}}}}}}}}}}}}复制代码/****//*** 操作成功*/RC200(200, "操作成功"),/*** 未授权*/RC401(401, "用户未授权"),/*** 请求被禁止*/RC403(403, "请求被禁止"),/*** 服务异常*/RC500(500, "服务器异常，请联系管理员"),...
Springboot Controller返回值格式统一处理@RestControllerAdvice扩展点使用和原理分析
万物皆字节
07-25 1244
在Springboot中如果想对返回值和controller返回的一场做统处理，可以尝试 @RestControllerAdvice这个扩展点
SpringBoot使用ResponseBodyAdvice进行统一响应处理
BlueKitty的博客
08-02 7808
适用场景 , 返回给调用方一个统一的响应对象 , 即Controller中使用了@ResponseBody注解的方法 , 可以随意返回Object , String , List 等 , 在该对象中进行统一处理并返回 package com.xbz.common.web.exception; import com.alibaba.fastjson.JSONObject; import org...
SpringBoot项目实战经验之@ControllerAdvice+ResponseBodyAdvice实现响应体全局统一处理
Simon's Blog
07-29 1281
在实际项目开发中，经常需要对向前台返回的响应体进行处理，例如包装为通用返回类型等。Spring中提供了 @ControllerAdvice+ResponseBodyAdvice 的解决方案 对响应体进行全局统一处理，可以避免在controller层对业务代码入侵。 代码示例 /** * @Author zhangting * @Desc 响应body全局统一处理 * @Date 2020/07/29 **/ @Slf4j @ControllerAdvice(basePackages = "com.
Spring Boot 统⼀数据返回格式
q322359的博客
12-01 1416
我们在开始项目时，要和前端约定好接口的相关结构，其中约定接口返回数据的格式是很重要的，涉及到数据能否正确传输，而我们后端返回统一的数据格式，可以为前后端的交流以及项目的开发省去很多的麻烦响应通知类 -
@RestControllerAdvice 注解 详解
随风why
04-12 1807
接口是 Spring 框架中用于处理响应体的拦截器接口，用于对所有控制器返回的响应数据进行统一处理，可以修改或者增加响应内容。是 Spring 框架中一个用于统一处理控制器异常和返回结果的注解，它可以被用来定义全局异常处理程序和全局响应结果处理程序。注解所标注的类将会被自动调用，并根据异常类型和处理程序的注解来决定如何处理该异常。注解所标注的类也将会被调用，根据返回数据的类型和处理程序的注解来决定如何处理该数据。注解所标注的类也将会被调用来处理该数据，并返回处理后的响应数据。注解所标注的类中，可以通过。
ResponseBodyAdvice
weixin_41314762的博客
03-24 432
ResponseBodyAdvice 接口是在 Controller 执行 return 之后，在 response 返回给客户端之前，执行的对 response 的一些处理，可以实现对 response 数据的一些统一封装或者加密等操作。上面代码表示，如果方法名上面有ResponseResult注解或者方法所属类包含ResponseResult注解，此时就返回TRUE，执行beforeBodyWrite方法。（2）beforeBodyWrite —— 对 response 处理的具体执行方法。
【Java】SpringMVC ResponseBodyAdvice详解
weixin_45734473的博客
09-27 3840
【Java】SpringMVC ResponseBodyAdvice详解
在springboot项目中@RestControllerAdvice注解详解
09-07
@RestControllerAdvice 是一个用于全局异常处理和统一返回结果的注解。在 Spring Boot 项目中，我们可以通过 @RestControllerAdvice 注解来定义一个全局的异常处理类。 使用 @RestControllerAdvice 注解的类可以包含以下几个注解： 1. @ExceptionHandler：用于处理特定异常类型的方法。 2. @InitBinder：用于在控制器中初始化 WebDataBinder 的方法。 3. @ModelAttribute：将键值对添加到全局的 Model 中。 4. @ResponseBody：将方法的返回值作为响应体。 当项目中发生异常时，@RestControllerAdvice 注解的类会捕获到异常并根据具体的异常类型执行相应的处理方法。这样可以实现全局的异常处理，避免在每个接口中都写异常处理逻辑。 下面是一个简单的示例代码： ```java @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) public ResponseEntity<String> handleException(Exception e) { // 异常处理逻辑 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage()); } } ``` 在上面的代码中，使用 @ExceptionHandler 注解来定义了一个处理 Exception 类型异常的方法。当项目中出现 Exception 类型的异常时，会执行该方法，并返回一个带有异常信息的 ResponseEntity 对象。 注意：@RestControllerAdvice 注解只会扫描被 @Controller 或 @RestController 注解的类。因此，确保你的全局异常处理类被正确扫描并起作用。 希望能帮到你！如有其他问题，请继续提问。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值