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日 下午11:34

相关推荐

  • jquery动画队列怎么实现

    jquery动画队列是一个动画函数队列,把多个的动画任务放到一起,确保只有当前面的任务完成了,才会开始下一个任务;可以对jQuery元素应用fade、slide、animate等动画,当在JQuery对象上调用动画方法时,如果对象正在执行某个动画效果,那么会把后面的动画效果,放在一个队列里面,然后按…

    2022年9月10日
    9500
  • App崩溃的6个常见原因是什么

    人们讨厌应用程序崩溃,尤其是是程序减速或卡死几秒钟这样的现象。根据Dimensional Research的一项调查,61%的用户希望程序在4秒内启动,而49%的用户希望在2秒内响应输入。 如果应用发生崩溃,冻结或报错等现象,53%的用户会将APP卸载。 无论您的对象是消费者还是企业,崩溃问题会令他…

    2022年9月2日
    83600
  • windows deepl如何注册

    deepl注册的方法 1、登陆官方网页,点击右上角的登陆,进行注册。 2、亚洲仅有“日本”可以注册,也就是说中国的无法注册。 3、但不要着急,我们这个时候点击日本,进入到页面之后,可以看到有一个30天的试用。 以上就是关于“windows deepl如何注册”这篇文章的内容,相信大家都有了一定的了解…

    2022年9月26日
    50400
  • Spring框架基于注解怎么开发CRUD

    1. Maven坐标 <!– https://mvnrepository.com/artifact/org.springframework/spring-webmvc –><dependency> <groupId>org.springframework&lt…

    2022年8月27日
    5400
  • autocad2022怎么变成CAD经典

    autocad2022变成CAD经典的方法: 第一步,点击上方共享左侧的“小箭头” 第二步,在弹出菜单下方找到并点击“显示菜单栏”将他关闭。 第三步,点击左上角“工具”,进入“选项板”,关闭“功能区” 第四步,再在“工具”下打开“工具栏”选项,关闭“aotocad”即可。 关于“autocad202…

    2022年9月24日
    16400
  • SQL注入语法有哪些

    仅供参考学习使用。 SQL注入语法 报错注入 updatexml(1,concat(0x7e,(select database()),0x7e),1)–+extractvalue(1,concat(0x7e,(select database()),0x7e),1)–+select count(*…

    2022年9月6日
    11500
  • 如何使用Masscan、Nmap、ELK做内网资产收集

    安装 安装masscan # yum install git gcc make libpcap-devel# git clone https://github.com/robertdavidgraham/masscan# cd masscan# make# cp bin/masscan /bin 安…

    2022年9月8日
    26600
  • windows丢包率高如何解决

    解决方法: 1、有些情况是因为线路故障导致的,这种情况需要和线路的供应商来进行解决。 2、对于设备方面来说,很多都是设置不当和网络接口的光纤收发器故障导致的。 3、还有就是网络的问题,比如病毒和网线的连接距离太长导致的网络故障, 还有操作系统的问题,比如网卡问题和网络运营线路问题,可以尝试使用pin…

    2022年8月29日
    50800
  • 知识库是什么

    知识库是关于产品、服务、部门或主题的自助式在线信息库。为了让大家更好的了解知识库是什么这个问题,下面我们将会围绕:1、企业知识库是什么;2、企业为什么需要知识库;3、知识库的好处有哪些;三点进行展开。 知识库中的数据可以来自任何地方。通常,精通相关主题的贡献者会给知识库增加或扩展内容。内容可以是从你…

    2022年3月18日
    16900
  • cad快速看图标注看不见怎么解决

    cad快速看图标注看不见解决方法: 1.把图纸上传到快看云盘,然后从云盘列表里打开这个图,点左侧的【同步标注】,第一次使用云盘的请先登录账号、创建项目; 2.提示同步成功后,点云盘右上角的【成员】按钮,把对方的CAD快速看图账号添加为成员; 3.添加完成后,再点图纸左侧功能里的【成员协作】&#821…

    2022年9月1日
    33800
联系我们
站长微信
站长微信
分享本页
返回顶部