首页 » Laravel 5.3 中文文档 » 正文

「Laravel 5.3 中文文档」HTTP 层 – 响应

| Laravel 5.3 中文文档 | 2 条评论 | (6评) |

创建响应

字符串 & 数组

所有的路由及控制器都应当返回一个响应给用户浏览器。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');
});

附加头部到响应

要记住，大部分的响应方法是可以链式调用的，以便流畅的构造响应实例。例如，在响应发送给用户前，你可以使用 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',
            ]);

附加 Cookies 到响应

响应实例的 cookie 方法允许你轻松的附加 cookie 到响应。例如，你可以这样使用 cookie 方法生成 cookie 并把它附加到响应实例：

return response($content)
                ->header('Content-Type', $type)
                ->cookie('name', 'value', $minutes);

cookie 方法还接收一些不经常使用的额外的参数。一般说来，这些参数与 PHP 原生的 setcookie方法的参数具有相同的目的与意义：

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

Cookie & 加密

Laravel 生成的所有 cookies 都是加密并签名的，以便它们不能被客户端修改或读取。如果你希望应用生成的 cookies 的一部分不被加密，你可以使用 App\Http\Middleware\EncryptCookies 中间件的 $except 属性，它位于 app/Http/Middleware 文件夹中：

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

重定向

重定向响应是 Illuminate\Http\RedirectResponse 类的实例，包含了重定向用户到另一个 URL 所需的合适的头部，有多个方法生成 RedirectResponse 实例。最简单的方法是使用 全局的 redirect 辅助方法：

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

有时候你可能想要重定向用户到前一个位置，例如，提交的表单是不合法的。你可以使用全局的 back 辅助方法来实现这个功能。由于这个功能使用了 session，所有请确保调用 back 的路由使用的 web 中间件组或者应用了 session 的中间件：

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]);

如果你想自定义放置到路由参数中的值，你需要覆盖掉 Eloquent 模型的 getRouteKey 方法：

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

重定向到控制器方法

你可以生成重定向到控制器方法。要这么做，传递控制器及方法名给 action 方法。你不需要指定控制器的完整命名空间，因为 Laravel 的 RouteServiceProvider 会自动设置基本的控制器命名空间：

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

如果你的控制器路由需要参数，你可以给 action 方法传递第二个参数：

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

带闪存 session 数据的重定向

重定向到一个新的 URL 并闪存数据到 session 通常可以在同时完成。在闪存一个成功信息到 session 后会执行这个动作。为方便起见，你可以通过链式方法创建一个 RedirectResponse 实例并闪存数据到 session 中：

Route::post('user/profile', function () {
    // 更新用户配置

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

当用户重定向后，你可以从 session 获取并展示闪存的信息，例如，使用 Blade 语法：

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

其他响应类型

response 辅助方法可以用来生成其他类型的响应实例。当不带参数调用 response 辅助方法时，将返回一个 Illuminate\Contracts\Routing\ResponseFactory contract 的实现。该 contract 提供了几个方法来生成响应。

视图响应

如果你要控制响应的状态及响应头，而且要返回一个视图作为响应内容，你可以使用 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);

响应宏

如果你想自定义一个响应，可以在多个路由和控制器中重复使用，你可以使用 Response facade 的 macro 方法。例如，在服务容器的 boot 方法中：

<?php

namespace App\Providers;

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

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

 

该篇属于专题:《Laravel 5.3 中文文档》

本文共 2 个回复

  • Charles 2017/01/20 21:22

    站长我有句妈卖批不知该不该讲，转发别人翻译的文档就是你的？还恬不知耻的求打赏

    回复

发表评论

友情链接