RESTful实践(具体应用)思考

RESTful这种架构已经具有很长的时间和历程了,但似乎最近restful这个词出现的频率特别高,目前不是很清楚是因为我自个儿现在是以restful风格写程序产生的孕妇效应,还是单页面程序开发的流行造成的。

其实一开始我也是不想写这篇文章的,因为网络上与restful相关的文章挺多,而且都写得挺好的,都具有比较高的参考价值。但是我仔细梳理了我所看过的文章,发现大家基本上讲的是restful的理论经验,好像并没有过多的提及restful实际程序设计上的一些经验总结。而且关于这方面的经验总结我曾经也想找找来做参考也并没有找到,因此,我写这篇文章,希望一些人能得到一些参考(因为是我个人实践,可能有些不符合大流的地方,那就请多多包涵或者指出来了)。

另外这篇文章我不会去讲一些底层restful支持怎么设计(restful框架怎么设计),要说这个的话,那么内容太长了,我主要讲应用层面的东西,也就是具体业务逻辑的一些东西,当然会做一些基本的引申讲解。

资源

说到restful就不得不说资源这个东西了,restful的每一个接口所对应的应该是一个资源。那么,在restful里面,“资源”这个词其实应该算是一个抽象概念了,这个“资源”所包含的资源就不仅仅是常规意义上的资源了。我觉得换一种方式叫法,把这种资源叫做对象,可能会更加方便理解。

当然,首先我们其实应该说一下什么是资源。资源包含的东西很多,从图片到音频、视频等数据,以及文本等都是资源。也就是说,服务器上存在的数据就是资源。

但是,单独说资源没有太多意义,应该说资源的表现方式才有意义,或者说数据的表现方式才有意义,此处挺重要的,这个涉及到后续我说的restful风格设计方面的东西。通常来说,我们打开一个URL所能看到的就是一个完整的html界面,而其实,这个html界面就是资源,html所显示出来的图片、音频、视频等等都是资源。说到这里可能有些人在做开发过程中对于一些东西具有误解,认为restful风格所获取的资源是服务端返回json数据。关于这个,我们应该搞清楚几个概念:

  1. 数据类型:就是服务端返回的数据类型,如html、图片、视频、Excel表格、world文档等等;
  2. 传输方式:异步和同步;
  3. 串行和并行传输: 串行传输是等一个数据传输完成再传输另外一个数据,并行是同时执行。

这三个东西我就不展开细说了,说起来比较复杂,我就说一下串行和并行与异步和同步的一个大致讲解就好了,很多人觉得异步是并行执行的,或者说把异步理解成并行执行的,这其实不一定,异步只能说执行的时候在某个流程执行的时候可以开始其他任务执行,减少阻塞。

请求方式

常用的请求方式大致就是:GETPOSTPUTDELETEOPTIONS

GET:接口从字面意识理解,就是获取数据的,而我们在设计的时候,GET应该是包含两种数据获取方式,一种是获取整体数据列表,一种是根据指定ID获取数据。

POST:是新增数据用的,此请求方式设计的接口是新增数据;

PUT:是修改数据接口,如果要对资源做数据修改,那么程序应该考虑放在这个接口中;

DELETE:很容易理解,这个请求方式对应的是对接口的删除操作;

OPTIONS:这个接口蛮有意思的,通常这个接口设计为返回当前接口的一些信息,比如有哪些字段,哪些字段允许请求哪些字段不允许等。

那么后端的业务逻辑程序应该向外提供基本的五个接口,如:

interface Api {
    public function index() {} // GET 列表接口 /api
    public function view() {} // GET 单个数据接口 /api/:id
    public function create() {} // POST 创建接口 /api
    public function update() {} // PUT 修改接口 /api/:id
    public function delete() {} // DELETE 删除接口 /api/:id
}

业务逻辑设计思维方向

嗯,说了以上一大堆,那么这个点估计才是比较关键的东西。

可以看以上的那段代码接口,我后面的注释做了请求方式和功能性说明,来看一下update这个接口,这个接口需要注意的是,通常设计的修改接口后面必须要带上指定的数据id,这里的:id指的是资源id参数。从这里来看,似乎对于资源的修改具有一定的局限性,当然删除也如此。然后,我想很多人应该就开始有一个疑问了:“卧槽,老子要做批量修改,咋办?这restful也太局限了吧?”。

对,我开始就是这么想的,后来经过我的思考,我发现并不是这样。我上文提到,服务端任何数据都是资源,而且资源在restful里应该算是一个抽象的意义。上文没法做说明,但其实,这个是关乎到程序设计上的一些问题的。

