经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring Boot » 查看文章
SpringBoot统一返回格式的方法详解
来源:jb51  时间:2022/8/31 17:25:53  对本文有异议

前言

目前很多项目都是前后端分离,前后端会事先约定好返回格式。那么后端如何做,才能优雅的返回统一格式呢,接下来,请大家跟着我,一步步来实现。

1. 直接返回结果

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

  1. @Data
  2. @AllArgsConstructor
  3. @JsonIgnoreProperties(ignoreUnknown?=?true)
  4. public?class?TestVo?{
  5.  
  6. ????private?static?final?long?serialVersionUID?=?1L;
  7.  
  8. ????@Schema(name?=?"姓名")
  9. ????private?String?name;
  10.  
  11. ????@Schema(name?=?"年龄")
  12. ????private?Integer?age;
  13.  
  14. }
  1. @RestController
  2. @RequestMapping(value?=?"/test")
  3. public?class?TestApi?{
  4.  
  5. ????@GetMapping("/simple")
  6. ????public?TestVo?simple()?{
  7. ????????TestVo?testVo?=?new?TestVo("张三",?30);
  8. ????????return?testVo;
  9. ????}
  10. }

返回结果:

{
    "name": "张三",
    "age": 30
}

2. 约定返回格式

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

  1. {
  2. ????"code":?0,
  3. ????"msg":?"错误信息",
  4. ????"data":?实际返回结果
  5. }

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

  1. @Data
  2. @JsonInclude(JsonInclude.Include.NON_NULL)
  3. public?class?Result<T>?implements?Serializable?{
  4.  
  5. ????private?static?final?long?serialVersionUID?=?1L;
  6.  
  7. ????/**
  8. ?????*?返回编码
  9. ?????*/
  10. ????private?Integer?code;
  11.  
  12. ????/**
  13. ?????*?编码描述
  14. ?????*/
  15. ????private?String?msg;
  16.  
  17. ????/**
  18. ?????*?业务数据
  19. ?????*/
  20. ????private?T?data;
  21.  
  22. ????/**
  23. ?????*?返回成功结果对象
  24. ?????*
  25. ?????*?@param?data
  26. ?????*?@param?<T>
  27. ?????*?@return
  28. ?????*/
  29. ????public?static?<T>?Result<T>?success(T?data)?{
  30. ????????Result?result?=?new?Result();
  31. ????????result.setCode(0);
  32. ????????result.setMsg("success");
  33. ????????result.setData(data);
  34. ????????return?result;
  35. ????}
  36. }

3. 返回统一格式结果

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

  1. @RestController
  2. @RequestMapping(value?=?"/test")
  3. public?class?TestApi?{
  4.  
  5. ????@GetMapping("/withResult")
  6. ????public?Result<TestVo>?withResult()?{
  7. ????????TestVo?testVo?=?new?TestVo("张三",?30);
  8. ????????return?Result.success(testVo);
  9. ????}
  10. }

返回结果:

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

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

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

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

4. 切片封装统一格式

编写注解

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

  1. @Target({ElementType.METHOD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. public?@interface?ApiResult?{
  5. ????String?value()?default?"";
  6.  
  7. ????int?successCode()?default?0;
  8.  
  9. ????String?successMsg()?default?"success";
  10.  
  11. ????Class<??extends?IResult>?resultClass()?default?Result.class;
  12. }

编写ControllerAdvice

  1. @ControllerAdvice
  2. public?class?MyResponseBodyAdvice?implements?ResponseBodyAdvice?{
  3.  
  4. ????protected?boolean?isStringConverter(Class?converterType)?{
  5. ????????return?converterType.equals(StringHttpMessageConverter.class);
  6. ????}
  7.  
  8. ????protected?boolean?isApiResult(MethodParameter?returnType)?{
  9. ????????return?returnType.hasMethodAnnotation(ApiResult.class);
  10. ????}
  11.  
  12. ????@Override
  13. ????public?boolean?supports(MethodParameter?returnType,?Class?converterType)?{
  14. ????????return?!isStringConverter(converterType)?&&?isApiResult(returnType);
  15. ????}
  16.  
  17. ????@Override
  18. ????public?Object?beforeBodyWrite(Object?body,?MethodParameter?returnType,?MediaType?selectedContentType,
  19. ????????????????????????????????Class?selectedConverterType,?ServerHttpRequest?request,?ServerHttpResponse?response)?{
  20. ????????//关键?????????????????????????
  21. ????????return?Result.success(body);
  22. ????}
  23.  
  24. }

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

见证奇迹的时刻到了

  1. @ApiResult
  2. @GetMapping("/withResultHide")
  3. public?TestVo?withResultHide()?{
  4. ????TestVo?testVo?=?new?TestVo("张三",?30);
  5. ????return?testVo;
  6. }

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

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

大功告成!

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

5. 自定义返回格式

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

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

  1. @ApiResult(successCode?=?200,?successMsg?=?"ok")
  2. @GetMapping("/withResultHide")
  3. public?TestVo?withResultHide()?{
  4. ????TestVo?testVo?=?new?TestVo("张三",?30);
  5. ????return?testVo;
  6. }

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

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

场景2:自定义返回格式

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

  1. @Data
  2. @JsonInclude(JsonInclude.Include.NON_NULL)
  3. public?class?ReturnResult<T>?implements?Serializable?{
  4.  
  5. ????private?static?final?long?serialVersionUID?=?1L;
  6.  
  7. ????/**
  8. ?????*?返回编码
  9. ?????*/
  10. ????private?String?returnCode;
  11.  
  12. ????/**
  13. ?????*?编码描述
  14. ?????*/
  15. ????private?String?returnDesc;
  16.  
  17. ????/**
  18. ?????*?业务数据
  19. ?????*/
  20. ????private?T?data;
  21.  
  22. ????/**
  23. ?????*?返回成功结果对象
  24. ?????*
  25. ?????*?@param?data
  26. ?????*?@param?<T>
  27. ?????*?@return
  28. ?????*/
  29. ????public?static?<T>?ReturnResult<T>?success(T?data)?{
  30. ????????ReturnResult?result?=?new?ReturnResult();
  31. ????????result.setReturnCode(0);
  32. ????????result.setReturnDesc("success");
  33. ????????result.setData(data);
  34. ????????return?result;
  35. ????}
  36. }

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

  1. @ApiResult(resultClass?=?ReturnResult.class)
  2. @GetMapping("/withResultHide")
  3. public?TestVo?withResultHide()?{
  4. ????TestVo?testVo?=?new?TestVo("张三",?30);
  5. ????return?testVo;
  6. }

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

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

到此这篇关于SpringBoot统一返回格式的方法详解的文章就介绍到这了,更多相关SpringBoot统一返回格式内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue!

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号