您好,登录后才能下订单哦!
这篇文章主要介绍“SpringBoot怎么实现统一后端返回格式”,在日常操作中,相信很多人在SpringBoot怎么实现统一后端返回格式问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringBoot怎么实现统一后端返回格式”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!
在默认情况下,SpringBoot的返回格式常见的有三种:
@GetMapping("/hello") public String hello() { return "hello"; }
此时调用接口获取到的返回值是这样:
hello
@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"}
@GetMapping("/error") public int error(){ int i = 9/0; return i; }
此时调用接口获取到的返回值是这样
SpringBoot的版本是v2.6.7,
package com.didiplus.common.web.response; import lombok.Data; import java.io.Serializable; /** * Author: didiplus * Email: 972479352@qq.com * CreateTime: 2022/4/24 * Desc: Ajax 返 回 JSON 结 果 封 装 数 据 */ @Data public class Result<T> implements Serializable { /** * 是否返回成功 */ private boolean success; /** * 错误状态 */ private int code; /*** * 错误信息 */ private String msg; /** * 返回数据 */ private T data; /** * 时间戳 */ private long timestamp ; public Result (){ this.timestamp = System.currentTimeMillis(); } /** * 成功的操作 */ public static <T> Result<T> success() { return success(null); } /** * 成 功 操 作 , 携 带 数 据 */ public static <T> Result<T> success(T data){ return success(ResultCode.RC100.getMessage(),data); } /** * 成 功 操 作, 携 带 消 息 */ 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<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); } } }
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; } }
@GetMapping("/hello") public Result<String> hello() { return Result.success("操作成功","hello"); }
此时调用接口获取到的返回值是这样:
{"success":true,"code":100,"msg":"操作成功","data":"hello","timestamp":1650785058049}
这样确实已经实现了我们想要的结果,我在很多项目中看到的都是这种写法,在Controller层通过Result.success()对返回结果进行包装后返回给前端。这样显得不够专业而且不够优雅。 所以呢我们需要对代码进行优化,目标就是不要每个接口都手工制定Result返回值。
要优化这段代码很简单,我们只需要借助SpringBoot提供的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); }
只需要编写一个具体实现类即可
@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注解的增强,可以实现三个方面的功能:
全局异常处理
全局数据绑定
全局数据预处理
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怎么实现统一后端返回格式”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注亿速云网站,小编会继续努力为大家带来更多实用的文章!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。