如何优雅的设计 API 接口,实现统一格式返回?

>>强大,10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程!

点击关注公众号,实用技术文章及时了解如何优雅的设计 API 接口,实现统一格式返回?

来源:老顾聊技术

前言

在移动互联网,分布式,微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前分离分离方式

一般系统的大致整体架构图如下:

如何优雅的设计 API 接口,实现统一格式返回?

需要说明的是,有些小伙伴会回复说,这个架构太简单了吧,太low了,什么网关啊,缓存啊,消息中间件啊,都没有。因为主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。

接口相互作用

前端和前端进行交互,前端按约定的请求URL路径,并合并相关参数,进入服务器接收请求,进行业务处理,返回数据给前端。

针对URL路径的restful风格,以及引用参数的公共请求头的要求(如:app_versionapi_versiondevice等),这里就不介绍了,小伙伴们可以自行去了解,也比较简单。

前端服务器如何实现把数据返回给前端?

返回格式

最初返回给前端我们一般用JSON体方式,定义如下:

{
  #返回状态码
  code:integer,
  #返回信息描述
  message:string,
  #返回值
  data:object
}
CODE状态码

code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。

如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了

我们应该可以参考HTTP请求返回的状态码

下面是常见的HTTP状态码:

  • 200 - 请求成功
  • 301 - 资源(网页等)被永久转移到其它URL
  • 404 - 请求的资源(网页等)不存在
  • 500 - 内部服务器错误
如何优雅的设计 API 接口,实现统一格式返回?

我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4个数字。

  • 1000~1999 区间表示参数错误
  • 2000~2999 区间表示用户错误
  • 3000~3999 区间表示接口异常

这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据消息相关的信息描述,可以快速定位。

资讯

这个相对相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如

如何优雅的设计 API 接口,实现统一格式返回?

再在枚举中定义,状态码

如何优雅的设计 API 接口,实现统一格式返回?

状态码和信息就会一一对应,比较好维护。

数据

返回数据体,JSON格式,根据不同的业务又不同的JSON体。

我们要设计一个返回体类结果

如何优雅的设计 API 接口,实现统一格式返回?

控制层控制器

我们会在控制器层处理业务请求,并返回给前端,以orderorder为例

如何优雅的设计 API 接口,实现统一格式返回?

我们看到在获得订单对象之后,我们是用的结果构造方法进行包装赋值,然后进行返回。小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。

美观美化

我们可以在结果类中,加入静态方法,一看就懂

如何优雅的设计 API 接口,实现统一格式返回?

那我们来改造一下Controller

如何优雅的设计 API 接口,实现统一格式返回?

代码是不是比较简洁了,也美观了。

优雅优化

上面我们看到在结果类中增加了静态方法,正确的业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题:

1,每个方法的返回都是Result封装对象,没有业务含义

2,在业务代码中,成功的时候我们调用Result.success,异常错误调用Result.failure。是不是很多余

3,上面的代码,判断id是否为null,实际上我们可以使用hibernate validate做校验,没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图

如何优雅的设计 API 接口,实现统一格式返回?

这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢?

实现方案

小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情

1,定义一个注解@ResponseResult,表示此接口返回的值需要包装一下

2,拦截请求,判断此请求是否需要被@ResponseResult注解

3,核心步骤就是实现接口ResponseBodyAdvice@ControllerAdvice,判断是否需要包装返回值,如果需要,就把控制器接口的返回值进行转换。

注解类

采用标记方法的返回值,是否需要包装

如何优雅的设计 API 接口,实现统一格式返回?
拦截器

拦截请求,是否此请求返回的值需要包装,实际上就是运行的时候,解析@ResponseResult注解

如何优雅的设计 API 接口,实现统一格式返回?

此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。

重建返回体
如何优雅的设计 API 接口,实现统一格式返回?

上面的代码就是肯定肯定判断是否需要返回值包装,如果需要就直接包装。这里我们只处理了正常成功的包装,如果方法体报异常怎么办?

处理异常也比较简单,只要判断body是否为异常类。

如何优雅的设计 API 接口,实现统一格式返回?

怎么做的异常处理,篇幅原因,老顾这里就不做介绍了,只要思路理清楚了,自行改造就行。

改造控制器
如何优雅的设计 API 接口,实现统一格式返回?

在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。

这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础之上自我扩展。

推荐

主流Java进阶技术(学习资料分享)

Java面试题宝典

加入Spring技术开发社区

如何优雅的设计 API 接口,实现统一格式返回?

PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。“在看”支持我们吧!

原文始发于微信公众号(Java知音):如何优雅的设计 API 接口,实现统一格式返回?