教程 > Laravel 教程 > Laravel 基础 阅读：122

Laravel HTTP Response

本章目录

创建Response

字符串和数组

所有路由和控制器都应向用户的浏览器返回响应消息。Laravel提供了几种不同的返回响应的方式。最基本的响应是从路由或控制器返回字符串。Laravel框架将自动把字符串转换为完整的HTTP响应：

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

除了从路由和控制器返回字符串外，我们还可以返回数组。数组将自动被转换为JSON响应：

Route::get('/', function () {
    return [1, 2, 3];
});

我们还可以从路由或控制器返回Eloquent集合，它们将自动被转换为JSON。试一试！

Response 对象实例

通常情况下，我们不仅会从路由操作中返回简单的字符串或数组。而且，我们还会返回完整的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');
});

给Response添加消息头——header

请记住，大多数响应方法返回的都是一个Response实例，可以继续调用其中的方法，形成一个链，从而可以流畅地构建响应实例。例如，我们可以使用header方法在将Response发送回用户之前向Response添加一系列标头：

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 () {
        // ...
    });
});

在响应消息中返回Cookie

Response 实例中的cookie方法可以轻松地将Cookie添加到响应消息。例如，我们可以使用cookie方法生成Cookie，并将其附加到Response实例，如下所示：

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

cookie方法还有很多其他的参数，这些参数都不经常使用。通常，这些参数与PHP的setcookie方法具有相同的目的和含义：

return response($content)->cookie($name, $value, $minutes, $path, $domain, $secure, $httpOnly);

另外，我们可以使用Cookie Facade来将cookie加入队列，依次将其附加到应用程序的响应中。queue方法接受Cookie实例或创建Cookie实例所需的参数。这些Cookie将在发送到浏览器之前附加到Response响应中：

Cookie::queue(Cookie::make('name', 'value', $minutes));

Cookie::queue('name', 'value', $minutes);

Cookies和加密

默认情况下，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帮助函数来实现。由于此功能利用了session，因此请确保调用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模型填充参数

如果要重定向到Eloquent模型中填充的带有“ ID”参数的路由，则可以传递模型本身。该ID将自动提取：

// For a route with the following URI: profile/{id}

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

如果要自定义放置在route参数中的值，可以在路由的参数定义（profile/{id:slug}）中指定列，也可以在Eloquent Model中重写getRouteKey方法：

/**
 * Get the value of the model's route key.
 *
 * @return mixed
 */
public function getRouteKey()
{
    return $this->slug;
}

重定向到控制器方法

我们还可以生成到控制器方法的重定向。将控制器和操作名称传递给action方法。记住，不需要为控制器指定完整的命名空间，因为LaravelRouteServiceProvider会自动设置控制器的基本命名空间：

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

如果控制器路由需要参数，则可以将这些参数以数组的形式传给action方法的第二个参数：

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

重定向到外部域

有时我们可能需要重定向到应用程序外部的域。可以通过调用away方法来执行此操作，该方法将创建一个RedirectResponse实例，该实例不带任何其他URL编码，验证或验证的方法：

return redirect()->away('https://www.jiyik.com');

使用闪存的会话数据进行重定向

重定向到新的URL并将数据暂存到会话通常是在同一时间完成的。通常，当我们在执行完一个操作后，当成功将消息闪存到会话时重定向就完成了。为了方便起见，我们可以创建一个RedirectResponse实例，并在方法链中将数据闪存到会话中：

Route::post('user/profile', function () {
    // Update the user's profile...

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

重定向用户后，可以显示会话中的消息。例如，使用Blade语法：

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

其他回应类型

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方法的第二个参数指定的文件名，用户下载的文件就使用该文件名命名。最后，download方法的第三个参数是用来指定HTTP消息头的，该参数需要一个数组：

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

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

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

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

流式下载

有时，我们可能希望将给定操作的字符串响应转换为可下载的响应，而不必将操作的内容写入磁盘。在这种情况下可以使用使用streamDownload方法。此方法有三个参数，回调函数，文件名和HTTP消息头（数组形式），其中第三个参数——HTTP消息头是可选的：

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

FILE 响应

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

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

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

响应宏

如果要定义可在各种路由和控制器中重复使用的自定义响应，则可以使用Response Facade的macro方法。例如，在Service Provider的 boot方法中使用：

<?php

namespace App\Providers;

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

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Register the application's response macros.
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

macro函数有两个参数，第一个是响应名称，第二个参数是一个回调函数。从ResponseFactory的实现或response帮助函数中调用宏名称时，将执行指定的宏的闭包：

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

也就是说，通过macro 定义一个宏caps，并且给其指定了一个函数。这个宏，caps，可以使用Response的实例调用，如果指定的回调函数有参数，那在调用caps时也需要传递一个参数。

查看笔记

扫码一下
查看教程更方便