spring boot 统一返回,springboot全局统一返回

1.为什么要对跳羚返回统一的标准格式1.1 返回字符串1.2返回自定义对象1.3 接口异常2.定义返回对象3.定义状态码4.统一返回格式5.高级实现方式5.1回应和建议的源码5.2字符串类型判断在前后端分离的项目中后端返回的格式一定要友好，不然会对前端的开发人员带来很多的工作量。那么跳羚如何做到统一的后端返回格式呢？今天我们一起来看看。

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

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

1.1 返回String

@GetMapping(/hello )公共字符串hello(){ return hello ；}此时调用接口获取到的返回值是这样：

　　喂

1.2 返回自定义对象

@GetMapping(/student )公立学生get Student(){ Student Student=新生()；学生。setid(1)；学生。集合名称(滴滴加)；返校生；}//学生的类@Datapublic class Student {私有整数id；私有字符串名称；}此时调用接口获取到的返回值是这样：

　　{id:1， name:didiplus}

1.3 接口异常

@ get mapping(/error )public int error(){ int I=9/0；返回我；}此时调用接口获取到的返回值是这样

　　跳羚的版本是v2.6.7，

2.定义返回对象

包com。滴滴加。常见。网络。回应；进口龙目岛。数据；导入Java。io。可序列化；/* * *作者：滴滴加*邮箱： 972479352@qq.com *创建时间： 2022/4/24 * desc :阿贾克斯返回数据结果封装数据*/@Datapublic类结果t实现可序列化的{ /** *是否返回成功*/私有布尔成功；/** * 错误状态*/私有整数代码；/*** * 错误信息*/私有字符串消息；/** * 返回数据*/私人测试数据；/** * 时间戳*/私有长时间戳；公共结果(){ this。时间戳=系统。当前时间毫秒()；} /** * 成功的操作*/公共静态测试结果成功(){返回成功(空)；} /** * 成功操作，携带数据*/公共静态测试结果t成功(测试数据){返回成功(结果代码.RC100.getMessage()，数据);} /** * 成功操作，携带消息*/公共静态测试结果成功(字符串消息){返回suc

　　cess(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<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 com.didiplus.common.web.response;import lombok.Getter;/** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/24 * Desc: 统 一 返 回 状 态 码 */public enum ResultCode { /**操作成功**/ RC100(100,"操作成功"), /**操作失败**/ RC999(999,"操作失败"), /**服务限流**/ RC200(200,"服务开启限流保护,请稍后再试!"), /**服务降级**/ RC201(201,"服务开启降级保护,请稍后再试!"), /**热点参数限流**/ RC202(202,"热点参数限流,请稍后再试!"), /**系统规则不满足**/ RC203(203,"系统规则不满足要求,请稍后再试!"), /**授权规则不通过**/ RC204(204,"授权规则不通过,请稍后再试!"), /**access_denied**/ RC403(403,"无访问权限,请联系管理员授予权限"), /**access_denied**/ RC401(401,"匿名用户访问无权限资源时的异常"), /**服务异常**/ RC500(500,"系统异常，请稍后重试"), INVALID_TOKEN(2001,"访问令牌不合法"), ACCESS_DENIED(2003,"没有权限访问该资源"), CLIENT_AUTHENTICATION_FAILED(1001,"客户端认证失败"), USERNAME_OR_PASSWORD_ERROR(1002,"用户名或密码错误"), UNSUPPORTED_GRANT_TYPE(1003, "不支持的认证模式"); /**自定义状态码**/ @Getter private final int code; /** * 携 带 消 息 */ @Getter private final String message; /** * 构 造 方 法 */ ResultCode(int code, String message) { this.code = code; this.message = message; }}

4.统一返回格式

 @GetMapping("/hello") public Result<String> hello() { return Result.success("操作成功","hello"); }

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

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

　　

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

5.高级实现方式

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

5.1 ResponseBodyAdvice的源码

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);}

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

@RestControllerAdvicepublic 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 String类型判断

 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统一后端返回格式的资料请关注盛行IT其它相关文章！

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。