Rest控制器
Rest控制器
新版不再推(tui)薦使用Rest控(kong)(kong)制(zhi)器,建議用資源(yuan)控(kong)(kong)制(zhi)器替代。下(xia)一個大(da)版本即將廢棄。
如果需要讓你的控制器支持RESTful的話,可以使用Rest控制器,在定義訪問控制器的時候直接繼承think\controller\Rest即可,例如:
namespace app\index\controller;
use think\controller\Rest;
class Blog extends Rest
{
}
配合示例需要(yao),我們首先在應用(yong)配置文件(jian)中添加(jia):
// URL偽靜態后綴
'url_html_suffix' => 'html|xml|json|jsonp',
RESTFul方法定義
RESTFul方法(fa)和(he)(he)標(biao)準模式的(de)操(cao)作方法(fa)定義(yi)主要區(qu)別在于(yu),需(xu)要對請求(qiu)類型和(he)(he)資(zi)(zi)源類型進行(xing)判斷(duan),大多數情況(kuang)下,通過路由(you)定義(yi)可(ke)以把操(cao)作方法(fa)綁定到某個(ge)請求(qiu)類型和(he)(he)資(zi)(zi)源類型。如(ru)果你(ni)沒有定義(yi)路由(you)的(de)話,需(xu)要自己在操(cao)作方法(fa)里面添(tian)加判斷(duan)代碼,示例:
<?php
namespace app\index\controller;
use think\controller\Rest;
class Blog extends Rest
{
public function rest()
{
switch ($this->method){
case 'get': // get請求(qiu)處理(li)代碼
if ($this->type == 'html'){
} elseif ($this->type == 'xml'){
}
break;
case 'put': // put請(qing)求處理代碼
break;
case 'post': // post請求處理代(dai)碼
break;
}
}
}
在Rest操作方法中,可以使用$this->type獲取當前訪問的資源類型,用$this->method獲取當前的請求(qiu)類型。
RESTFul 輸出
使用Rest類提供的 response 方法
$this->response($data, 'json', 200);
使用think\Response類
Response::create($data, 'json')->code(200);
使用助手函數
json($data, 200);
$data為需要輸出的數據,第二個參數為輸出數據的http狀態碼
方法會(hui)自動對$data數據進(jin)行輸出類型編碼(ma),目前支持的包(bao)括xml,json,jsonp,html等(deng)編碼(ma)格式輸出,例如(ru):
// 輸(shu)出 json 格(ge)式數據
json($data, 200);
// 輸出 jsonp 格式(shi)數據(ju)
jsonp($data, 200);
// 輸(shu)出 xml 格式數據(ju)
xml($data, 200);
除了普通方(fang)式(shi)定(ding)義Restful操作方(fang)法(fa)外,系(xi)統還支持(chi)另外一種自動調(diao)(diao)用(yong)方(fang)式(shi),就是根(gen)據當前請求類型和(he)資源類型自動調(diao)(diao)用(yong)相關操作方(fang)法(fa)。系(xi)統的自動調(diao)(diao)用(yong)規則是:
| 定義規范 | 說明 |
|---|---|
| 操作名_提交類型_資源后綴 | 標準的Restful方法定義,例如 read_get_pdf |
| 操作名_資源后綴 | 當前提交類型和restDefaultMethod相同的時候,例如read_pdf |
| 操作名_提交類型 | 當前資源后綴和restDefaultType相同的時候,例如read_post |
這(zhe)種(zhong)方式的(de)rest方法(fa)定義(yi)采用(yong)了空(kong)操作(zuo)機制,所以要使用(yong)這(zhe)種(zhong)方式的(de)前提就是不(bu)(bu)能為當(dang)前操作(zuo)定義(yi)方法(fa),如(ru)果(guo)檢(jian)測(ce)到相(xiang)關的(de)restful方法(fa)則不(bu)(bu)再檢(jian)查(cha)后面的(de)方法(fa)規范(fan),例如(ru)我們定義(yi)了InfoController如(ru)下:
namespace app\index\controller;
use think\controller\Rest;
class Info extends Rest
{
public function read_get_xml($id)
{
// 輸出(chu)id為1的Info的XML數據(ju)
}
public function read_xml($id)
{
// 輸出id為1的(de)Info的(de)XML數據
}
public function read_json($id)
{
// 輸(shu)出id為1的(de)Info的(de)json數據
}
}
如果(guo)我們(men)訪問的(de)URL是:
//serverName/index/info/read/id/1.xml
假設我們沒有(you)定義路由(you),這樣訪問的是Info模塊的read操作(zuo),那么上面(mian)的請求會(hui)調用Info類的 read_get_xml方法(fa),而(er)不(bu)是read_xml方法(fa),但是如果訪問的URL是:
http://serverName/index/info/read/id/1.json
那么則(ze)會調(diao)用read_json方法。
