响应

创建响应

字符串和数组

所有的路由和控制器都应该返回响应以发送回用户的浏览器。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 头。指令应使用相应的 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 方法将 cooki e附加到 Illuminate\Http\Response 实例中。需要将 cookie 的名称、值和 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 门面向响应的"队列"中添加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 门面的 expire 方法来让 Cookie 过期：

Cookie::expire('name');

Cookie & 加密

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

/**
 * The names of the cookies that should not be encrypted.
 *
 * @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 模型填充参数

如果您要将一个从 Eloquent 模型中填充的“ID”参数重定向到一个路由，则可以直接传递模型本身，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 方法来实现，该方法创建一个 RedirectResponse，没有任何额外的 URL 编码、验证或验证：

return redirect()->away('https://geekr.dev');

重定向到闪存会话数据

重定向到新的 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 辅助函数可用于生成其他类型的响应实例。当没有参数调用响应助手时，将返回 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 头部作为 download 方法的第三个参数传递进去。

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 门面上使用 macro 方法。通常情况下，你应该从你应用程序的服务提供者之一的 boot 方法中调用此方法，例如 App\Providers\AppServiceProvider 服务提供者：

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Response::macro('caps', function (string $value) {
            return Response::make(strtoupper($value));
        });
    }
}

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

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