ThinkPHP3.0完全开发手册                                           

 

18.5               REST方法

RESTFul方法和标准模式的操作方法定义主要区别在于,需要对请求类型和资源类型进行判断,大多数情况下,通过路由定义可以把操作方法绑定到某个请求类型和资源类型。如果你没有定义路由的话,需要自己在操作方法里面添加判断代码,示例:

Class InfoAction extends Action {

   Public function rest() {

     switch ($this->_method){

      case 'get': // get请求处理代码

               if ($this->_type == 'html'){

               }elseif($this->_type == 'xml'){

               }

               break;

      case 'put': // put请求处理代码

               break;

      case 'post': // put请求处理代码

               break;

     }

}

}

Rest操作方法中,可以使用$this->_type 获取当前访问的资源类型,用$this->_method获取当前的请求类型。

REST模式的Action类还提供了response方法用于REST输出:

response输出数据

用法

response($data,$type='',$code=200)

参数

data(必须):要输出的数据

type(可选):要输出的类型,支持REST_OUTPUT_TYPE参数允许的类型,如果为空则取REST_DEFAULT_TYPE参数设置值

code (可选):HTTP状态

返回值

Response方法会自动对data数据进行输出类型编码,目前支持的包括xml json html

 

除了普通方式定义Restful操作方法外,系统还支持另外一种自动调用方式,就是根据当前请求类型和资源类型自动调用相关操作方法。系统的自动调用规则是:

定义规范

说明

操作名_提交类型_资源后缀

标准的Restful方法定义,例如 read_get_pdf

操作名_资源后缀

当前提交类型和REST_DEFAULT_METHOD相同的时候,例如read_pdf

操作名_提交类型

当前资源后缀和REST_DEFAULT_TYPE相同的时候,例如read_post

要使用这种方式的前提就是不能为当前操作定义方法,这样在空操作的检查之前系统会首先按照上面的定义规范顺序检查是否存在方法定义,如果检测到相关的restful方法则不再检查后面的方法规范,例如我们定义了InfoAction如下:

Class InfoAction extends Action {

   Public function read_get_xml(){

   // 输出id1InfoXML数据

}

   Public function read_xml(){

   // 输出id1InfoXML数据

}

   Public function read_json(){

   // 输出id1Infojson数据

}

}

项目配置中设置了如下rest相关参数:

'REST_METHOD_LIST'           =>'get,post,put', // 允许的请求类型列表

'REST_DEFAULT_METHOD'     =>'get', // 默认请求类型

'REST_DEFAULT_TYPE'          =>'html', // 默认的资源类型

'REST_CONTENT_TYPE_LIST' =>'html,xml,json', // REST允许请求的资源类型列表

 

如果我们访问的URL是:

http://www.domain.com/Info/read/id/1.xml

假设我们没有定义路由,这样访问的是Info模块的read操作,那么上面的请求会调用InfoAction类的 read_get_xml方法,而不是read_xml方法,但是如果访问的URL是:

http://www.domain.com/Info/read/id/1.json

那么则会调用read_json方法。


站长教学网 免责声明