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 头部。指令应使用对应缓存控制指令的“snake case”等效形式提供，并以分号分隔。如果在指令列表中指定了 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 外观来“排队” cookie，以便在发送响应时附加到响应。queue 方法接受创建 cookie 实例所需的参数。这些 cookie 将在发送到浏览器之前附加到传出的响应

use Illuminate\Support\Facades\Cookie;
 
Cookie::queue('name', 'value', $minutes);

如果您想生成一个 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 和加密

默认情况下，由于 Illuminate\Cookie\Middleware\EncryptCookies 中间件，Laravel 生成的所有 cookie 都会被加密和签名，因此客户端无法修改或读取它们。如果您想为应用程序生成的 cookie 子集禁用加密，则可以在应用程序的 bootstrap/app.php 文件中使用 encryptCookies 方法

->withMiddleware(function (Middleware $middleware) {
    $middleware->encryptCookies(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 () {
    // Validate the request...
 
    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 将会自动提取。

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

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

/**
 * Get the value of the model's route key.
 */
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://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），而不是启动下载。此方法接受文件的绝对路径作为其第一个参数，并接受标头数组作为其第二个参数。

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); // Simulate delay between chunks...
        }
    }, 200, ['X-Accel-Buffering' => 'no']);
});

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

流式 JSON 响应

如果您需要增量流式传输 JSON 数据，可以使用 streamJson 方法。此方法对于需要逐步发送到浏览器的大型数据集尤其有用，该格式可以轻松地被 JavaScript 解析。

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

流式下载

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

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

响应宏

如果您想定义一个可以在各种路由和控制器中重复使用的自定义响应，您可以使用 Response 外观上的 macro 方法。通常，您应该从应用程序的服务提供者之一（例如 App\Providers\AppServiceProvider 服务提供者）的 boot 方法中调用此方法。

<?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');