HTTP 响应

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

基本响应

当然，所有路由和控制器都应该返回某种响应，以便发送回用户的浏览器。Laravel 提供了几种不同的方式来返回响应。最基本的响应是简单地从路由或控制器返回一个字符串：

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

给定的字符串将自动被框架转换为 HTTP 响应。

响应对象

然而，对于大多数路由和控制器动作，您将返回一个完整的 Illuminate\Http\Response 实例或一个 视图。返回一个完整的 Response 实例允许您自定义响应的 HTTP 状态码和头信息。Response 实例继承自 Symfony\Component\HttpFoundation\Response 类，提供了多种方法来构建 HTTP 响应：

use Illuminate\Http\Response;

Route::get('home', function () {
    return (new Response($content, $status))
                  ->header('Content-Type', $value);
});

为了方便，您也可以使用 response 辅助函数：

Route::get('home', function () {
    return response($content, $status)
                  ->header('Content-Type', $value);
});

NOTE

有关可用 Response 方法的完整列表，请查看其 API 文档 和 Symfony API 文档。

为响应附加头信息

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

cookie 方法接受其他可选参数，允许您进一步自定义 Cookie 的属性：

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

或者，您可以使用 Cookie facade 上的 queue 方法创建一个将自动添加到传出响应的 Cookie：

<?php

namespace App\Http\Controllers;

use Cookie;
use App\Http\Controllers\Controller;

class DashboardController extends Controller
{
    /**
     * 显示应用程序仪表板。
     *
     * @return Response
     */
    public function index()
    {
        Cookie::queue('saw_dashboard', true, 15);

        return view('dashboard');
    }
}

在此示例中，saw_dashboard Cookie 将自动添加到传出响应中，而无需强制您手动将 Cookie 附加到特定的响应实例。

Cookie 和加密

默认情况下，Laravel 生成的所有 Cookie 都是加密和签名的，以便客户端无法修改或读取它们。如果您希望为应用程序生成的某个子集的 Cookie 禁用加密，可以使用 App\Http\Middleware\EncryptCookies 中间件的 $except 属性：

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

其他响应类型

response 辅助函数可用于方便地生成其他类型的响应实例。当 response 辅助函数在没有参数的情况下调用时，将返回 Illuminate\Contracts\Routing\ResponseFactory contract 的实现。此 contract 提供了几个有用的方法来生成响应。

视图响应

如果您需要控制响应状态和头信息，但也需要返回一个 视图 作为响应内容，可以使用 view 方法：

return response()
            ->view('hello', $data)
            ->header('Content-Type', $type);

当然，如果您不需要传递自定义 HTTP 状态码或自定义头信息，您应该简单地使用全局 view 辅助函数。

JSON 响应

json 方法将自动将 Content-Type 头信息设置为 application/json，并使用 json_encode PHP 函数将给定数组转换为 JSON：

return response()->json(['name' => 'Abigail', 'state' => 'CA']);

如果您希望创建一个 JSONP 响应，可以在 json 方法中使用 setCallback：

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

文件下载

download 方法可用于生成一个响应，强制用户的浏览器下载给定路径的文件。download 方法接受文件名作为方法的第二个参数，这将决定用户下载文件时看到的文件名。最后，您可以将 HTTP 头信息数组作为方法的第三个参数传递：

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

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

NOTE

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

文件响应

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

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

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

重定向

重定向响应是 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]);

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

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

重定向到控制器动作

您还可以生成到 控制器动作 的重定向。为此，只需将控制器和动作名称传递给 action 方法。请记住，您不需要指定控制器的完整命名空间，因为 Laravel 的 RouteServiceProvider 将自动设置默认控制器命名空间：

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

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

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

重定向并闪存会话数据

重定向到新 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

响应宏

如果您希望定义一个可以在各种路由和控制器中重用的自定义响应，可以在 Response facade 或 Illuminate\Contracts\Routing\ResponseFactory 的实现上使用 macro 方法。

例如，从 服务提供者 的 boot 方法中：

<?php

namespace App\Providers;

use Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * 执行服务的注册后引导。
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

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

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