HTTP 响应

• 创建响应
  • 为响应附加头信息
  • 为响应附加 Cookie
  • Cookie 与加密
• 重定向
  • 重定向到命名路由
  • 重定向到控制器动作
  • 重定向到外部域名
  • 重定向并闪存会话数据
• 其他响应类型
  • 视图响应
  • JSON 响应
  • 文件下载
  • 文件响应
• 响应宏

创建响应

字符串和数组

所有路由和控制器都应返回一个响应，以便发送回用户的浏览器。Laravel 提供了几种不同的方式来返回响应。最基本的响应是从路由或控制器返回一个字符串。框架会自动将字符串转换为完整的 HTTP 响应：

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

除了从路由和控制器返回字符串之外，您还可以返回数组。框架会自动将数组转换为 JSON 响应：

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

您知道吗，您还可以从路由或控制器返回 Eloquent 集合？它们会自动转换为 JSON。试试看！

响应对象

通常，您不会仅仅从路由动作返回简单的字符串或数组。相反，您将返回完整的 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');
});

Eloquent 模型和集合

您还可以直接从路由和控制器返回 Eloquent ORM 模型和集合。当您这样做时，Laravel 会自动将模型和集合转换为 JSON 响应，同时尊重模型的 隐藏属性：

use App\Models\User;

Route::get('/user/{user}', function (User $user) {
    return $user;
});

为响应附加头信息

请记住，大多数响应方法都是可链式的，允许以流畅的方式构建响应实例。例如，您可以使用 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',
            ]);

缓存控制中间件

Laravel 包含一个 cache.headers 中间件，可以用于快速设置一组路由的 Cache-Control 头信息。指令应使用对应缓存控制指令的“蛇形命名法”等效形式，并用分号分隔。如果在指令列表中指定了 etag，则响应内容的 MD5 哈希将自动设置为 ETag 标识符：

Route::middleware('cache.headers:public;max_age=2628000;etag')->group(function () {
    Route::get('/privacy', function () {
        // ...
    });

    Route::get('/terms', function () {
        // ...
    });
});

为响应附加 Cookie

您可以使用 cookie 方法将 Cookie 附加到传出的 Illuminate\Http\Response 实例。您应传递名称、值和 Cookie 应被视为有效的分钟数给此方法：

return response('Hello World')->cookie(
    'name', 'value', $minutes
);

cookie 方法还接受一些不太常用的参数。通常，这些参数的目的和意义与传递给 PHP 原生 setcookie 方法的参数相同：

return response('Hello World')->cookie(
    'name', 'value', $minutes, $path, $domain, $secure, $httpOnly
);

如果您希望确保 Cookie 随传出的响应一起发送，但您尚未拥有该响应的实例，您可以使用 Cookie facade 来“排队” Cookie，以便在发送响应时将其附加到响应中。queue 方法接受创建 Cookie 实例所需的参数。这些 Cookie 将在响应发送到浏览器之前附加到传出的响应中：

use Illuminate\Support\Facades\Cookie;

Cookie::queue('name', 'value', $minutes);

生成 Cookie 实例

如果您希望生成一个 Symfony\Component\HttpFoundation\Cookie 实例，可以在稍后时间附加到响应实例，您可以使用全局 cookie 辅助函数。此 Cookie 不会被发送回客户端，除非它被附加到响应实例：

$cookie = cookie('name', 'value', $minutes);

return response('Hello World')->cookie($cookie);

提前过期 Cookie

您可以通过传出响应的 withoutCookie 方法来过期 Cookie，从而移除它：

return response('Hello World')->withoutCookie('name');

如果您尚未拥有传出响应的实例，您可以使用 Cookie facade 的 expire 方法来过期 Cookie：

Cookie::expire('name');

Cookie 与加密

默认情况下，Laravel 生成的所有 Cookie 都是加密和签名的，以防止它们被客户端修改或读取。如果您希望为应用程序生成的部分 Cookie 禁用加密，您可以使用位于 app/Http/Middleware 目录中的 App\Http\Middleware\EncryptCookies 中间件的 $except 属性：

