加载中...

Rest控制器

Rest控制器

新版不再推荐使用Rest控制器，建议用资源控制器替代。下一个大版本即将废弃。

如果需要让你的控制器支持RESTful的话，可以使用Rest控制器，在定义访问控制器的时候直接继承think\controller\Rest即可，例如：

namespace app\index\controller;

use think\controller\Rest;

class Blog extends Rest
{
}

配合示例需要，我们首先在应用配置文件中添加：

// URL伪静态后缀
'url_html_suffix'        => 'html|xml|json|jsonp',

RESTFul方法定义

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

<?php

namespace app\index\controller;

use think\controller\Rest;

class Blog extends Rest
{
    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获取当前的请求类型。

RESTFul 输出

使用Rest类提供的 response 方法

$this->response($data, 'json', 200);

使用think\Response类

Response::create($data, 'json')->code(200);

使用助手函数

json($data, 200);

$data为需要输出的数据，第二个参数为输出数据的http状态码
方法会自动对$data数据进行输出类型编码，目前支持的包括xml,json,jsonp,html等编码格式输出，例如：

// 输出 json 格式数据
json($data, 200);
// 输出 jsonp 格式数据
jsonp($data, 200);
// 输出 xml 格式数据
xml($data, 200);
除了普通方式定义Restful操作方法外，系统还支持另外一种自动调用方式，就是根据当前请求类型和资源类型自动调用相关操作方法。系统的自动调用规则是： 定义规范 说明
操作名_提交类型_资源后缀 标准的Restful方法定义，例如 read_get_pdf
操作名_资源后缀 当前提交类型和restDefaultMethod相同的时候，例如read_pdf
操作名_提交类型 当前资源后缀和restDefaultType相同的时候，例如read_post

这种方式的rest方法定义采用了空操作机制，所以要使用这种方式的前提就是不能为当前操作定义方法，如果检测到相关的restful方法则不再检查后面的方法规范，例如我们定义了InfoController如下：

namespace app\index\controller;

use think\controller\Rest;

class Info extends Rest
{
    public function read_get_xml($id)
    {
        // 输出id为1的Info的XML数据
    }

    public function read_xml($id)
    {
        // 输出id为1的Info的XML数据
    }

    public function read_json($id)
    {
        // 输出id为1的Info的json数据
    }
}

如果我们访问的URL是：

http://serverName/index/info/read/id/1.xml

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

http://serverName/index/info/read/id/1.json

那么则会调用read_json方法。

还没有评论.