REST实践 · 跟老杨学ThinkPHP3

## REST介绍 REST(Representational State Transfer表述性状态转移)是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。REST提出了一些设计概念和准则： 1、网络上的所有事物都被抽象为资源（resource）； 2、每个资源对应一个唯一的资源标识（resource identifier）； 3、通过通用的连接器接口（generic connector interface）对资源进行操作； 4、对资源的各种操作不会改变资源标识； 5、所有的操作都是无状态的（stateless）。需要注意的是，REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。传统的请求模式和REST模式的请求模式区别： | 作用 | 传统模式 | REST模式 | |-----|-----|-----| | 列举出所有的用户 | GET /users/list | GET /users | | 列出ID为1的用户信息 | GET /users/show/id/1 | GET /users/1 | | 插入一个新的用户 | POST /users/add | POST /users | | 更新ID为1的用户信息 | POST /users/mdy/id/1 | PUT /users/1 | | 删除ID为1的用户 | POST /users/delete/id/1 | DELETE /users/1 | > 经过老杨在freelog里的rest实践发现TP里I方法不支持`I('delete.')` 这种，只能获取get参数。关于更多的REST信息，可以参考：[http://zh.wikipedia.org/wiki/REST](http://zh.wikipedia.org/wiki/REST) ## RESTFul支持 3.2的RESTFul支持更为灵活，你只需要把控制器继承Think\Controller\RestController即可。继承RestController控制器后你的访问控制器就可以支持下面的一些功能： > - 支持资源类型自动检测； > - 支持请求类型自动检测； > - RESTFul方法支持； > - 可以设置允许的请求类型列表； > - 可以设置允许请求和输出的资源类型； > - 可以设置默认请求类型和默认资源类型；例如： ~~~ namespace Home\Controller; use Think\Controller\RestController; class BlogController extends RestController{ } ~~~ ## REST参数继承了RestController后，你可以在你的控制器里面设置rest相关的属性参数，包括：allowMethod，defaultMethod，allowType，defaultType以及allowOutputType。 | 属性名 | 说明 | 默认值 | |-----|-----|-----| | allowMethod | REST允许的请求类型列表 | array('get','post','put','delete') | | defaultMethod | REST默认请求类型 | get | | allowType | REST允许请求的资源类型列表 | array('html','xml','json','rss') | | defaultType | REST默认的资源类型 | html | | allowOutputType | REST允许输出的资源类型列表 | array( 'xml' => 'application/xml', 'json' => 'application/json','html' => 'text/html',) | ## REST方法 RESTFul方法的操作方法定义主要区别在于，需要对请求类型和资源类型进行判断，大多数情况下，通过路由定义可以把操作方法绑定到某个请求类型和资源类型。如果你没有定义路由的话，需要自己在操作方法里面添加判断代码，示例： ~~~ namespace Home\Controller; use Think\Controller\RestController; Class InfoController extends RestController { Public function rest() { switch ($this->_method){ case 'get': // get请求处理代码 if ($this->_type == 'html'){ }elseif($this->_type == 'xml'){ } break; case 'put': // put请求处理代码 break; case 'post': // post请求处理代码 break; } } } ~~~ > 在Rest操作方法中，可以使用$this->_type获取当前访问的资源类型，用$this->_method获取当前的请求类型。 REST控制器类还提供了response方法用于REST输出：用法如下： ~~~ $this->response($data,'json'); ~~~ Response方法会自动对data数据进行输出类型编码，目前支持的包括`xml/json/html`。除了普通方式定义Restful操作方法外，系统还支持另外一种自动调用方式，就是根据当前请求类型和资源类型自动调用相关操作方法。系统的自动调用规则是： | 定义规范 | 说明 | |-----|-----| | 操作名_提交类型_资源后缀 | 标准的Restful方法定义，例如 read_get_pdf | | 操作名_资源后缀 | 当前提交类型和defaultMethod属性相同的时候，例如read_pdf | | 操作名_提交类型 | 当前资源后缀和defaultType属性相同的时候，例如read_post | 要使用这种方式的前提就是不能为当前操作定义方法，这样在空操作的检查之前系统会首先按照上面的定义规范顺序检查是否存在方法定义，如果检测到相关的restful方法则不再检查后面的方法规范，例如我们定义了InfoController如下： ~~~ namespace Home\Controller; use Think\Controller\RestController; Class InfoController extends RestController { protected $allowMethod = array('get','post','put'); // REST允许的请求类型列表 protected $allowType = array('html','xml','json'); // REST允许请求的资源类型列表 Public function read_get_html(){ // 输出id为1的Info的html页面 } Public function read_get_xml(){ // 输出id为1的Info的XML数据 } Public function read_xml(){ // 输出id为1的Info的XML数据 } Public function read_json(){ // 输出id为1的Info的json数据 } } ~~~ 如果我们访问的URL是： ~~~ http://www.domain.com/Info/read/id/1.xml ~~~ 假设我们没有定义路由，这样访问的是Info控制器的read操作，那么上面的请求会调用InfoController类的 `read_get_xml`方法，而不是`read_xml`方法，但是如果访问的URL是： ~~~ http://www.domain.com/Info/read/id/1.json ~~~ 那么则会调用read_json方法。如果我们访问的URL是 ~~~ http://www.domain.com/Info/read/id/1.rss ~~~ 由于我们不允许rss资源类型的访问，所以，调用的方法其实是read_html方法。 ## REST路由我们可以借助3.2的路由参数功能，来解决REST的路由定义问题。例如， ~~~ 'blog/:id'=>array('blog/read','status=1',array('ext'=>'xml','method'=>'get')), ~~~ 上面的路由定义，把blog/5路由到了blog/read/id/5 并且，约束了后缀是xml 请求类型是get。我们还可以定义其他的路由参数，例如： ~~~ 'blog/:id'=>array('blog/update','',array('ext'=>'xml','method'=>'put')), ~~~ 为了确保定义不冲突，REST路由定义我们通常改成下面的定义方式： ~~~ array('blog/:id','blog/read','status=1',array('ext'=>'xml','method'=>'get')), array('blog/:id','blog/update','',array('ext'=>'xml','method'=>'put')), ~~~ > 这样就可以给相同的路由规则定义不同的参数支持。定义了REST路由后，你的rest方法定义就不受任何约束，当然，如果路由定义的操作方法不存在的时候，系统默认的rest方法规范仍然会有效。