Laravel5中Cookie的使用

今天在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()的使用方法：

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

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

2、Cookie存儲數組：

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

下面詳細談談laravel的cookie具體咋玩吧

添加Cookie

例如，我們需要在控制器中設置一個"Hello, Laravel"的cookie值，並設置有效期為10分鍾。這里推薦使用cookie的隊列方法Cookie::queue()，因為這樣Cookie會自動添加到響應：

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

看看Response Headers中是不是多了一條set-cookie記錄。當然，如果你使用的是Response，可以直接使用Response中的withCookie()方法，將cookie添加到響應中：

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

要設置一個永不過期的的cookie值，可以使用Cookie::forever()方法：

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

Cookie自身並不提供該方法，由於Cookie的門面由\Illuminate\Cookie\CookieJar提供，所以Cookie可以使用該類中的方法。這里附上queue()方法的源碼：

/**
* 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;
}

從源碼可以得知，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對象：

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

 

獲取value值，Cookie類提供了一個getValue()的方法來拿取。例如在模板中編輯代碼：

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

再次刷新頁面時，就會得到設置的test的cookie值：

Hello, Laravel

清除Cookie

清除Cookie的方法比較簡單，原理和設置Cookie一樣的，只是將過期時間設置成了過去。這里也需要將Cookie加入到HTTP的Response中，使用make()或者forget()方法均可：

//這里有點大家要注意，由於我之前使用的\Cookie::queue('test', 'i love loravel');刪除時使用\Cookie::forget一直刪除不了，這里使用方式一

方式一：

 \Cookie::queue(\Cookie::forget('test'));
或 \setcookie('test', '', -1, '/');

方式二：
$cookie = Cookie::forget('test');
//return Redirect::route('index')->withCookie($cookie);