HTTP 响应

创建响应

字符串和数组

所有路由和控制器都应返回一个响应，发送回用户的浏览器。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 () {
        // ...
    });
});

附加响应的 Cookies

您可以使用 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 Facade 排队 Cookie

如果您希望确保一个 cookie 会随响应一起发送，但您还没有响应实例，您可以使用 Cookie facade 来 “排队” 要附加到响应中的 cookies。queue 方法接受创建 cookie 实例所需的参数。这些 cookies 将在响应发送到浏览器之前附加到响应中：

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 过期，从而删除 cookie：

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

如果您还没有即将发送的响应实例，您可以使用 Cookie facade 的 expire 方法使 cookie 过期：

Cookie::expire('name');

Cookies 和加密

默认情况下，由于 Illuminate\Cookie\Middleware\EncryptCookies 中间件的存在，Laravel 生成的所有 cookies 都会被加密和签名，这样客户端就无法修改或读取这些 cookies。如果您希望禁用加密，只针对您应用程序生成的某些 cookies，可以在应用程序的 bootstrap/app.php 文件中使用 encryptCookies 方法：

->withMiddleware(function (Middleware $middleware) {
    $middleware->encryptCookies(except: [
        'cookie_name',
    ]);
})

在这个示例中，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 实例上调用任何方法。例如，要生成一个重定向响应到一个命名路由，您可以使用 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 方法：

/**
 * 获取模型的路由键值。
 */
public function getRouteKey(): mixed
{
    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 方法来实现，这将创建一个没有任何额外 URL 编码、验证或验证的 RedirectResponse：

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 格式的文件名。

文件响应

file 方法可用于直接在用户的浏览器中显示文件，例如图像或 PDF，而不是启动下载。该方法接受文件的绝对路径作为第一个参数，第二个参数是一个 HTTP 头的数组：

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

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

流式响应

通过将数据在生成时流式传输到客户端，您可以显著减少内存使用并提高性能，特别是对于非常大的响应。流式响应允许客户端在服务器完成发送数据之前就开始处理数据：

function streamedContent(): Generator {
    yield 'Hello, ';
    yield 'World!';
}

Route::get('/stream', function () {
    return response()->stream(function (): void {
        foreach (streamedContent() as $chunk) {
            echo $chunk;
            ob_flush();
            flush();
            sleep(2); // 模拟每个数据块之间的延迟...
        }
    }, 200, ['X-Accel-Buffering' => 'no']);
});

在内部，Laravel 使用了 PHP 的输出缓冲功能。如上例所示，您应使用 ob_flush 和 flush 函数将缓冲内容推送到客户端。

流式 JSON 响应

如果您需要逐步流式传输 JSON 数据，可以使用 streamJson 方法。这个方法特别适用于需要以浏览器可轻松解析的格式逐步发送的大数据集：

use App\Models\User;

Route::get('/users.json', function () {
    return response()->streamJson([
        'users' => User::cursor(),
    ]);
});

流式下载

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

use App\Services\GitHub;

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

响应宏

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

<?php

namespace App\Providers;

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

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

macro 方法的第一个参数是宏的名称，第二个参数是一个闭包。当从 ResponseFactory 实现或 response 辅助函数中调用该宏名称时，将执行宏的闭包：

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