详解SpringBoot如何实现统一后端返回格式

目录

1.为什么要对SpringBoot返回统一的标准格式
1.1 返回String
1.2 返回自定义对象
1.3 接口异常
2.定义返回对象
3.定义状态码
4.统一返回格式
5.高级实现方式
5.1 ResponseBodyAdvice的源码
5.2 String类型判断

在前后端分离的项目中后端返回的格式一定要友好，不然会对前端的开发人员带来很多的工作量。那么SpringBoot如何做到统一的后端返回格式呢？今天我们一起来看看。

1.为什么要对SpringBoot返回统一的标准格式

在默认情况下，SpringBoot的返回格式常见的有三种：

1.1> @GetMapping("/hello") public String hello() { return "hello"; }

此时调用接口获取到的返回值是这样：

hello

1.2> @GetMapping("/student") public Student getStudent() { Student student = new Student(); student.setId(1); student.setName("didiplus"); return student; } //student的类 @Data public class Student { private Integer id; private String name; }

此时调用接口获取到的返回值是这样：

{"id":1,"name":"didiplus"}

1.3> @GetMapping("/error") public int error(){ int i = 9/0; return i; }

此时调用接口获取到的返回值是这样

SpringBoot的版本是v2.6.7，

2.定义返回对象

package>Uikti /** * 成 功 操 作, 携 带 消 息 */ public static <T> Result<T> success(String message) { return success(message, null); } /** * 成 功 操 作, 携 带 消 息 和 携 带 数 据 */ public static <T> Result<T> success(String message, T data) { return success(ResultCode.RC100.getCode(), message, data); } /** * 成 功 操 作, 携 带 自 定 义 状 态 码 和 消 息 */ public static <T> Result<T> success(int code, String message) { return success(code, message, null); } public static <T> Result<T> success(int code,String message,T data) { Result<T> result = new Result<T>(); result.setCode(code); result.setMsg(message); result.setSuccess(true); result.setData(data); return result; } /** * 失 败 操 作, 默 认 数 据 */ public static <T> Result<T> failure() { return failure(ResultCode.RC100.getMessage()); } /** * 失 败 操 作, 携 带 自 定 义 消 息 */ public static <T> Result<T> failure(String message) { return failure(message, null); } /** * 失 败 操 作, 携 带 自 定 义 消 息 和 数 据 */ public static <T> Result<T> failure(String message, T data) { return failure(ResultCode.RC999.getCode(), message, data); } /** * 失 败 操 作, 携 带 自 定 义 状 态 码 和 自 定 义 消 息 */ public static <T> Result<T> failure(int code, String message) { return failure(ResultCode.RC999.getCode(), message, null); } /** * 失 败 操 作, 携 带 自 定 义 状 态 码 , 消 息 和 数 据 */ public static <T> Result&https://www.easck.com/lt;T> failure(int code, String message, T data) { Result<T> result = new Result<T>(); result.setCode(code); result.setMsg(message); result.setSuccess(false); result.setData(data); return result; } /** * Boolean 返 回 操 作, 携 带 默 认 返 回 值 */ public static <T> Result<T> decide(boolean b) { return decide(b, ResultCode.RC100.getMessage(), ResultCode.RC999.getMessage()); } /** * Boolean 返 回 操 作, 携 带 自 定 义 消 息 */ public static <T> Result<T> decide(boolean b, String success, String failure) { if (b) { return success(success); } else { return failure(failure); } } }

3.定义状态码

package>

4.统一返回格式

>此时调用接口获取到的返回值是这样：

{"success":true,"code":100,"msg":"操作成功","data":"hello","timestamp":1650785058049}

这样确实已经实现了我们想要的结果，我在很多项目中看到的都是这种写法，在Controller层通过Result.success()对返回结果进行包装后返回给前端。这样显得不够专业而且不够优雅。 所以呢我们需要对代码进行优化，目标就是不要每个接口都手工制定Result返回值。

5.高级实现方式

要优化这段代码很简单，我们只需要借助SpringBoot提供的ResponseBodyAdvice即可。

5.1> public interface ResponseBodyAdvice<T> { /** * 是否支持advice功能 * true 支持，false 不支持 */ boolean supports(MethodParameter var1, Class<? extends HttpMessageConverter<?>> var2); /** * 对返回的数据进行处理 */ @Nullable T beforeBodyWrite(@Nullable T var1, MethodParameter var2, MediaType var3, Class<? extends HttpMessageConverter<?>> var4, ServerHttpRequest var5, ServerHttpResponse var6); }

只需要编写一个具体实现类即可

@RestControllerAdvice public class ResponseAdvice implements ResponseBodyAdvice<Object> { @Autowired ObjectMapper objectMapper; @Override public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) { return true; } @SneakyThrows @Override public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) { if (body instanceof String){ return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body)); } return Result.success(ResultCode.RC100.getMessage(),body); } }

需要注意两个地方：

@RestControllerAdvice注解 @RestControllerAdvice是@RestController注解的增强，可以实现三个方面的功能：

全局异常处理
全局数据绑定
全局数据预处理

5.2> if (body instanceof String){ return objectMapper.writeValueAsString(Result.success(ResultCode.RC100.getMessage(),body)); }

这段代码一定要加，如果Controller直接返回String的话，SpringBoot是直接返回，故我们需要手动转换成json。 经过上面的处理我们就再也不需要通过ResultData.success()来进行转换了，直接返回原始数据格式，SpringBoot自动帮我们实现包装类的封装。

@GetMapping("/hello") public String hello() { return "hello,didiplus"; } @GetMapping("/student") public Student getStudent() { Student student = new Student(); student.setId(1); student.setName("didiplus"); return student; }

此时我们调用接口返回的数据结果为：

{ "success": true, "code": 100, "msg": "操作成功", "data": "hello,didiplus", "timestamp": 1650786993454 }

以上就是详解SpringBoot如何实现统一后端返回格式的详细内容，更多关于SpringBoot统一后端返回格式的资料请关注我们其它相关文章！