作为程序员一定要保持良好的睡眠,才能好编程

laravel response 对象一些常用功能点

发布时间:2019-05-26

通常,我们并不只是从路由动作简单返回字符串和数组,大多数情况下,都会返回一个完整的 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 方法轻松地将为响应增加 Cookies。例如,你可以像这样使用 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 facade 「队列」, Cookie 以附加到应用程序的传出响应。 queue 方法接受一个 Cookie 实例或创建 Cookie 实例所需的参数。 这些 cookie 在发送到浏览器之前会附加到传出响应中:


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


Cookies & 加密

默认情况下,Laravel 生成的所有 Cookie 都是经过加密和签名,因此不能被客户端修改或读取。 如果你想要应用程序生成的部分 Cookie 不被加密,那么可以使用在 app/Http/Middleware 目录中 App\Http\Middleware\EncryptCookies 中间件的 $except 属性:


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







跳转到控制器 Action

还可以生成到 controller action 的跳转。要达到这个目的,只要把 控制器 和 action 的名称传递给 action 方法。记住,不需要传递控制器的全部命名空间,Laravel 的 RouteServiceProvider 会自动将其设置为基本控制器的命名空间:


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

如果控制器路由需要参数,可以将其作为 action 方法的第二个参数:


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

跳转到外部域名

有时候你需要跳转到应用外的域名。调用 away 方法可以达到此目的,它会创建一个不带有任何额外的 URL 编码、有效性校验和检查的 RedirectResponse 实例:


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

带有传送 Session 值的跳转

跳转到新的 URL 的同时 传送数据给 session 是很常见的。 通常会在成功执行一个动作并传送消息给 session 之后这样做。为了方便起见,你可以创建一个 RedirectResponse 实例并在链式方法调用中将数据传送给 session :


Route::post('user/profile', function () {
    // Update the user's profile...
    return redirect('dashboard')->with('status', 'Profile updated!');
});

在用户跳转后,可以显示 session 中的传送数据。比如使用 Blade syntax :


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





文件下载

download 方法可以用于生成强制用户浏览器下载给定路径文件的响应。 download 方法文件名作为其第二个参数,它将作为用户下载文件的文件名。最后,你可以传递 HTTP 头信息数组作为其第三个参数:


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

{note} 用于管理文件下载的 Symfony HttpFoundation 要求下载的文件有一个 ASCII 文件名。


流下载

有时,你可能希望将给定操作的字符串响应转换为下载响应,而不需要将其写入磁盘。此时可以使用 streamDownload 方法。这个方法接受回调、文件名和可选的头信息数组作为参数:


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