脠媒隆壟脟毛脟貿潞脥脧矛脫婁 · tp5文檔

# 快速入門（三）：請求和響應本章主要了解如何獲取當前的請求信息，以及進行不同的輸出響應、跳轉和頁面重定向，主要內容包括： - - [請求對象](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u8BF7u6C42u5BF9u8C61) - [傳統方式調用](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u4F20u7EDFu65B9u5F0Fu8C03u7528) - [繼承think\\Controller](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#-think-controller) - [自動注入請求對象](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u81EAu52A8u6CE8u5165u8BF7u6C42u5BF9u8C61) - [動態綁定屬性](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u52A8u6001u7ED1u5B9Au5C5Eu6027) - [使用助手函數](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u4F7Fu7528u52A9u624Bu51FDu6570) - [請求信息](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u8BF7u6C42u4FE1u606F) - [獲取請求變量](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u83B7u53D6u8BF7u6C42u53D8u91CF) - [獲取請求參數](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u83B7u53D6u8BF7u6C42u53C2u6570) - [獲取URL信息](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#-url-) - [獲取當前模塊/控制器/操作信息](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#--3) - [獲取路由和調度信息](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u83B7u53D6u8DEFu7531u548Cu8C03u5EA6u4FE1u606F) - [響應對象](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u54CDu5E94u5BF9u8C61) - [自動輸出](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u81EAu52A8u8F93u51FA) - [手動輸出](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u624Bu52A8u8F93u51FA) - [頁面跳轉](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u9875u9762u8DF3u8F6C) - [頁面重定向](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u9875u9762u91CDu5B9Au5411) - [總結](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145255#u603Bu7ED3) `ThinkPHP5`的架構設計和之前版本的主要區別之一就在于增加了`Request`請求對象和`Response`響應對象的概念，了解了這兩個對象的作用和用法對你的應用開發非常關鍵。 ## 請求對象 > `Request`對象的作用是與客戶端交互，收集客戶端的Form、Cookies、超鏈接，或者收集服務器端的環境變量。 > > Request對象是從客戶端向服務器發出請求，包括用戶提交的信息以及客戶端的一些信息。客戶端可通過HTML表單或在網頁地址后面提供參數的方法提交數據，然后通過Request對象的相關方法來獲取這些數據。Request的各種方法主要用來處理客戶端瀏覽器提交的請求中的各項參數和選項。 `ThinkPHP5`的`Request`對象由`think\Request`類完成。 `Request`對象的一個主要職責是統一和更安全地獲取當前的請求信息，你需要避免直接操作`$_GET`、`$_POST`、`$_REQUEST`、`$_SESSION`、`$_COOKIE`，甚至`$_FILES`等全局變量，而是統一使用`Request`對象提供的方法來獲取請求變量。下面來舉一個最簡單的例子（獲取當前訪問的url地址）來說明在不同的情況下如何調用`Request`對象。 ### 傳統方式調用該用法主要是用來告訴大家`Request`對象是如何實例化的，因為實際開發中很少選擇這種方式調用。 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello($name = 'World'){ $request = Request::instance(); // 獲取當前URL地址不含域名echo 'url: ' . $request->url() . ' '; return 'Hello,' . $name . '！'; } } ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello.html?name=thinkphp ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` url: /index/index/hello.html?name=thinkphpHello,thinkphp！ ``` ``` ### 繼承think\\Controller 如果控制器類繼承了`think\Controller`的話，可以做如下簡化調用： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Controller; class Index extends Controller{ public function hello($name = 'World'){ // 獲取當前URL地址不含域名echo 'url: ' . $this->request->url() . ' '; return 'Hello,' . $name . '！'; } } ``` ``` ### 自動注入請求對象如果沒有繼承`think\Controller`，則可以使用`Request`對象注入的方式來簡化調用： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request, $name = 'World'){ // 獲取當前URL地址不含域名echo 'url: ' . $request->url() . ' '; return 'Hello,' . $name . '！'; } } ``` ``` > #### 提示： > > - - - - - - > > hello方法的request參數是系統自動注入的，而不需要通過URL請求傳入。 ### 動態綁定屬性可以給Request請求對象綁定屬性，方便全局調用，例如我們可以在公共控制器中綁定當前登錄的用戶模型到請求對象： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use app\index\model\User; use think\Controller; use think\Request; use think\Session; class Base extends Controller{ public function _initialize(){ $user = User::get(Session::get('user_id')); Request::instance()->bind('user',$user); } } ``` ``` 然后，在其它的控制器中就可以直接使用 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use app\index\controller\Base; use think\Request; class Index extends Base{ public function index(Request $request){ echo $request->user->id; echo $request->user->name; } } ``` ``` ### 使用助手函數如果既沒有繼承`think\Controller`也不想給操作方法添加額外的`Request`對象參數，那么也可以使用系統提供的助手，例如： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello($name = 'World'){ // 獲取當前URL地址不含域名echo 'url: ' . request()->url() . ' '; return 'Hello,' . $name . '！'; } } ``` ``` 上面任意一種方式都可以調用當前請求的`Request`對象實例，然后通過請求對象實例的方法來完成不同的信息獲取或者設置。 > 在后面的示例中，如果沒有特別說明，我們均以第三種方式，自動注入請求對象的方式來講解，請注意根據自己的調用方式靈活運用。 ## 請求信息我們來陸續了解下請求對象的常用方法。 ### 獲取請求變量系統推薦使用`param`方法統一獲取當前請求變量，該方法最大的優勢是讓你不需要區分當前請求類型而使用不同的全局變量或者方法，并且可以滿足大部分的參數需求，下面舉一個例子。 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request){ echo '請求參數：'; dump($request->param()); echo 'name:'.$request->param('name'); } } ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello.html?test=ddd&name=thinkphp ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` 請求參數： array (size=2) 'test' => string 'ddd' (length=3) 'name' => string 'thinkphp' (length=8) name:thinkphp ``` ``` 系統提供了一個input助手函數來簡化`Request`對象的param方法，用法如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ echo '請求參數：'; dump(input()); echo 'name:'.input('name'); } } ``` ``` `param`方法獲取的參數會自動判斷當前的請求，以`POST`請求為例的話，參數的優先級別為： #### 路由變量 > 當前請求變量（$\_POST變量） > $\_GET變量 > #### 注意： > > - - - - - - > > 這里的路由變量指的是路由規則里面定義的變量或者`PATH_INFO`地址中的變量。路由變量無法使用`get`方法或者`$_GET`變量獲取。 `param`方法支持變量的過濾和默認值，例如： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request){ echo 'name:'.$request->param('name','World','strtolower'); echo ' test:'.$request->param('test','thinkphp','strtoupper'); } } ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello.html?test=ddd&name=thinkphp ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` name:thinkphp test:DDD ``` ``` 可以設置全局的過濾方法，如下： ``` <pre class="calibre18"> ``` // 設置默認的全局過濾規則多個用數組或者逗號分隔'default_filter' => 'htmlspecialchars ', ``` ``` 除了`Param`方法之外，`Request`對象也可以用于獲取其它的輸入參數，例如： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request){ echo 'GET參數：'; dump($request->get()); echo 'GET參數：name'; dump($request->get('name')); echo 'POST參數：name'; dump($request->post('name')); echo 'cookie參數：name'; dump($request->cookie('name')); echo '上傳文件信息：image'; dump($request->file('image')); } } ``` ``` 頁面輸出的結果為： ``` <pre class="calibre18"> ``` GET參數： array (size=1) 'name' => string 'thinkphp' (length=8) GET參數：name string 'thinkphp' (length=8) POST參數：name null 當前請求（自動識別請求類型）的參數：name string 'thinkphp' (length=8) cookie參數：name null 上傳文件信息：image null ``` ``` 使用助手函數的代碼為： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ echo 'GET參數：'; dump(input('get.')); echo 'GET參數：name'; dump(input('get.name')); echo 'POST參數：name'; dump(input('post.name')); echo 'cookie參數：name'; dump(input('cookie.name')); echo '上傳文件信息：image'; dump(input('file.image')); } } ``` ``` 獲取變量的方法包括：方法作用 param 獲取請求變量 get 獲取$\_GET變量 post 獲取$\_POST變量 put 獲取PUT請求變量 delete 獲取DELETE請求變量 patch 獲取PATCH請求變量 request 獲取$\_REQUEST變量 route 獲取路由（URL）變量 session 獲取$\_SESSION變量 cookie 獲取$\_COOKIE變量 server 獲取$\_SERVER變量 env 獲取$\_ENV變量 file 獲取上傳文件信息> 除了file方法之外，其它方法都支持默認值和過濾方法。 ### 獲取請求參數把`Hello`方法改為如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request){ echo '請求方法：' . $request->method() . ' '; echo '資源類型：' . $request->type() . ' '; echo '訪問IP：' . $request->ip() . ' '; echo '是否AJax請求：' . var_export($request->isAjax(), true) . ' '; echo '請求參數：'; dump($request->param()); echo '請求參數：僅包含name'; dump($request->only(['name'])); echo '請求參數：排除name'; dump($request->except(['name'])); } } ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello/test/ddd.html?name=thinkphp ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` 請求方法：GET 資源類型：html 訪問地址：127.0.0.1 是否AJax請求：false 請求參數： array (size=2) 'test' => string 'ddd' (length=3) 'name' => string 'thinkphp' (length=8) 請求參數：僅包含namearray (size=1) 'name' => string 'thinkphp' (length=8) 請求參數：排除namearray (size=1) 'test' => string 'ddd' (length=3) ``` ``` ### 獲取URL信息 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request,$name = 'World'){ // 獲取當前域名echo 'domain: ' . $request->domain() . ' '; // 獲取當前入口文件echo 'file: ' . $request->baseFile() . ' '; // 獲取當前URL地址不含域名echo 'url: ' . $request->url() . ' '; // 獲取包含域名的完整URL地址echo 'url with domain: ' . $request->url(true) . ' '; // 獲取當前URL地址不含QUERY_STRINGecho 'url without query: ' . $request->baseUrl() . ' '; // 獲取URL訪問的ROOT地址echo 'root:' . $request->root() . ' '; // 獲取URL訪問的ROOT地址echo 'root with domain: ' . $request->root(true) . ' '; // 獲取URL地址中的PATH_INFO信息echo 'pathinfo: ' . $request->pathinfo() . ' '; // 獲取URL地址中的PATH_INFO信息不含后綴echo 'pathinfo: ' . $request->path() . ' '; // 獲取URL地址中的后綴信息echo 'ext: ' . $request->ext() . ' '; return 'Hello,' . $name . '！'; } } ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello.html?name=thinkphp ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` domain: http://tp5.comfile: /index.php url: /index/index/hello.html?name=thinkphp url with domain: http://tp5.com/index/index/hello.html?name=thinkphp url without query: /index/index/hello.html root: root with domain: http://tp5.compathinfo: index/index/hello.html pathinfo: index/index/hello ext: html Hello,thinkphp！ ``` ``` URL請求和信息方法可以總結如下：方法作用 domain 獲取當前的域名 url 獲取當前的完整URL地址 baseUrl 獲取當前的URL地址，不含QUERY\_STRING baseFile 獲取當前的SCRIPT\_NAME root 獲取當前URL的root地址 pathinfo 獲取當前URL的pathinfo地址 path 獲取當前URL的pathinfo地址，不含后綴 ext 獲取當前URL的后綴 type 獲取當前請求的資源類型 scheme 獲取當前請求的scheme query 獲取當前URL地址的QUERY\_STRING host 獲取當前URL的host地址 port 獲取當前URL的port號 protocol 獲取當前請求的SERVER\_PROTOCOL remotePort 獲取當前請求的REMOTE\_PORT> url、baseUrl、baseFile、root方法如果傳入true，表示獲取包含域名的地址。 ### 獲取當前模塊/控制器/操作信息 hello方法修改如下： ``` <pre class="calibre18"> ``` public function hello(Request $request, $name = 'World'){ echo '模塊：'.$request->module(); echo ' 控制器：'.$request->controller(); echo ' 操作：'.$request->action(); } ``` ``` 訪問URL地址： ``` <pre class="calibre18"> ``` http://tp5.com/index/index/hello.html?test=ddd&name=thinkphp ``` ``` 頁面會顯示： ``` <pre class="calibre18"> ``` 模塊：index 控制器：Index 操作：hello ``` ``` > controller方法獲取的是駝峰命名的實際的控制器名，其它都是小寫返回。 ### 獲取路由和調度信息 hello方法修改如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use think\Request; class Index{ public function hello(Request $request, $name = 'World'){ echo '路由信息：'; dump($request->routeInfo()); echo '調度信息：'; dump($request->dispatch()); return 'Hello,' . $name . '！'; } } ``` ``` 然后在配置文件中添加路由定義為： ``` <pre class="calibre18"> ``` return [ 'hello/:name' =>['index/hello',[],['name'=>'\w+']], ]; ``` ``` 訪問下面的URL地址： ``` <pre class="calibre18"> ``` http: //tp5.com/hello/thinkphp ``` ``` 頁面輸出信息為： ``` <pre class="calibre18"> ``` 路由信息： array (size=4) 'rule' => string 'hello/:name' (length=11) 'route' => string 'index/hello' (length=11) 'pattern' => array (size=1) 'name' => string '\w+' (length=3) 'option' => array (size=0) empty 調度信息： array (size=2) 'type' => string 'module' (length=6) 'module' => array (size=3) 0 => null1 => string 'index' (length=5) 2 => string 'hello' (length=5) Hello,thinkphp！ ``` ``` ## 響應對象 > `Response`對象用于動態響應客戶端請示，控制發送給用戶的信息，并將動態生成響應。通常用于輸出數據給客戶端或者瀏覽器。 `ThinkPHP5`的`Response`響應對象由`think\Response`類或者子類完成，下面介紹下基本的用法。 ### 自動輸出大多數情況，我們不需要關注`Response`對象本身，只需要在控制器的操作方法中返回數據即可，系統會根據`default_return_type`和`default_ajax_return`配置決定響應輸出的類型。默認的自動響應輸出會自動判斷是否`AJAX`請求，如果是的話會自動輸出`default_ajax_return`配置的輸出類型。 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return $data; } } ``` ``` 由于默認是輸出`Html`輸出，所以訪問頁面輸出結果為： ![](https://img.kancloud.cn/83/88/8388a281e2f03fd0551ba92f9ddffe9f_300x63.png) 修改配置文件，添加： ``` <pre class="calibre18"> ``` // 默認輸出類型'default_return_type' => 'json', ``` ``` 再次訪問的輸出結果為： ``` <pre class="calibre18"> ``` {"name":"thinkphp","status":"1"} ``` ``` 修改輸出類型為xml： ``` <pre class="calibre18"> ``` // 默認輸出類型'default_return_type' => 'xml', ``` ``` 則輸出結果變成： ``` <pre class="calibre18"> ``` <think><name>thinkphp</name><status>1</status></think> ``` ``` ### 手動輸出在必要的時候，可以手動控制輸出類型和參數，這種方式較為靈活。如果需要指定輸出類型，可以通過下面的方式： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return json($data); } } ``` ``` 無論配置參數如何設置，頁面輸出的結果為： ``` <pre class="calibre18"> ``` {"name":"thinkphp","status":"1"} ``` ``` 默認的情況下發送的http狀態碼是`200`，如果需要返回其它的狀態碼，可以使用： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return json($data, 201); } } ``` ``` 或者發送更多的響應頭信息： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return json($data, 201, ['Cache-control' => 'no-cache,must-revalidate']); } } ``` ``` 也支持使用下面的方式： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return json($data)->code(201)->header(['Cache-control' => 'no-cache,must-revalidate']); } } ``` ``` 默認支持的輸出類型包括：輸出類型快捷方法渲染模板輸出 view JSON輸出 json JSONP輸出 jsonp XML輸出 xml 頁面重定向 redirect所以，同樣的可以使用`xml`方法輸出`XML`數據類型： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; class Index{ public function hello(){ $data = ['name' => 'thinkphp', 'status' => '1']; return xml($data, 201); } } ``` ``` ### 頁面跳轉如果需要進行一些簡單的頁面操作提示或者重定向，可以引入`traits\controller\Jump`，就可以使用相關頁面跳轉和重定向方法，下面舉一個簡單的例子，當頁面傳入name參數為thinkphp的時候，跳轉到歡迎頁面，其它情況則跳轉到一個guest頁面。 ``` <pre class="calibre18"> ``` namespace app\index\controller; class Index{ use \traits\controller\Jump; public function index($name=''){ if ('thinkphp' == $name) { $this->success('歡迎使用ThinkPHP 5.0','hello'); } else { $this->error('錯誤的name','guest'); } } public function hello(){ return 'Hello,ThinkPHP!'; } public function guest(){ return 'Hello,Guest!'; } } ``` ``` > 這里我們使用 > > ``` > <pre class="calibre25"> > ``` > > use \traits\controller\Jump; > > ``` > > ``` > > 引入了一個`Jump` trait，這是`PHP5.4`版本的新特性，如果你的控制器類是繼承的`\think\Controller`的話，系統已經自動為你引入了 `\traits\controller\Jump`，無需再次引入。當我們訪問 ``` <pre class="calibre18"> ``` http: //tp5.com ``` ``` 頁面顯示如圖所示： ![](http://box.kancloud.cn/2016-07-04_577a788e5feb9.png) 然后顯示 `Hello,Guest!`。如果訪問URL地址為： ``` <pre class="calibre18"> ``` http: //tp5.com?name=thinkphp ``` ``` 則頁面顯示如圖所示： ![](https://img.kancloud.cn/9c/cf/9ccf1ac302b0b8bd07a51e673f952aea_490x251.png) 然后顯示 `Hello,ThinkPHP!`。 ### 頁面重定向如果要進行頁面重定向跳轉，可以使用： ``` <pre class="calibre18"> ``` namespace app\index\controller; class Index{ use \traits\controller\Jump; public function index($name=''){ if ('thinkphp' == $name) { $this->redirect('http://thinkphp.cn'); } else { $this->success('歡迎使用ThinkPHP','hello'); } } public function hello(){ return 'Hello,ThinkPHP!'; } } ``` ``` 當我們再次訪問 ``` <pre class="calibre18"> ``` http: //tp5.com?name=thinkphp ``` ``` 就會重定向到ThinkPHP官網 `http://thinkphp.cn` > `redirect`方法默認使用`302`跳轉，如不需要可以使用第二個參數進行301跳轉。 ``` <pre class="calibre18"> ``` $this->redirect('http://thinkphp.cn',301); ``` ``` 在任何時候（即使沒有引入Jump trait的話），我們可以使用系統提供的助手函數redirect函數進行重定向。 ``` <pre class="calibre18"> ``` namespace app\index\controller; class Index{ public function index($name=''){ if ('thinkphp' == $name) { return redirect('http://thinkphp.cn'); } else { return 'Hello,ThinkPHP!'; } } } ``` ``` ## 總結本章我們了解了`Request`請求對象和`Response`響應對象的基本用法，以及如何更輕松的獲取請求變量。