SpringBoot统一返回格式怎么实现

SpringBoot统一返回格式怎么实现

1. 直接返回结果

先看一下最基本的例子,直接将结果原封不动返回:

@Data@AllArgsConstructor@JsonIgnoreProperties(ignoreUnknown = true)public class TestVo {    private static final long serialVersionUID = 1L;    @Schema(name = "姓名")    private String name;    @Schema(name = "年龄")    private Integer age;}
@RestController@RequestMapping(value = "/test")public class TestApi {    @GetMapping("/simple")    public TestVo simple() {        TestVo testVo = new TestVo("张三", 30);        return testVo;    }}

返回结果:

{
“name”: “张三”,
“age”: 30
}

2. 约定返回格式

假如已经与前端开发妹子约定好了格式,比如:

{    "code": 0,    "msg": "错误信息",    "data": 实际返回结果}

那么我们首先需要编写一个封装结果类Result。为了方便封装,在这个类中增加一个success方法:

@Data@JsonInclude(JsonInclude.Include.NON_NULL)public class Result<T> implements Serializable {    private static final long serialVersionUID = 1L;    /**     * 返回编码     */    private Integer code;    /**     * 编码描述     */    private String msg;    /**     * 业务数据     */    private T data;    /**     * 返回成功结果对象     *     * @param data     * @param <T>     * @return     */    public static <T> Result<T> success(T data) {        Result result = new Result();        result.setCode(0);        result.setMsg("success");        result.setData(data);        return result;    }}

3. 返回统一格式结果

后台接口代码微调一下,返回值改为Result,泛型为原返回值的类型:

@RestController@RequestMapping(value = "/test")public class TestApi {    @GetMapping("/withResult")    public Result<TestVo> withResult() {        TestVo testVo = new TestVo("张三", 30);        return Result.success(testVo);    }}

返回结果:

{
“code”: 0,
“msg”: “success”,
“data”: {
“name”: “张三”,
“age”: 30
}
}

至此,返回结果完美符合格式。

但是这样的代码并不算简洁:每个接口的返回值都必须是Result<>,并且return的时候都要用Result.success()方法封装一下。

那么,有没有更优雅的方法?我们继续往下看:

4. 切片封装统一格式

编写注解

实际使用场景中,并不是所有接口都需要统一格式。我们这里使用一个注解作为开关,按需控制接口返回格式。

