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方法。
文檔最后更新時間:2018-04-26 09:14:09
未解決你的問題?請到「問答社區」反饋你遇到的問題