Laravel5中Cookie的使用

逃离我推掉我的手 2022-06-16 03:29 245阅读 0赞

今天在Laravel框架中使用Cookie的时候，碰到了点问题，自己被迷糊折腾了半多小时.期间研究了Cookie的实现类，也在网站找了许多的资料，包括问答。发现并没有解决问题。网上的答案都是互相抄袭，互相转载。其实并没有什么用处。好在最后，我找到了解决方法。奔着为广大Laravel爱好者和开发人员负责的精神，同时也希望大家在使用Cookie时少走弯路，在这里把在Laravel中Cookie的设置和读取方法贡献出来，供大家批评指正。

### 概述 ###

Cookie的添加其实很简单，直接使用`Cookie::make()`，在使用方法前，需要引入Cookie的门面`use Illuminate\Support\Facades\Cookie;`，这样就可以完成Cookie的设置了(当然不引入直接 \\Cookie 使用也能通过命名空间自动加载)。

不过，设置后我们如何才能取到Cookie值呢？有搜索过相关问题的开发人员肯定知道，网上的答案千篇一律都是：`Cookie::get()`，有的甚至附上了代码：

Cookie::make('test', 'hello, world', 10);
    echo Cookie::get('test');

如果你按照这种类似的回答来测试Cookie，肯定会发现设置cookie的值永远都是null。多次测试无效下，你都会怀疑自己的Laravel框架是不是有问题！

其实，在Laravel框架中使用Cookie，就不得不提到[Response][]和[Request][]。经常用浏览器调试程序的开发者可能会留意过，在请求地址的`Response Headers`和`Request Headers`中，都包含有cookie信息。没错，如果你在Laravel框架中使用Cookie都离不开Response和Request，下面我们就来介绍Cookie的正确添加和获取方法。  
  
1.Cookie::make()、Cookie::forever()、Cookie::get()的使用方法：

![复制代码][copycode.gif]

Route::get('cookieset', function()
    {
        $foreverCookie = Cookie::forever('forever', 'Success');
        $tempCookie = Cookie::make('temporary', 'My name is fantasy', 5);//参数格式：$name, $value, $minutes
        return Response::make()->withCookie($foreverCookie)->withCookie($tempCookie);
    });
    
    
    Route::get('cookietest', function()
    {
         $forever = Cookie::get('forever');
         $temporary = Cookie::get('temporary');
         return View::make('cookietest', array('forever' => $forever, 'temporary' => $temporary, 'variableTest' => 'it works'));
    });

![复制代码][copycode.gif]

//先上一个demo写入cookie
    $cookie = \Cookie('cookie_name', 'value', 5);
            $data = ['title'=>'hello world'];
            return \response()
                ->view('home.hello', $data)
                ->cookie($cookie);

![复制代码][copycode.gif]

2、Cookie存储数组：

![复制代码][copycode.gif]

Route::get('cookieset', function()
    {
        $user_info = array('name'=>'laravel','age'=>12);
        $user = Cookie::make('user',$user_info,30);
        return Response::make()->withCookie($user);
    });
    
    Route::get('cookietest', function()
    {
        dd(Cookie::get('user'));
    });

![复制代码][copycode.gif]

下面详细谈谈laravel的cookie具体咋玩吧

### 添加Cookie ###

例如，我们需要在控制器中设置一个"Hello, Laravel"的cookie值，并设置有效期为10分钟。这里推荐使用cookie的队列方法`Cookie::queue()`，因为这样Cookie会自动添加到响应：

![复制代码][copycode.gif]

<?php
    
    namespace App\Http\Controllers;
    use Cookie;
    use App\Http\Controllers\Controller;
    
    class DashboardController extends Controller
    {
        /**
         * Show the application index.
         *
         * @return Response
         */
        public function index()
        {
            Cookie::queue('test', 'Hello, Laravel', 10);//如果不适用上面的use Cookie,这里可以直接调用 \Cookie
            return view('index');
        }
    }

![复制代码][copycode.gif]

看看Response Headers中是不是多了一条`set-cookie`记录。当然，如果你使用的是Response，可以直接使用Response中的`withCookie()`方法，将cookie添加到响应中：

![复制代码][copycode.gif]

public function index()
    {
        //$response = new Response();
        $cookie = Cookie::make('test', 'Hello, Laravel', 10);
    　　 return \Response::make('index')->withCookie($cookie);
        //return $response->make('index')->withCookie($cookie);
    }

![复制代码][copycode.gif]

要设置一个永不过期的的cookie值，可以使用`Cookie::forever()`方法：

Cookie::forever('test', 'Hello, Laravel');

Cookie自身并不提供该方法，由于Cookie的门面由`\Illuminate\Cookie\CookieJar`提供，所以Cookie可以使用该类中的方法。这里附上`queue()`方法的源码：

![复制代码][copycode.gif]

/**
    * Queue a cookie to send with the next response.
    *
    * @param  mixed
    * @return void
    */
    public function queue()
    {
        if (head(func_get_args()) instanceof Cookie) {
            $cookie = head(func_get_args());
        } else {
            $cookie = call_user_func_array([$this, 'make'], func_get_args());
        }
    
        $this->queued[$cookie->getName()] = $cookie;
    }

![复制代码][copycode.gif]

从源码可以得知，`queue()`方法实际上也是调用的`make()`方法。

> 注意：有些朋友提出在返回的视图上注入cookie的方法 `return view('index')->withCookie($cookie)`，亲测无效。推荐使用 `queue()`

### 获取Cookie ###

在概述里我们提到过，Cookie的使用离不开Response和Request。获取Cookie的值有两个层面，一个是服务端，另一个是客户端。如果要服务端获取到Cookie的值，就需要从Request中获得：

public function index(Request $request)
    {
        $cookie = $request->cookie('test');
        dump($cookie);
    }

如果想获得所有Cookie的值，可以使用不传参数的方法：

public function index(Request $request)
    {
        $cookies = $request->cookie();
        dump($cookies);
    }

再次访问地址，我们会得到一个所有cookie值的数组，包括我们刚刚设置的test：

array:3 [▼
      "XSRF-TOKEN" => "CDSXUUYYHJHGDDFGHJAxPNNsVxLHGTRYUGJ"
      "laravel_session" => "870a775gthhgef0b9f357edc6r6587878999876556"
      "test" => "Hello, Laravel"
    ]

当我们需要在客户端使用的时候，获取Cookie的值就不是这样了。首先，我们通过响应`withCookie($cookie)`传输到客户端的数据并不是一个字符串，而是一个cookie对象：

![复制代码][copycode.gif]

Cookie {#1490 ▼
      #name: "test"
      #value: "Hello, Laravel"
      #domain: null
      #expire: 1493791460
      #path: "/"
      #secure: false
      #httpOnly: true
    }

![复制代码][copycode.gif]

获取value值，Cookie类提供了一个`getValue()`的方法来拿取。例如在模板中编辑代码：

<div>{
       { $cookie->getValue() }}</div>

再次刷新页面时，就会得到设置的test的cookie值：

Hello, Laravel

### 清除Cookie ###

清除Cookie的方法比较简单，原理和设置Cookie一样的，只是将过期时间设置成了过去。这里也需要将Cookie加入到HTTP的Response中，使用`make()`或者`forget()`方法均可：

$cookie = Cookie::forget('test');
    return Redirect::route('index')->withCookie($cookie);

[Response]: http://www.laramist.com/docs/5.2/responses
[Request]: http://www.laramist.com/docs/5.2/requests
[copycode.gif]: /images/20220616/fab15de8c4a744d4ad45d2659c3f9862.png