@Target({ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ApiResult {    String value() default "";    int successCode() default 0;    String successMsg() default "success";    Class<? extends IResult> resultClass() default Result.class;}

编写ControllerAdvice

@ControllerAdvicepublic class MyResponseBodyAdvice implements ResponseBodyAdvice {    protected boolean isStringConverter(Class converterType) {        return converterType.equals(StringHttpMessageConverter.class);    }    protected boolean isApiResult(MethodParameter returnType) {        return returnType.hasMethodAnnotation(ApiResult.class);    }    @Override    public boolean supports(MethodParameter returnType, Class converterType) {        return !isStringConverter(converterType) && isApiResult(returnType);    }    @Override    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,                                Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {        //关键                                 return Result.success(body);    }}

这里有一点要注意,这个advice中supports方法中判断返回结果类型必须为非String类型。如果返回结果为String类型,那么result要转为json字符串后再返回,需要再写一个advice。

见证奇迹的时刻到了

@ApiResult@GetMapping("/withResultHide")public TestVo withResultHide() {    TestVo testVo = new TestVo("张三", 30);    return testVo;}

这段代码与最开始一样,并没有返回Result,仅仅加上了@ApiResult注解,我们看返回结果:

{
“code”: 0,
“msg”: “success”,
“data”: {
“name”: “张三”,
“age”: 30
}
}

大功告成!

以上只是最精简的例子,实际使用中还结合了 统一异常封装、自定义返回格式 等功能。我们注意到@ApiResult注解中,有三个参数:successCode、successMsg、resultClass,就是为了自定义返回格式预留的,下面再看两个场景:

5. 自定义返回格式

场景1:返回成功时code为200

如果个别接口的返回格式与默认格式相同,但是要求code等于200时才代表成功,那么修改下successCode参数即可:

@ApiResult(successCode = 200, successMsg = "ok")@GetMapping("/withResultHide")public TestVo withResultHide() {    TestVo testVo = new TestVo("张三", 30);    return testVo;}

返回成功时,结果中的code和msg都变为设置的值:

{
“code”: 200,
“msg”: “ok”,
“data”: {
“name”: “张三”,
“age”: 30
}
}

场景2:自定义返回格式

如果某个接口的返回格式不是默认的返回格式,比如约定返回returnCode、returnDesc、data(对应默认的code、msg、data)。那么则需要新增一个返回结果类,比如ReturnResult:

@Data@JsonInclude(JsonInclude.Include.NON_NULL)public class ReturnResult<T> implements Serializable {    private static final long serialVersionUID = 1L;    /**     * 返回编码     */    private String returnCode;    /**     * 编码描述     */    private String returnDesc;    /**     * 业务数据     */    private T data;    /**     * 返回成功结果对象     *     * @param data     * @param <T>     * @return     */    public static <T> ReturnResult<T> success(T data) {        ReturnResult result = new ReturnResult();        result.setReturnCode(0);        result.setReturnDesc("success");        result.setData(data);        return result;    }}

然后修改接口上的@ApiResult注解中的resultClass属性

@ApiResult(resultClass = ReturnResult.class)@GetMapping("/withResultHide")public TestVo withResultHide() {    TestVo testVo = new TestVo("张三", 30);    return testVo;}

这时,返回结果就变为想要的格式了:

{
“returnCode”: “0”,
“returnDesc”: “success”,
“data”: {
“name”: “张三”,
“age”: 30
}
}

感谢各位的阅读,以上就是“SpringBoot统一返回格式怎么实现”的内容了,经过本文的学习后,相信大家对SpringBoot统一返回格式怎么实现这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是亿速云,小编将为大家推送更多相关知识点的文章,欢迎关注!

文章标题:SpringBoot统一返回格式怎么实现,发布者:亿速云,转载请注明出处:https://worktile.com/kb/p/22015

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
亿速云的头像亿速云认证作者
上一篇 2022年8月31日 下午11:33
下一篇 2022年8月31日

相关推荐

  • mysql substring()函数如何用

    在mysql中,substring()函数用于截取字符串,可以从字符串从特定位置开始返回一个给定长度的子字符串,语法为“SUBSTRING(字符串,n)”,参数“n”的值需要是一个整数,用于指定子串的起始字符,可以为负值。若参数“n”为负值,则子串的位置起始于字符串结尾的第n个字符,即倒数第n个字符…

    2022年9月26日
    1.4K00
  • jquery怎么删除option

    具体步骤如下: 1.首先,新建一个html项目,并在项目中引入jquery; <script type=”text/javascript” src=”/static/jquery-2.1.4.min.js”></script> 2.引入jquery后,在项目中创建一个opti…

    2022年8月29日
    50500
  • MySQL数据库JDBC编程知识点有哪些

    1.JDBC前置工作 1.1准备好MySQL驱动包 MySQL的jdbc驱动包我们可以去官网下载,我们也可以maven中央仓库下载,这个maven中央仓库是什么呢?你可以理解为我们手机中的“应用商店”软件,它的作用和应用商店的作用是差不多的,只不过手机应用商店里面是手机软件,而maven中央仓库里面…

    2022年9月15日
    53300
  • Redis的共享session应用如何实现短信登录

    1. 基于 session 实现短信登录 1.1 短信登录流程图 1.2 实现发送短信验证码 前端请求说明: 说明 请求方式 POST 请求路径 /user/code 请求参数 phone(电话号码) 返回值 无 后端接口实现: @Slf4j@Servicepublic class UserServ…

    2022年8月31日
    48800
  • windows KB4524151更新了哪些内容

    KB4524151补丁主要更新: 更新可能导致打印作业失败的打印假脱机程序服务的间歇性问题。 KB4524151改进与修补程序: 此安全更新程序包括质量改进。 关键更改包括: ● 解决可能导致打印作业失败的打印假脱机程序服务的间歇性问题。 ● 某些应用程序可能关闭或生成错误,例如远程过程调用 (RP…

    2022年9月1日
    32600
  • windows默认网关不可用怎么修复

    修复方法: 名列前茅步:右击windows,选择设备管理器。 第二步:点击系统设置,找到intel(R)management右击,双击属性。 第三步:点击电源管理,将节约电源(A)取消勾选。 第四步:打开网络管理中心,选择更改适配器选项。 第五步:右击以太网,点击属性。 第六步:选择协议版本4,双击…

    2022年9月21日
    77500
  • MySQL中的查询优化器怎么用

    对于一个SQL语句,查询优化器先看是不是能转换成JOIN,再将JOIN进行优化 优化分为:1. 条件优化,2.计算全表扫描成本,3. 找出所有能用到的索引,4. 针对每个索引计算不同的访问方式的成本,5. 选出成本最小的索引以及访问方式 一、开启查询优化器日志 — 开启set optimizer_…

    2022年9月15日
    52100
  • web中常用的加密算法有哪些

    加密算法我们整体可以分为:可逆加密和不可逆加密,可逆加密又可以分为:对称加密和非对称加密。 一、不可逆加密 常见的不可逆加密算法有MD5,HMAC,SHA1、SHA-224、SHA-256、SHA-384,和SHA-512,其中SHA-224、SHA-256、SHA-384,和SHA-512我们可以…

    2022年8月29日
    1.0K00
  • Redis环境搭建和使用的方法

    一、常见的非关系型数据库NOSQL分类 NOSQL类型 主要数据库产品 类型特色 K-V键值对存储类型 Redis、Memcached 使用key可以快速的查询到value,Memcached可以支持String类型的值value,Redis支持的值的数据类型很多如:Stringsethashsor…

    2022年9月18日
    92500
  • 【缺陷周话】第31期:错误的内存释放

    1、错误的内存释放方法 C语言中常见的内存申请函数包括malloc()、 realloc()、 calloc(),它们虽然功能不同,但都对应同一个内存释放函数 free(),C++中对内存的申请和释放采用new/delete、new []/delete[] 方式。不管是 C 语言还是 C++ 语言,…

    2022年9月20日
    49200
站长微信
站长微信
电话联系

400-800-1024

工作日9:30-21:00在线

分享本页
返回顶部