栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

你真的会写Restful API吗?

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

你真的会写Restful API吗?

现在服务端向前端暴露的API一般都称自己为Rest接口,肉眼可见的最明显特征就是application/json。但是json这个东西只能说是一个数据格式,它的好处就是表达数据清晰简单,但是要把restful和json画个等号就大错特错了。

也许你听说过Rest是面向资源的,但没有这样认真写过,不知道怎么才是最符合标准的。其实Rest有一个成熟度模型,最高的等级是利用超媒体控制,这有个专业的名词:HATEOAS(The Hypermedia As The Engine Of Application Statue),Spring也提供了这种支持,可以使用Spring HATEOAS来实现,不过用的人应该不多,这是为什么呢?

我们看一下成熟度模型的其它几个等级:

第0级:仅使用http作为通道。我看见的很多API都停留在这个阶段,接口的形式还是RPC的形式,典型的特征就是get、set、add、delete满天飞,在这些接口中看不到任何基于资源的影子。get和post方法也是混用的,哪个方便用哪个。

第1级:以资源为中心。我认为这个真正的属于Rest接口了。形式如下:

/products/
/products/?name=foo
/products/1
/orders/

接口编写者提供的是资源,接口调用者访问的也是资源,而不再是执行某个动作。

第2级:利用http动作的语义。这个有点难理解,看一个例子:

GET /products/1

它的意思是获取一个编号为1的产品。GET语义上有幂等的意思,它不会更改资源的状态,如果调用API的时候超时了或者出错了,它可以安全地重试多次。

常用的Http动作还有Post、Put、Delete等等,其中需要注意Post不是幂等的,重试之前需要检查资源的最新状态,否则可能造成一些问题,比如扣了两次钱。Put和Delete都是幂等的,可以安全重试。

绝大部分情况下,能够做到这一步就够了,算是标准合格的Restful API了。

第3级,终极等级,也就是前边提到的超媒体控制。做到这一步,客户端无需提前知道API的Path定义,服务端会返回资源的当前状态,以及下一步可以执行的各种标准动作。具体的就是通过link来给出各种处理资源的Path。具体样子请看附图。

应用到这一级的API比较少见,我认为是有点复杂了,编写服务端和客户端都会有点麻烦,步子迈得太大,还有真的需要这样做的应用场景也可能比较少,我想不出来

另外还想说的是,restful和json不是绑定的,json只是一种最为流行的编码格式,在restful架构风格下,还可以使用xml、protobuf或者其它一些格式,经常见到的就是很多API支持根据http header中的accept返回json或者xml。

最后我们一般在对外提供服务的时候使用restful的接口,对内基于效率和习惯,还是使用RPC框架居多。RPC就不是面向资源的了,可以认为它面向的是业务模型,调用的是各种业务动作。不过RPC也可以基于Http协议,只使用其中的Post动作,比如大名鼎鼎的grpc就使用Http,这里Http协议被作为了一种传输协议,RPC协议则是上层业务协议。

好了,这篇文章就到这里。

你是怎么看待这个问题的?欢迎留言。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1031428.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号