快上网专注成都网站设计 成都网站制作 成都网站建设
成都网站建设公司服务热线:028-86922220

网站建设知识

十年网站开发经验 + 多家企业客户 + 靠谱的建站团队

量身定制 + 运营维护+专业推广+无忧售后,网站问题一站解决

如何写好后端API接口

这篇文章主要讲解了“如何写好后端API接口”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“如何写好后端API接口”吧!

创新互联专注于德城网站建设服务及定制,我们拥有丰富的企业做网站经验。 热诚为您提供德城营销型网站建设,德城网站制作、德城网页设计、德城网站官网定制、微信小程序定制开发服务,打造德城网络公司原创品牌,更为您提供德城网站排名全网营销落地服务。

接口交互

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

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

我着重介绍一下后端服务器如何实现把数据返回给前端?

返回格式

后端返回给前端我们一般用 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 区间表示接口异常

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

②Message

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

如何写好后端API接口

再在枚举中定义,状态码:

如何写好后端API接口

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

③Data

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

我们要设计一个返回体类 Result:

如何写好后端API接口

控制层 Controller

我们会在 Controller 层处理业务请求,并返回给前端,以 Order 订单为例:

如何写好后端API接口

我们看到在获得 Order 对象之后,我们是用的 Result 构造方法进行包装赋值,然后进行返回。

小伙伴们有没有发现,构造方法这样的包装是不是很麻烦,我们可以优化一下。

美观优化

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

如何写好后端API接口

那我们来改造一下 Controller:

如何写好后端API接口

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

优雅优化

上面我们看到在 Result 类中增加了静态方法,使得业务处理代码简洁了。

但小伙伴们有没有发现这样有几个问题:

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

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

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

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

如何写好后端API接口

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

实现方案

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

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

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

  • 核心步骤就是实现接口 ResponseBodyAdvice 和 @ControllerAdvice,判断是否需要包装返回值,如果需要,就把  Controller 接口的返回值进行重写。

①注解类

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

如何写好后端API接口

②拦截器

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

如何写好后端API接口

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

③重写返回体

如何写好后端API接口

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

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

如何写好后端API接口

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

④重写 Controller

如何写好后端API接口

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

感谢各位的阅读,以上就是“如何写好后端API接口”的内容了,经过本文的学习后,相信大家对如何写好后端API接口这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是创新互联,小编将为大家推送更多相关知识点的文章,欢迎关注!


网站题目:如何写好后端API接口
链接分享:http://6mz.cn/article/pshipi.html

其他资讯