基礎 ―― HTTP 響應 · Laravel 5.1 中文文檔

# 基礎 —— HTTP 響應 ## 1、基本響應所有路由和控制器都會返回某種被發送到用戶瀏覽器的響應，Laravel提供了多種不同的方式來返回響應，最基本的響應就是從路由或控制器返回一個簡單的字符串： ~~~ Route::get('/', function () { return 'Hello World'; }); ~~~ 給定的字符串會被框架自動轉化為HTTP響應。但是大多數路由和控制器動作都會返回一個完整的`Illuminate\Http\Response`實例或[視圖](http://laravelacademy.org/post/76.html)，返回一個完整的`Response`實例允許你自定義響應的HTTP狀態碼和頭信息，`Response`實例繼承自`Symfony\Component\HttpFoundation\Response`類，該類提供了一系列方法用于創建HTTP響應： ~~~ use Illuminate\Http\Response; Route::get('home', function () { return (new Response($content, $status)) ->header('Content-Type', $value); }); ~~~ 為方便起見，還可以使用幫助函數`response`： ~~~ Route::get('home', function () { return response($content, $status) ->header('Content-Type', $value);}); ~~~ > 注意：查看完整的`Response`方法列表，請移步相應的[API文檔](http://laravel.com/api/master/Illuminate/Http/Response.html)以及[Symfony API文檔](http://api.symfony.com/2.7/Symfony/Component/HttpFoundation/Response.html) ### 1.1 添加響應頭大部分響應方法都是可以鏈式調用的，從而使得可以平滑的構建響應。例如，可以使用`header`方法來添加一系列響應頭： ~~~ return response($content) ->header('Content-Type', $type) ->header('X-Header-One', 'Header Value') ->header('X-Header-Two', 'Header Value'); ~~~ ### 1.2 添加Cookies 使用response實例的幫助函數`withCookie`可以輕松添加cookie到響應，比如，可以使用`withCookie`方法來生成cookie并將其添加到response實例： ~~~ return response($content)->header('Content-Type', $type) ->withCookie('name', 'value'); ~~~ `withCookie`方法接收額外的可選參數從而允許對cookie屬性更多的自定義： ~~~ ->withCookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly) ~~~ 默認情況下，Laravel框架生成的cookies經過加密和簽名，所以在客戶端不能進行修改，如果你想要將特定的cookies子集在生成時取消加密，可以使用中間件`App\Http\Middleware\EncryptCookies`的`$except`屬性： ~~~ /** * 需要被加密的cookies名稱 * * @var array */ protected $except = [ 'cookie_name', ]; ~~~ ## 2、其它響應類型幫助函數`response`可以用來方便地生成其他類型的響應實例，當無參數調用response時會返回`Illuminate\Contracts\Routing\ResponseFactory`[契約](http://laravelacademy.org/post/95.html)的一個實現，該契約提供了一些有用的方法來生成響應。 ### 2.1?視圖響應如果你需要控制響應狀態和響應頭，還需要返回一個[視圖](http://laravelacademy.org/post/76.html)作為響應內容，可以使用`view`方法： ~~~ return response()->view('hello', $data)->header('Content-Type', $type); ~~~ 當然，如果你不需要傳遞一個自定義的HTTP狀態碼或者自定義頭，只需要簡單使用全局的幫助函數`view`即可。 ### 2.2?JSON響應 `json`方法會自動將Content-Type頭設置為`application/json`，并使用PHP函數`json_encode`方法將給定數組轉化為JSON： ~~~ return response()->json(['name' => 'Abigail', 'state' => 'CA']); ~~~ 如果你想要創建一個JSONP響應，可是添加`setCallback`到`json`方法后面： ~~~ return response()->json(['name' => 'Abigail', 'state' => 'CA']) ->setCallback($request->input('callback')); ~~~ ### 2.3?文件下載 `download`方法用于生成強制用戶瀏覽器下載給定路徑文件的響應。`download`方法接受文件名作為第二個參數，該參數決定用戶下載文件的顯示名稱，你還可以將HTTP頭信息作為第三個參數傳遞到該方法： ~~~ return response()->download($pathToFile); return response()->download($pathToFile, $name, $headers); ~~~ > 注意：管理文件下載的`Symfony HttpFoundation`類要求被下載文件有一個ASCII文件名。 ## 3、重定向重定向響應是`Illuminate\Http\RedirectResponse`類的實例，其中包含了必須的頭信息將用戶重定向到另一個URL，有很多方式來生成`RedirectResponse`實例，最簡單的方法就是使用全局幫助函數`redirect`： ~~~ Route::get('dashboard', function () { return redirect('home/dashboard'); }); ~~~ 有時候你想要將用戶重定向到前一個位置，比如，表單提交后，驗證不通過，你就可以使用back幫助函數返回前一個URL： ~~~ Route::post('user/profile', function () { // 驗證請求... return back()->withInput(); }); ~~~ ### 3.1 重定向到命名路由如果調用不帶參數的`redirect`方法，會返回一個`Illuminate\Routing\Redirector`實例，從而可以調用該實例上的任何方法。比如，為了生成一個`RedirectResponse`到命名路由，可以使用`route`方法： ~~~ return redirect()->route('login'); ~~~ 如果路由中有參數，可以將其作為第二個參數傳遞到`route`方法： ~~~ // For a route with the following URI: profile/{id} return redirect()->route('profile', [1]); ~~~ 如果要重定向到帶ID參數的路由，并從Eloquent模型中取數據填充表單，可以傳遞模型本身，ID會被自動解析出來： ~~~ return redirect()->route('profile', [$user]); ~~~ ### 3.2 重定向到控制器動作你還可以生成重定向到[控制器動作](http://laravelacademy.org/post/60.html)，只需簡單傳遞控制器和動作名到`action`方法即可。記住，你不需要指定控制器的完整命名空間，因為Laravel的`RouteServiceProvider`將會自動設置默認的控制器命名空間： ~~~ return redirect()->action('HomeController@index'); ~~~ 當然，如果控制器路由要求參數，你可以將參數作為第二個參數傳遞給action方法： ~~~ return redirect()->action('UserController@profile', [1]); ~~~ ### 3.3 帶一次性Session數據的重定向重定向到一個新的URL并[將數據存儲到一次性session](http://laravelacademy.org/post/230.html#ipt_kb_toc_230_5)中通常是同時完成的，為了方便，可以創建一個`RedirectResponse`實例然后在同一個方法鏈上將數據存儲到session，這種方式在action之后存儲狀態信息時特別方便： ~~~ Route::post('user/profile', function () { // 更新用戶屬性... return redirect('dashboard')->with('status', 'Profile updated!'); }); ~~~ 當然，用戶重定向到新頁面之后，你可以從[session](http://laravelacademy.org/post/230.html)中取出并顯示這些一次性信息，比如，使用[Blade語法](http://laravelacademy.org/post/79.html)實現如下： ~~~ @if (session('status')) <div class="alert alert-success"> {{ session('status') }} </div> @endif ~~~ ## 4、響應宏如果你想要定義一個自定義的響應并且在多個路由和控制器中復用，可以使用`Illuminate\Contracts\Routing\ResponseFactory`實現上的`macro`方法。比如，在一個[服務提供者](http://laravelacademy.org/post/91.html)的`boot`方法中： ~~~ <?php namespace App\Providers; use Illuminate\Support\ServiceProvider; use Illuminate\Contracts\Routing\ResponseFactory; class ResponseMacroServiceProvider extends ServiceProvider { /** * Perform post-registration booting of services. * * @param ResponseFactory $factory * @return void */ public function boot(ResponseFactory $factory) { $factory->macro('caps', function ($value) use ($factory) { return $factory->make(strtoupper($value)); }); } } ~~~ `micro`方法接收響應名稱作為第一個參數，一個閉包函數作為第二個參數，`micro`的閉包在從`ResponseFactory`實現或幫助函數`response`上調用macro名稱的時候被執行： ~~~ return response()->caps('foo'); ~~~ > 擴展閱讀：[實例教程——基本使用、生成Cookie、返回視圖、JSON/JSONP及文件下載](http://laravelacademy.org/post/623.html)