计算机系统应用教程网站

网站首页 > 技术文章 正文

基于Spring Boot的快速开发脚手架的开发(5)

btikc 2024-09-30 13:15:57 技术文章 15 ℃ 0 评论

上一篇大家看到了使用swagger展现Restful接口的便利性。

大家同样可以看到Restful接口返回给前端的结果是将Controller层方法的返回值直接返给前端,这样做可能会有以下缺陷:

  1. 前台需要根据http的状态判断请求是否正确,无法从请求层面区分是业务错误还是网络错误
  2. 前端对http请求的知识依赖增大
  3. 对自定义的错误请求需要和业务数据混合在一起(数据混合或者变量公用,等等)

所以一般情况下,开发框架层面会提供一个标准的请求返回格式。最基本的这种返回格式由一下几个属性组成:

  1. code,返回码,用于标识出当前请求的状态
  2. message,返回消息,用于补充说明当前请求的状态
  3. success,成功与否的标识为,用于快速判断请求是否发生业务处理错误
  4. data,返回数据,承载了成功后的正常数据,或者异常时的数据(降级数据,补偿数据,异常信息,等等)。

代码其实也很简单,可以直接参考:

https://github.com/dean2015/chinacat-boot-model

实际使用时,直接使用controller层返回RestResponse即可。

在之前的chinacat-samples工程的chinacat-sample-rest模块中的controller里,添加如下红框种的代码

运行应用,打开swagger界面(http://your-IP:your-port/swagger-ui.html)

执行 /hello1的Restful接口,得到的结果将按照下面格式返回

样例代码参考:

https://github.com/dean2015/chinacat-samples

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表