# Laravel 的請求返回 Response - [創建響應](#creating-responses) - [附加頭信息到響應](#attaching-headers-to-responses) - [附加 Cookie 到響應](#attaching-cookies-to-responses) - [Cookies 和 加密](#cookies-and-encryption) - [重定向](#redirects) - [重定向至命名路由](#redirecting-named-routes) - [重定向至控制器行為](#redirecting-controller-actions) - [重定向并使用 Session 閃存數據](#redirecting-with-flashed-session-data) - [其他響應類型](#other-response-types) - [視圖響應](#view-responses) - [JSON 響應](#json-responses) - [文件下載](#file-downloads) - [文件響應](#file-responses) - [響應宏](#response-macros) <a name="creating-responses"></a> ## 創建響應 #### 字符串 & 數組 所有路由和控制器都會返回一個響應并發送給用戶的瀏覽器。Laravel 提供了幾種不同的方式來返回響應。最基本的響應就是從路由或控制器返回一串字符串。框架會自動將字符串轉換為一個完整的 HTTP 響應： Route::get('/', function () { return 'Hello World'; }); 從路由和控制器不僅能返回字符串，也可以返回數組。框架也會自動地將數組轉為 JSON 響應： Route::get('/', function () { return [1, 2, 3]; }); > {tip} 你知道嗎？ [Eloquent 集合](/docs/{{version}}/eloquent-collections) 也可以從路由和控制器中直接返回，它們會自動轉為 JSON 響應。試試吧！ #### 響應對象 一般來說，你不需要從路由方法返回簡單的字符串或數組。而是需要返回整個 `Illuminate\Http\Response` 實例或 [視圖](/docs/{{version}}/views)。 當返回整個 `Response` 實例時，Laravel 允許自定義響應的 HTTP 狀態碼和響應頭信息。`Response` 實例繼承自 `Symfony\Component\HttpFoundation\Response` 類，該類提供了豐富的構建 HTTP 響應的方法： Route::get('home', function () { return response('Hello World', 200) ->header('Content-Type', 'text/plain'); }); <a name="attaching-headers-to-responses"></a> #### 附加頭信息至響應 大部分的響應方法都是可鏈式調用的，使得你可以流暢地創建響應實例。例如，你可以在響應返回給用戶前使用 `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', ]); <a name="attaching-cookies-to-responses"></a> #### 附加 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) <a name="cookies-and-encryption"></a> #### Cookies 和 加密 默認情況下，Laravel 生成的所有 Cookie 都是加密并通過簽名驗證的，用此不能被客戶端修改或讀取。 如果您想要為應用程序生成的部分 Cookie 禁用加密，那么可以使用 `App\Http\Middleware\EncryptCookies` 中間件的 `$except` 屬性，文件都在 `app/Http/Middleware` 目錄中： /** * 不需要加密的 Cookie 名稱。 * * @var array */ protected $except = [ 'cookie_name', ]; <a name="redirects"></a> ## 重定向 重定向響應是 `Illuminate\Http\RedirectResponse` 類的實例，并且包含用戶需要重定向至另一個 URL 所需的頭信息。Laravel 提供了許多方法用于生成 `RedirectResponse` 實例。最簡單的方法是使用全局的 `redirect` 輔助函數： Route::get('dashboard', function () { return redirect('home/dashboard'); }); 有時候你可能希望用戶重定向到上一級頁面，比如提交的表單是無效的。這時你可以使用 全局輔助函數 `back` 完成。由于這個功能利用了 [Session](/docs/{{version}}/session)，請確保調用 `back` 函數的路由是使用 `web` 中間件組或應用了所有的 Session 中間件： Route::post('user/profile', function () { // 驗證請求... return back()->withInput(); }); <a name="redirecting-named-routes"></a> ### 重定向至命名路由 當你調用不帶參數的 `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; } <a name="redirecting-controller-actions"></a> ### 重定向至控制器行為 你可能會生成重定向到 [控制器行為](/docs/{{version}}/controllers) 的響應。要實現這個功能，可以把控制器和行為名稱傳遞給 `action` 方法來實現。記住，您不一定要為控制器指定完整的命名空間，因為 Laravel 的 `RouteServiceProvider` 會自動設置基本的控制器命名空間： return redirect()->action('HomeController@index'); 如果你的控制器路由需要參數，你可以把它們放在 `action` 方法的第二個參數來傳遞 return redirect()->action( 'UserController@profile', ['id' => 1] ); <a name="redirecting-with-flashed-session-data"></a> ### 重定向并使用 Session 閃存數據 重定向到一個新的 URL 的同時通常會 [附加 Session 閃存數據](/docs/{{version}}/session#flash-data)。通常在控制器行為執行成功后會將成功的消息傳在 Session 閃存中。為了方便起見，您可以用鏈式的方式創建一個 `RedirectResponse` 的實例并閃存在 Session 中： Route::post('user/profile', function () { // 更新用戶的信息... return redirect('dashboard')->with('status', 'Profile updated!'); }); 用戶重定向后，您可以從 [session](/docs/{{version}}/session) 中顯示閃存的消息。例如，使用 [Blade 語法](/docs/{{version}}/blade): @if (session('status')) <div class="alert alert-success"> {{ session('status') }} </div> @endif <a name="other-response-types"></a> ## 其他響應類型 使用 `response` 輔助函數可以用來生成其他響應實例。當 `response` 不帶參數調用時，則會返回 `Illuminate\Contracts\Routing\ResponseFactory` [Contract](/docs/{{version}}/contracts) 的實例。 Contract 提供了幾種輔助生成響應的方法。 <a name="view-responses"></a> ### 視圖響應 如果您的響應內容不但需要控制響應狀態和響應頭還需要返回一個 [視圖](/docs/{{version}}/views) 最為響應內容，則應該使用 `view` 方法: return response() ->view('hello', $data, 200) ->header('Content-Type', $type); 當然，如果您不需要自定義 HTTP 狀態碼或者頭信息，則應該使用全局的 `view` 輔助函數。 <a name="json-responses"></a> ### 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')); <a name="file-downloads"></a> ### 文件下載 `download` 方法可以用來生成強制用戶瀏覽器下載指定路徑文件的響應。`download` 方法的第二個參數接受一個文件名稱，它將作為用戶下載的時候看見的文件名稱。最后，你可以傳遞一個 HTTP 響應頭數組最為該方法的第三個參數： return response()->download($pathToFile); return response()->download($pathToFile, $name, $headers); return response()->download($pathToFile)->deleteFileAfterSend(true); > {note} 管理文件下載的擴展包 Symfony HttpFoundation，要求下載文件名必須是 ASCII 編碼的。 <a name="file-responses"></a> ### 文件響應 `file` 方法可以直接在用戶瀏覽器顯示文件，例如圖像或者 PDF，而不是下載。此方法的第一個參數時文件路徑，第二個參數為響應頭信息的數組： return response()->file($pathToFile); return response()->file($pathToFile, $headers); <a name="response-macros"></a> ## 響應宏 如果你想要自定義可以在很多路由和控制器重復使用的響應，可以使用 `Response` Facade 實現的 `macro` 方法。例如，從 [服務提供者](/docs/{{version}}/providers) 的 `boot` 方法： <?php namespace App\Providers; use Illuminate\Support\ServiceProvider; use Illuminate\Support\Facades\Response; class ResponseMacroServiceProvider extends ServiceProvider { /** * Register the application's response macros. * * @return void */ public function boot() { Response::macro('caps', function ($value) { return Response::make(strtoupper($value)); }); } } `macro` 函數第一個參數為宏名稱，第二個參數為閉包函數。宏的閉包函數會在 `ResponseFactory` 的實現或者輔助函數 `response` 調用宏名稱的時候運行： return response()->caps('foo'); ## 譯者署名 | 用戶名 | 頭像 | 職能 | 簽名 | |---|---|---|---| | [Seven Du](https://github.com/medz) | <img class="avatar-66 rm-style" src="https://avatars3.githubusercontent.com/u/5564821?s=300"> | 翻譯 | 基于 Laravel 的社交開源系統 [ThinkSNS+](https://github.com/slimkit/thinksns-plus) 歡迎 Star。 | --- > {note} 歡迎任何形式的轉載，但請務必注明出處，尊重他人勞動共創開源社區。 > > 轉載請注明：本文檔由 Laravel China 社區 [laravel-china.org](https://laravel-china.org) 組織翻譯，詳見 [翻譯召集帖](https://laravel-china.org/topics/5756/laravel-55-document-translation-call-come-and-join-the-translation)。 > > 文檔永久地址： https://d.laravel-china.org