Laravel 響應

1、創建響應

字符串 & 數組

所有路由和控制器都會返回一個被髮送到用戶瀏覽器的響應，Laravel 提供了多種不同的方式來返回響應，最基本的響應就是從路由或控制器返回一個簡單的字符串，框架會將這個字符串轉化爲一個完整的 HTTP 響應：

Route::get('/', function () {
    return 'Hello World';
});

除了從路由或控制器返回字符串之外，還可以返回數組。框架會自動將數組轉化爲一個 JSON 響應：

Route::get('/', function () {
    return [1, 2, 3];
});

Response 對象

通常，我們並不只是從路由動作簡單返回字符串和數組，大多數情況下，都會返回一個完整的 Illuminate\Http\Response 實例或視圖。

返回一個完整的 Response 實例允許你自定義響應的 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 方法可以輕鬆添加 Cookie 到響應。例如，你可以使用 cookie 方法生成 Cookie 並添加將其添加到響應實例：

return response($content)
    ->header('Content-Type', $type)
    ->cookie('name', 'value', $minutes);

cookie 方法還可以接收更多使用頻率較低的額外可選參數，一般來說，這些參數和 PHP 原生提供的setcookie 方法目的和意義差不多：

->cookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly)

Cookie & 加密

默認情況下，Laravel 框架生成的 Cookie 都經過了加密和簽名，以免在客戶端被篡改。如果你想要讓特定的 Cookie 子集在生成時取消加密，可以使用 app/Http/Middleware 目錄下的中間件 App\Http\Middleware\EncryptCookies 提供的 $except 屬性來排除這些 Cookie：

/**
 * 不需要被加密的cookies名稱
 *
 * @var array
 */
protected $except = [
    'cookie_name',
];

2、重定向

重定向響應是 Illuminate\Http\RedirectResponse 類的實例，其中包含了必須的頭信息將用戶重定向到另一個 URL，有很多方式來生成 RedirectResponse 實例，最簡單的方法就是使用全局輔助函數 redirect：

Route::get('dashboard', function () {
    return redirect('home/dashboard');
});

有時候你想要將用戶重定向到上一個請求的位置，比如，表單提交後，驗證不通過，你就可以使用輔助函數 back 返回到前一個 URL（由於該功能使用了 Session，使用該方法之前確保路由使用了 web 中間件組或者都使用了 session 中間件）：

Route::post('user/profile', function () {
    // 驗證請求...
    return back()->withInput();
});

重定向到命名路由

如果調用不帶參數的 redirect 方法，會返回一個 Illuminate\Routing\Redirector 實例，然後就可以調用 Redirector 實例上的所有方法。例如，要生成一個 RedirectResponse 到命名路由，可以使用 route 方法：

return redirect()->route('login');

如果路由中有參數，可以將其作爲第二個參數傳遞到 route 方法：

// For a route with the following URI: profile/{id}
return redirect()->route('profile', ['id'=>1]);

通過Eloquent模型填充參數
如果要重定向到帶 ID 參數的路由（ Eloquent 模型綁定 ），可以傳遞模型本身，ID 會被自動解析出來：

return redirect()->route('profile', [$user]);

如果你想要自定義這個路由參數中的默認值（默認是id），需要重寫模型實例上的 getRouteKey 方法：

/**
 * Get the value of the model's route key.
 *
 * @return mixed
 */
public function getRouteKey()
{
    return $this->slug;
}

重定向到控制器動作

你還可以生成重定向到控制器動作，只需簡單傳遞控制器和動作名到 action 方法即可。記住，你不需要指定控制器的完整命名空間，因爲 Laravel 的 RouteServiceProvider 將會自動設置默認的控制器命名空間：

return redirect()->action('HomeController@index');

當然，如果控制器路由要求參數，你可以將參數作爲第二個參數傳遞給 action 方法：

return redirect()->action('UserController@profile', ['id'=>1]);

帶一次性 Session 數據的重定向

重定向到一個新的 URL 並將數據存儲到一次性 Session 中通常是同時完成的，爲了方便，可以創建一個 RedirectResponse 實例然後在同一個方法鏈上將數據存儲到 Session，這種方式在 action 之後存儲狀態信息時特別方便：

Route::post('user/profile', function () {
    // 更新用戶屬性...
    return redirect('dashboard')->with('status', 'Profile updated!');
});

當然，用戶重定向到新頁面之後，你可以從 Session 中取出並顯示這些一次性信息，例如，使用 Blade 語法實現如下：

@if (session('status'))
    <div class="alert alert-success">
        {{ session('status') }}
    </div>
@endif

3、其它響應類型

輔助函數 response 可以很方便地用來生成其他類型的響應實例，當無參數調用 response 時會返回 Illuminate\Contracts\Routing\ResponseFactory 契約的一個實現，該契約提供了一些有用的方法來生成響應。

視圖響應

如果你需要控制響應狀態和響應頭，並且還需要返回一個視圖作爲響應內容，可以使用 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 方法之後調用 setCallback 方法：

return response()
        ->json(['name' => 'Abigail', 'state' => 'CA'])
        ->withCallback($request->input('callback'));

文件下載
download 方法用於生成強制用戶瀏覽器下載給定路徑文件的響應。download 方法接受文件名作爲第二個參數，該參數決定用戶下載文件的顯示名稱，你還可以將 HTTP 頭信息作爲第三個參數傳遞到該方法：

return response()->download($pathToFile);
return response()->download($pathToFile, $name, $headers);

注：管理文件下載的 Symfony HttpFoundation 類要求被下載文件有一個 ASCII 文件名。

文件響應

file 方法可用於直接在用戶瀏覽器顯示文件，例如圖片或PDF，而不需要下載，該方法接收文件路徑作爲第一個參數，頭信息數組作爲第二個參數：

return response()->file($pathToFile);
return response()->file($pathToFile, $headers);

4、響應宏

如果你想要定義一個自定義的可以在多個路由和控制器中複用的響應，可以使用 Response 門面上的 macro 方法。例如，在某個服務提供者的 boot 方法中編寫代碼如下：

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro 方法接收響應名稱作爲第一個參數，閉包函數作爲第二個參數，響應宏的閉包在 ResponseFactory 實現類或輔助函數 response 中調用宏名稱的時候被執行：

return response()->caps('foo');