微信小程序实践:服务器端接口restful配置

更多腾讯海量技术文章,请关注云加社区:https://cloud.tencent.com/developer/column

作者:疯狂的小程序

RESTful

GET xgh.nai8.me/xcx/albums

GET xgh.nai8.me/xcx/albums/…

....

类似的url,这样是符合restful。

为了以后版本化,将每个版本的接口以模块的形式建立,当然建立支持restful和建立普通的模块并没有差别,使用gii的模块生成即可。

此处省略好几个字,模块建立完成。

alt

yii2框架内置是支持restful规范的,按照yii2的规则做我们可以轻松实现比如数据表数据的获取、插入、更新、删除等基础操作以及登录验证等功能。

也就是说我省了很多事情~~,当然我们还是需要简单配置的,这个配置主要是urlManager及模块控制器的继承问题。

urlManager

如果要实现上面的url样子,我们必须进行url美化,这需要web服务器的支持(apache&nginx如何支持url重写可以参考 速查表),单单这样还不够,yii2提供了restful专有的url规范,需要按照它的要求配置。

对于一般的restful规则的yii2路由配置如下图

alt

红色框内的代表一个标准restful中控制器路由规则,绿色框内是你必须要填写的,其他的except、pluralize、extraPatterns非必填,具体使用场景以后用到会说明。

这里要说明的参数是pluralize,在restful使用上一直存在两种观点,就是对于资源在url上的表现应该是单数还是复数问题,yii2默认是复数形式,如果你想使用单数可以将pluralize设置为false即可。

在pluralize=false的情况下url是类似于 GET xgh.nai8.me/xcx/album 的样子。

在我们设置了urlManager后,yii2就变得智商满满了,当过来一个 GET xgh.nai8.me/xcx/albums 请求后,yii2知道这是一个要获取资源结果集的请求,则会去调用xcx模块下的album控制器的actionIndex,以此类推yii2提供了很多个内置的action识别,具体见下图

alt

当然具体如何实现的你可以参考 yii\rest\UrlRule.php 类及yii2的actions函数。

小提示:在兄弟连PHP原创视频中对这个原理也进行了详细的解析(《Yii2的RESTful讲解》第三节)

配置控制器

urlManager配置完成,接下来就是写一个控制器了,老沙对此很熟悉,不就是一个继承问题么!!!

是的,这是一个继承问题,如果你想让yii2支持restful,请将对应控制器继承到 yii\rest\ActiveController 上,最简单的一个具有restful资源操作能力的控制器如下图。

alt

是的,就是这样,当控制器继承于 ActiveController 在指定一个$modelClass后,这个控制器就可以对 $modelClass 对应的数据表进行列表、详情、生成、更新、删除等操作,而你无需再写任何对应代码,简单吧~~

这里要注意几点

第一: 必须指定$modelClass,每个控制器代表一种资源,隐身就是一个数据表中的数据或你操作系统的文件云云,总之它是一种资源。

第二: 这里的AblumController就是urlMananger中的'controller' => 'xcx/album', 控制器的名字于单复数的设置无关。

完事了

简单配置后,老沙搞定了服务器端的配置,接下来他计划使用小程序和yii2实现一个队相册列表的功能实现,下一篇告诉你。

  • 发表于:
  • 原文链接:http://kuaibao.qq.com/s/20180131A0O5U600?refer=cp_1026

扫码关注云+社区