/**
 * 不应加密的 Cookie 名称。
 *
 * @var array
 */
protected $except = [
    'cookie_name',
];

重定向

重定向响应是 Illuminate\Http\RedirectResponse 类的实例，并包含重定向用户到另一个 URL 所需的适当头信息。有几种方法可以生成 RedirectResponse 实例。最简单的方法是使用全局 redirect 辅助函数：

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

有时您可能希望将用户重定向到他们之前的位置，例如当提交的表单无效时。您可以使用全局 back 辅助函数来实现。由于此功能利用了 会话，请确保调用 back 函数的路由使用了 web 中间件组：

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 模型填充参数

如果您正在重定向到一个带有“ID”参数的路由，并且该参数是从 Eloquent 模型中填充的，您可以传递模型本身。ID 将自动提取：

// 对于具有以下 URI 的路由：/profile/{id}

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

如果您希望自定义放置在路由参数中的值，您可以在路由参数定义中指定列（/profile/{id:slug}），或者您可以重写 Eloquent 模型上的 getRouteKey 方法：

/**
 * 获取模型路由键的值。
 *
 * @return mixed
 */
public function getRouteKey()
{
    return $this->slug;
}

重定向到控制器动作

您还可以生成到 控制器动作 的重定向。为此，请将控制器和动作名称传递给 action 方法：

use App\Http\Controllers\UserController;

return redirect()->action([UserController::class, 'index']);

如果您的控制器路由需要参数，您可以将它们作为 action 方法的第二个参数传递：

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

重定向到外部域名

有时您可能需要重定向到应用程序之外的域名。您可以通过调用 away 方法来实现，该方法创建一个 RedirectResponse，而无需任何额外的 URL 编码、验证或验证：

return redirect()->away('https://www.google.com');

重定向并闪存会话数据

重定向到新 URL 并 闪存数据到会话 通常同时进行。通常，这是在成功执行操作后完成的，当您将成功消息闪存到会话时。为了方便起见，您可以创建一个 RedirectResponse 实例，并在单个流畅的方法链中将数据闪存到会话：

Route::post('/user/profile', function () {
    // ...

    return redirect('dashboard')->with('status', 'Profile updated!');
});

在用户被重定向后，您可以从 会话 中显示闪存的消息。例如，使用 Blade 语法：

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

重定向并附带输入

您可以使用 RedirectResponse 实例提供的 withInput 方法，在将用户重定向到新位置之前，将当前请求的输入数据闪存到会话中。这通常是在用户遇到验证错误时完成的。一旦输入被闪存到会话中，您可以在下一个请求期间轻松 检索它 以重新填充表单：

return back()->withInput();

其他响应类型

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 方法与 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);

管理文件下载的 Symfony HttpFoundation 要求下载的文件具有 ASCII 文件名。

流式下载

有时您可能希望将给定操作的字符串响应转换为可下载的响应，而无需将操作的内容写入磁盘。在这种情况下，您可以使用 streamDownload 方法。此方法接受一个回调、文件名和一个可选的头信息数组作为其参数：

use App\Services\GitHub;

return response()->streamDownload(function () {
    echo GitHub::api('repo')
                ->contents()
                ->readme('laravel', 'laravel')['contents'];
}, 'laravel-readme.md');

文件响应

file 方法可用于在用户的浏览器中直接显示文件（如图像或 PDF），而不是启动下载。此方法接受文件路径作为其第一个参数和头信息数组作为其第二个参数：

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

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

响应宏

如果您希望定义一个可以在多个路由和控制器中重用的自定义响应，您可以在 Response facade 上使用 macro 方法。通常，您应该在应用程序的一个 服务提供者 的 boot 方法中调用此方法，例如 App\Providers\AppServiceProvider 服务提供者：

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro 函数接受一个名称作为其第一个参数和一个闭包作为其第二个参数。当从 ResponseFactory 实现或 response 辅助函数调用宏名称时，将执行宏的闭包：

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