Laravel 之 Cookie 的使用

手册内容

Cookies
从请求中获取 Cookie
Laravel 框架创建的每个 cookie 都会被加密并使用验证码进行签名,这意味着如果客户端更改了它们,便视为无效。若要从请求中获取 cookie 值,你可以在 Illuminate\Http\Request 实例上使用 cookie 方法:

$value = $request->cookie('name');

将 Cookies 附加到响应
你可以使用 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 实例
如果你想要在一段时间以后生成一个可以给定 Symfony\Component\HttpFoundation\Cookie 的响应实例,你可以使用全局辅助函数 cookie。除非此 cookie 被附加到响应实例,否则不会发送回客户端:

$cookie = cookie('name', 'value', $minutes);

return response('Hello World')->cookie($cookie);

Laravel 的 Cookie 用起来蛮优雅的,但还是踩了不少坑,主要是不熟悉框架所致 ?。其实本质还是在使用全局变量 $_COOKIE ,由于原生的使用方式不够友好,因此既然选择了框架,就充分利用其提供的友好封装层。

先来一个最简单的示例:

public function setCookie()
{
    return response('Hello Cookie')->cookie('test', '123', 60);
}

public function getCookie()
{
    echo request()->cookie('test');
}

首先我们要明确 Cookie 是存储在浏览器端的(也就是用户端),所以它就必须依附于具体某个请求和响应。而 Session 是存储在服务端的,它不需要依附在某个请求或者响应头中。

所以我们在使用 Cookie 的时候,就必须配合 Request 和 Response。

获取 Cookie
Laravel 给我们提供了灵活的获取 Cookie 的方式,具体喜欢哪一种按个人喜好来吧~

通过调用 Illuminate\Http\Request 实例对象的 cookie 方法获取

$value = $request->cookie('key');
$value = request()->cookie('key');

通过 Cookie Facade 方式

use Illuminate\Support\Facades\Cookie;
// ...
$value = Cookie::get('key');

其实第二种方式获取 Cookie 值也是通过第一种方式调用的,我们可以在 Illuminate\Support\Facades\Cookie 类中的 get() 方法中看到:

public static function get($key = null, $default = null)
{
    return static::$app['request']->cookie($key, $default);
}

设置 Cookie
我们在需要设置 Cookie 的请求方法中,通过 Response 的 cookie() 方法进行设置:

$value = response('Hello Cookie')->cookie('key', 'value', 60);
$value = response('Hello Cookie')->withCookie('key', 'value', 60);

上面两种方式均可,第一种方式其实就是调用了第二种方式(有时候选择多了反而增加记忆成本 ?)。

还有一种使用 helper 函数。。。

function cookie($name = null, $value = null, $minutes = 0, $path = null, $domain = null, $secure = false, $httpOnly = true, $raw = false, $sameSite = null) {}

推荐还是使用第一种方式,因为可以正确的理解 Cookie 的设置方式。

删除 Cookie
开篇也说过 Cookie 是保存在客户端的,所以删除的操作其实服务端是没权限去做的,那么这里所谓删除其实就是使 Cookie 失效。Laravel 提供了友好的 API 供我们调用,感谢 Laravel ?~

use Illuminate\Support\Facades\Cookie;
// ...
Cookie::forget('key');
细心你会发现这个类中没有这个静态方法,和 Cookie::forever('key', 'value') 一样,这些好用的 API 是 Illuminate\Cookie\CookieJar 这个类提供的(这个类是通过 ServiceProvider 在 Illuminate\Foundation\Application 类中注册,然后在 /bootstrap/app.php 实例化,详细的读源码~)


public function forget($name, $path = null, $domain = null)
{
    return $this->make($name, null, -2628000, $path, $domain);
}

我们可以看到其实就是将 Cookie 的有效期(Expires/Max-Age)设置成过去时即可。

更细心的你会发现光是这一句并没有什么卵用啊 ?,别忘了我们要把更改后的 Cookie 加入到响应头中,这样客户端才会修改 Cookie 值(说到这里其实本质还是在设置 Cookie 而已 ?)。

use Illuminate\Support\Facades\Cookie;
// ...
public function demo()
{
    $cookie = Cookie::forget('key');

    return response('xxx')->cookie($cookie);
}

明文 Cookie
很多时候 Cookie 是需要被前端童鞋使用的,但是默认情况下 Laravel 在响应头中添加的 Cookie 信息是加密过的,类似 eyJpdiI6IjRwOFMyTkl2aGs2TGt4OUcxYXRNXC9BPT0iLCJ2YWx1ZSI6IkpHN0Fqb0ZSaDFxVHE0OHdFRXdXMHc9PSIsIm1hYyI6Ijc2MTljZDVmZDI1Mjg5MTk3NTBlZGM0MzUxMjUyZjQ5MzcxOGE1MWU4Y2ViZTBlYTY5YWRjZjNkZjUwNzNkMDEifQ%3D%3D ,这种时候就得将那些需要 明文 传输的 Cookie 加入到 白名单 中去:

/app/Http/Middleware/EncryptCookies.php 中的 $except 数组中将其加入,

protected $except = [
    'key'
];

小结

其实 Laravel 的 Cookie 还有不少好用的方法,比如 Cookie::has('key') 判断在请求头中是否存在某个 Cookie。多去看看框架源码,惊喜彩蛋 ? 总是让你那么开心 ?!

非特殊说明,本博所有文章均为博主原创。

备注:相关侵权、举报、投诉及建议等,请联系站长

添加新评论

昵称
邮箱
网站