首先,我们来假设有这样一个例子,我们要批量删除一堆商品数据。按照传统的思维,用户批量选择,然后把这一堆id传递到后端,然后后端根据这一批id来进行删除。我说这个,并不是要表达在restful里这套思维行不通,首先应该肯定这是对的,但是,我们要做的是跳出这期间设计到的另外一个思维。也就是此时我们把商品当做一个资源操作,此时,我们应该把“删除商品”当做一个资源,而不是商品。那么我们在设计接口的时候,就具有非常大的意义了。我们把“删除商品”当做一个资源,暂且把这个接口定义为:/delete-goods。那么,删除就是对应的post接口,也就是创建“删除商品”,那么撤销删除可以对应delete接口,也就是删除“删除商品”。

以上描述得可能有些拗口,但实际上就是这样,如果这么设计,我们遵循了restful的标准,其实交互流程与传统没有太多差别,唯一的差别就是思想的转换。分析以上,其实我们应该得出一些结论:

  1. 做restful设计的时候,程序设计思维应该要做一定的转换,在不同的场景思考到底什么才应该是资源,应该把什么当做资源?
  2. 做restful应该把逻辑拆分得更清晰,没个逻辑对象只做五件事情:看列表数据、看单个数据、增加数据、修改数据、删除数据。

以上我虽然是就删除来说的,其实批量修改等也贴合这种思想,也包括我之前回答的一个问题,就是批量阅读消息这种操作也贴合于这种思想。

其他

restful交互一般会遵循一些数据结构协议或者HTTP状态值,比如不同的操作结果对应不同的HTTP状态值,且出错会返回指定的错误信息方便前端进行提示等。

当然restful接口的设计为了完全遵循自然语义也可以采用请求资源列表采用复数请求方式(语言中的单数词和复数词)等等。

不管怎么变化,我觉得最基本的还是不同的请求方式对应的不同操作问题,所有的操作对应的还是同一个接口。

以上就是我的一些应用场景的理解和总结,欢迎大家一起交流。


Kumfo 的杂货铺
做一些经验总结和一些学习心得分享,主要围绕PHP。 现在正在学习机器学习,会增加一些机器学习的思考分享。
1 篇内容引用
avatar
kumfo
SegmentFault 后端工程师

程序生存法则:

6.5k 声望
4.1k 粉丝
0 条评论
推荐阅读
Elasticsearch 按照标签匹配个数优先排序查询
首先最外层的数组就是我们通常写的query语句,放在body中进行请求的,主要看query里面的结构,这种需要自定义脚本处理评分的,query中只放了一个script_score:

kumfo2阅读 725

正则表达式实例
收集在业务中经常使用的正则表达式实例,方便以后进行查找,减少工作量。常用正则表达式实例1. 校验基本日期格式 {代码...} {代码...} 2. 校验密码强度密码的强度必须是包含大小写字母和数字的组合,不能使用特殊...

寒青56阅读 7.9k评论 11

JavaScript有用的代码片段和trick
平时工作过程中可以用到的实用代码集棉。判断对象否为空 {代码...} 浮点数取整 {代码...} 注意:前三种方法只适用于32个位整数,对于负数的处理上和Math.floor是不同的。 {代码...} 生成6位数字验证码 {代码...} ...

jenemy46阅读 6.1k评论 12

从零搭建 Node.js 企业级 Web 服务器(十五):总结与展望
总结截止到本章 “从零搭建 Node.js 企业级 Web 服务器” 主题共计 16 章内容就更新完毕了,回顾第零章曾写道:搭建一个 Node.js 企业级 Web 服务器并非难事,只是必须做好几个关键事项这几件必须做好的关键事项就...

乌柏木66阅读 6.2k评论 16

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs40阅读 6.4k评论 12

封面图
如何使用 PHPStorm 进行优雅的项目开发?
PHP Storm 这个开发工具,很多 phper 应该有所耳闻,甚至也有不少人使用其作为生产工具,但是很多人都没有最大限度的使用它,本文就来总结一些优雅开发的小技巧。

唯一丶45阅读 4.8k评论 7

从零搭建 Node.js 企业级 Web 服务器(一):接口与分层
分层规范从本章起,正式进入企业级 Web 服务器核心内容。通常,一块完整的业务逻辑是由视图层、控制层、服务层、模型层共同定义与实现的,如下图:从上至下,抽象层次逐渐加深。从下至上,业务细节逐渐清晰。视图...

乌柏木44阅读 7.5k评论 6

avatar
kumfo
SegmentFault 后端工程师

程序生存法则:

6.5k 声望
4.1k 粉丝
宣传栏