Rest控制器

Rest控制器

新版不再推薦使用Rest控制器，建議用資源控制器替代。下一個(gè)大版本即將廢棄。

如果需要讓你的控制器支持RESTful的話，可以使用Rest控制器，在定義訪問(wèn)控制器的時(shí)候直接繼承think\controller\Rest即可，例如：

namespace app\index\controller;

use think\controller\Rest;

class Blog extends Rest
{
}

配合示例需要，我們首先在應(yīng)用配置文件中添加：

// URL偽靜態(tài)后綴
'url_html_suffix'        => 'html|xml|json|jsonp',

RESTFul方法定義

RESTFul方法和標(biāo)準(zhǔn)模式的操作方法定義主要區(qū)別在于，需要對(duì)請(qǐng)求類(lèi)型和資源類(lèi)型進(jìn)行判斷，大多數(shù)情況下，通過(guò)路由定義可以把操作方法綁定到某個(gè)請(qǐng)求類(lèi)型和資源類(lèi)型。如果你沒(méi)有定義路由的話，需要自己在操作方法里面添加判斷代碼，示例：

<?php

namespace app\index\controller;

use think\controller\Rest;

class Blog extends Rest
{
    public function rest()
    {
        switch ($this->method){
        case 'get': // get請(qǐng)求處理代碼
            if ($this->type == 'html'){
            } elseif ($this->type == 'xml'){
            }
            break;
        case 'put': // put請(qǐng)求處理代碼
            break;
        case 'post': // post請(qǐng)求處理代碼
            break;
        }
    }
}

在Rest操作方法中，可以使用$this->type獲取當(dāng)前訪問(wèn)的資源類(lèi)型，用$this->method獲取當(dāng)前的請(qǐng)求類(lèi)型。

RESTFul 輸出

使用Rest類(lèi)提供的 response 方法

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

使用think\Response類(lèi)

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

使用助手函數(shù)

json($data, 200);

$data為需要輸出的數(shù)據(jù)，第二個(gè)參數(shù)為輸出數(shù)據(jù)的http狀態(tài)碼
方法會(huì)自動(dòng)對(duì)$data數(shù)據(jù)進(jìn)行輸出類(lèi)型編碼，目前支持的包括xml,json,jsonp,html等編碼格式輸出，例如：

// 輸出 json 格式數(shù)據(jù)
json($data, 200);
// 輸出 jsonp 格式數(shù)據(jù)
jsonp($data, 200);
// 輸出 xml 格式數(shù)據(jù)
xml($data, 200);

除了普通方式定義Restful操作方法外，系統(tǒng)還支持另外一種自動(dòng)調(diào)用方式，就是根據(jù)當(dāng)前請(qǐng)求類(lèi)型和資源類(lèi)型自動(dòng)調(diào)用相關(guān)操作方法。系統(tǒng)的自動(dòng)調(diào)用規(guī)則是：

這種方式的rest方法定義采用了空操作機(jī)制，所以要使用這種方式的前提就是不能為當(dāng)前操作定義方法，如果檢測(cè)到相關(guān)的restful方法則不再檢查后面的方法規(guī)范，例如我們定義了InfoController如下：

namespace app\index\controller;

use think\controller\Rest;

class Info extends Rest
{
    public function read_get_xml($id)
    {
        // 輸出id為1的Info的XML數(shù)據(jù)
    }
    
    public function read_xml($id)
    {
        // 輸出id為1的Info的XML數(shù)據(jù)
    }
    
    public function read_json($id)
    {
        // 輸出id為1的Info的json數(shù)據(jù)
    }
}

如果我們?cè)L問(wèn)的URL是：

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

假設(shè)我們沒(méi)有定義路由，這樣訪問(wèn)的是Info模塊的read操作，那么上面的請(qǐng)求會(huì)調(diào)用Info類(lèi)的 read_get_xml方法，而不是read_xml方法，但是如果訪問(wèn)的URL是：

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

那么則會(huì)調(diào)用read_json方法。