* * * * * [TOC] ## 創建響應 #### 字符串 & 數組 所有路由和控制器都會返回一個響應并返回給用戶的瀏覽器。Laravel 提供了幾種不同的方式來返回響應。最基本的響應就是從路由或控制器返回一串字符串。框架會自動將字符串轉換為一個完整的 HTTP 響應： ~~~ Route::get('/', function () { return 'Hello World'; }); ~~~ 從路由和控制器不僅能返回字符串，也可以返回數組。框架也會自動地將數組轉為 JSON 響應： ~~~ Route::get('/', function () { return [1, 2, 3]; }); ~~~ > {tip} 你知道嗎？?[Eloquent 集合](集合.md)?也可以從路由和控制器中直接返回，它們會自動轉為 JSON 響應。試試吧！ #### 響應對象 一般來說，你不需要從路由方法返回簡單的字符串或數組。而是需要返回整個?`Illuminate\Http\Response`?實例或?[視圖](視圖.md)。 當返回整個?`Response`?實例時，Laravel 允許自定義響應的 HTTP 狀態碼和響應頭信息。`Response`?實例繼承自?`Symfony\Component\HttpFoundation\Response`?類，該類提供了豐富的構建 HTTP 響應的方法： ~~~ Route::get('home', function () { return response('Hello World', 200) ->header('Content-Type', 'text/plain'); }); ~~~ #### 附加頭信息至響應 大部分的響應方法都是可鏈式調用的，以使你更酣暢淋漓的創建響應實例。例如，你可以在響應返回給用戶前使用?`header`?方法向響應實例中附加一系列的頭信息： ~~~ return response($content) ->header('Content-Type', $type) ->header('X-Header-One', 'Header Value') ->header('X-Header-Two', 'Header Value'); ~~~ 或者，你可以使用?`withHeaders`?方法來指定一個包含頭信息的數組： ~~~ return response($content) ->withHeaders([ 'Content-Type' => $type, 'X-Header-One' => 'Header Value', 'X-Header-Two' => 'Header Value', ]); ~~~ #### 附加 Cookie 至響應 通過響應對象的 cookie 方法可以讓你輕松的附加 cookies 至響應。你可以使用?`cookie`?方法來生成 cookie 并附加至響應實例，像這樣： ~~~ return response($content) ->header('Content-Type', $type) ->cookie('name', 'value', $minutes); ~~~ `cookie`?方法也接受另外幾個參數，它們的使用頻率較低。通常，這些參數和給予原生 PHP 的?[setcookie](https://secure.php.net/manual/en/function.setcookie.php)?方法的參數有著相同的目的和含義： ~~~ ->cookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly) ~~~ #### Cookies 加密 默認情況下，Laravel 生成的所有 cookie 都是加密并通過簽名驗證的，因此他們并不能夠在客戶端被修改和讀取。如果你想對你的應用程序生成的部分 cookie 禁用加密，可以使用?`App\Http\Middleware\EncryptCookies`?中間件的?`$except`?屬性，該文件存儲在?`app/Http/Middleware`： ~~~ /** * 無需被加密的 cookie 名 * * @var array */ protected $except = [ 'cookie_name', ]; ~~~ ## 重定向 重定向響應是?`Illuminate\Http\RedirectResponse`?類的實例，并且包含用戶需要重定向至另一個 URL 所需的頭信息。Laravel 提供了許多方法用于生成?`RedirectResponse`?實例。最簡單的方法是使用全局的?`redirect`?輔助函數： ~~~ Route::get('dashboard', function () { return redirect('home/dashboard'); }); ~~~ 有些情況下你可能希望用戶重定向至上級一頁面，比如，當提交表單失敗時。這時可以使用 全局輔助函數?`back`。由于此功能利用了?[Session](Session.md)，請確保調用?`back`?函數的路由是使用?`web`?中間件組或應用了所有的 Session 中間件： ~~~ Route::post('user/profile', function () { // 驗證請求... return back()->withInput(); }); ~~~ ### 重定向至命名路由 當調用不帶參數的輔助函數?`redirect`?時，會返回一個?`Illuminate\Routing\Redirector`?實例，該實例允許你調用?`Redirector`?實例的任何方法。例如，生成一個?`RedirectResponse`?重定向至一個被命名的路由時，您可以使用?`route`?方法： ~~~ return redirect()->route('login'); ~~~ 如果你的路由有參數，它們可以作為?`route`?方法的第二個參數來傳遞： ~~~ // 對于該 URI 的路由: profile/{id} return redirect()->route('profile', ['id' => 1]); ~~~ #### 通過 Eloquent 模型填充參數 如果要重定向到一個使用了 Eloquent 模型并需要傳遞 ID 參數的路由上，你只需傳遞模型本身即可，ID 會自動提取。 ~~~ // 對于此路由: profile/{id} return redirect()->route('profile', [$user]); ~~~ 如果想要更改自動提取的路由參數的鍵值，你應該重寫 Eloquent 模型里的?`getRouteKey`?方法： ~~~ /** * 獲取模型的路由鍵值. * * @return mixed */ public function getRouteKey() { return $this->slug; } ~~~ ### 重定向至控制器行為 你可能也會用到生成重定向至?[控制器行為](控制器.md)的響應。要實現此功能，可以向?`action`?方法傳遞控制器和行為名稱作為參數來實現。請記住，這里并不需要指定完整的命名空間，因為 Laravel 的?`RouteServiceProvider`?會自動設置基本的控制器命名空間： ~~~ return redirect()->action('HomeController@index'); ~~~ 如果控制器路由包含參數則需要把他們作為?`action`?函數的第二個參數傳遞： ~~~ return redirect()->action( 'UserController@profile', ['id' => 1] ); ~~~ ### 重定向并附加 Session 閃存數據 重定向至一個新的 URL 的同時通常會?[附加 Session 閃存數據](Session.md)。一般來說，在控制器行為成功地執行之后才會向 Session 中閃存成功的消息。為了方便，你可以利用鏈式調用的方式創建一個 RedirectResponse 的實例并閃存數據至 Session： ~~~ Route::post('user/profile', function () { // 更新用戶的信息 return redirect('dashboard')->with('status', 'Profile updated!'); }); ~~~ 用戶重定向至指定頁面后，你可以從 Session 中獲取并展示閃存數據。例如，使用?[Blade 語法](Blade模板.md)： ~~~ @if (session('status')) <div class="alert alert-success"> {{ session('status') }} </div> @endif ~~~ ## 其他響應類型 使用全局輔助函數?`response`?可以輕松的生成其他類型的響應實例。當不帶任何參數調用?`response`?時，將會返回 Illuminate\Contracts\Routing\ResponseFactory?[Contract](Contracts.md)?的實現。Contract 包含許多有用的用來輔助生成響應的方法。 ### 視圖響應 如果你的響應內容不但需要控制響應狀態碼和響應頭信息而且還需要返回一個?[視圖](視圖.md)，這時你應該使用?`view`?方法： ~~~ return response() ->view('hello', $data, 200) ->header('Content-Type', $type); ~~~ 當然，如果不需要自定義 HTTP 狀態碼和響應頭信息，則可使用全局的?`view`?輔助函數。 ### JSON 響應 `json`?方法會自動將?`Content-Type`?響應頭信息設置為?`application/json`，并使用 PHP 的?`json_encode`?函數將數組轉換為 JSON 字符串。 ~~~ return response()->json([ 'name' => 'Abigail', 'state' => 'CA' ]); ~~~ 如果想要創建一個 JSONP 響應，則可以使用?`json`?方法并結合 withCallback 函數： ~~~ return response() ->json(['name' => 'Abigail', 'state' => 'CA']) ->withCallback($request->input('callback')); ~~~ ### 文件下載 `download`?方法可以用于生成強制讓用戶的瀏覽器下載指定路徑文件的響應。`download`?方法接受文件名稱作為方法的第二個參數，此名稱為用戶下載文件時看見的文件名稱。最后，你可以傳遞一個包含 HTTP 頭信息的數組作為第三個參數傳入該方法： ~~~ return response()->download($pathToFile); return response()->download($pathToFile, $name, $headers); ~~~ > {note} 管理文件下載的擴展包 Symfony HttpFoundation，要求下載文件名必須是 ASCII 編碼。 ### 文件響應 `file`?方法可以用來顯示一個文件，例如圖片或者 PDF，直接在用戶的瀏覽器中顯示，而不是開始下載。這個方法的第一個參數是文件的路徑，第二個參數是包含頭信息的數組： ~~~ return response()->file($pathToFile); return response()->file($pathToFile, $headers); ~~~ ## 響應宏 如果你想要自定義可以在很多路由和控制器重復使用的響應，可以使用?`Response`?Facade 實現的?`macro`?方法。舉個例子，來自?[服務提供者](服務提供者.md)的?`boot`?方法： ~~~ <?php namespace App\Providers; use Illuminate\Support\ServiceProvider; use Illuminate\Support\Facades\Response; class ResponseMacroServiceProvider extends ServiceProvider { /** * 注冊應用的響應宏 * * @return void */ public function boot() { Response::macro('caps', function ($value) { return Response::make(strtoupper($value)); }); } } ~~~ `macro`?函數第一個參數為宏名稱，第二個參數為閉包函數。宏的閉包函數會在?`ResponseFactory`?的實現或者輔助函數?`response`?調用宏名稱的時候運行： ~~~ return response()->caps('foo'); ~~~