Cache

• 設定
• 快取的使用
  • 取得一個快取的實例
  • 從快取中擷取項目
  • 存放項目到快取中
  • 刪除快取中的項目
• 快取標籤
  • 寫入被標記的快取項目
  • 取得被標記的快取項目
• 加入客製化的快取驅動
• 快取事件

設定

Laravel 提供了一套統一的 API 給各種不同的快取系統，快取的設定檔都放在 config/cache.php 中，在這個檔案中，你可以指定在你的應用程式中，你預設想用哪個快取驅動，Laravel 支援流行的快取後端，如 Memcached 和 Redis。

快取設定檔還包含了其他的選項，你可以在檔案中找到這些選項，請確保你都有讀過這些選項上方的說明。Laravel 預設採用的快取驅動是 file ，這個驅動儲存了序列化的快取物件在檔案系統中，對於大型應用程式而言，Laravel 比較建議你使用一個在記憶體內的快取，例如 Memcached 或 APC， 你可能也會想為同一個驅動設定多個快取設定檔。

快取預先需求

資料庫

當使用 database 這個快取驅動，你需要設置一個表格來放置快取項目，你可以看一下範例 Schema 如何宣告這樣的表格：

Schema::create('cache', function($table) {
    $table->string('key')->unique();
    $table->text('value');
    $table->integer('expiration');
});

Memcached

使用 Memcached 做快取需要先安裝 Memcached PECL 套件。

預設的設定檔採用以 Memcached::addServer 為基礎的 TCP/IP：

'memcached' => [
    [
        'host' => '127.0.0.1',
        'port' => 11211,
        'weight' => 100
    ],
],

你可能也會設置 host 選項到 UNIX 的 socket 路徑中，如果你有這麼做，記得 port 選項要設為 0：

'memcached' => [
    [
        'host' => '/var/run/memcached/memcached.sock',
        'port' => 0,
        'weight' => 100
    ],
],

Redis

在你選擇使用 Redis 作為 Laravel 的快取前，你需要透過 Composer 預先安裝 predis/predis 套件 (~1.0)。

更多有關設定 Redis 的資訊，請參考 Laravel 的文件頁面。

快取的使用

取得一個快取的實例

Illuminate\Contracts\Cache\Factory 和 Illuminate\Contracts\Cache\Repository contracts 提供了存取 Laravel 快取服務的機制， 而Factory contract 則為你的應用程式提供了存取所有快取驅動的機制，Repository contract 是典型的快取驅動實作，它會依照你的快取設定檔變化。

然而，你可能也需要使用 Cache facade，我們會在整份文件中使用它，Cache facade 提供了方便又簡潔的方法存取現行實作的 Laravel 快取 contracts。

例如，我們試著在一個控制器中引用 Cache facade：

<?php

namespace App\Http\Controllers;

use Cache;
use Illuminate\Routing\Controller;

class UserController extends Controller
{
    /**
     * 顯示應用程式中所有使用者的列表。
     *
     * @return Response
     */
    public function index()
    {
        $value = Cache::get('key');

        //
    }
}

存取多個快取儲存

使用 Cache facade，你可能會透過 store 方法來存取多個快取儲存。被傳送到 store 的鍵，應該會對應到你的 cache 設定檔中的 stores 設定陣列的其中一項：

$value = Cache::store('file')->get('foo');

Cache::store('redis')->put('bar', 'baz', 10);

從快取中擷取項目

在 Cache facade 中，get 方法可以用來取出快取中的項目，如果要取出的項目不在快取中，get 方法會回傳 null。如果你希望的話，你也可以傳入第二個參數給 get 方法來客製化找不到項目時的預回傳值設值：

$value = Cache::get('key');

$value = Cache::get('key', 'default');

你甚至可能傳入一個閉包作為預設值，當指定的項目不存在快取中時，閉包將會被回傳，傳入一個閉包讓你可以延後存資料庫或外部服務中取出預設值：

$value = Cache::get('key', function() {
    return DB::table(...)->get();
});

確認項目存在

has 方法可以用來檢查一個項目是否存在於快取中：

if (Cache::has('key')) {
    //
}

遞增與遞減值

increment 和 decrement 方法可以用來調整快取中的整數項目值，這兩個方法都可以選擇性的傳入第二個參數，用來指示要遞增或遞減多少：

Cache::increment('key');

Cache::increment('key', $amount);

Cache::decrement('key');

Cache::decrement('key', $amount);

取出或更新

有時候，你可能會想從快取中取出一個項目，但也想在取出的項目不存在時存入一個預設值。例如，你可能會想從快取中取出所有使用者，或者當找不到使用者時，從資料庫中將這些使用者取出並放入快取中。你可以透過使用 Cache::remember 方法：

$value = Cache::remember('users', $minutes, function() {
    return DB::table('users')->get();
});

如果那個項目不存在快取中，則回傳給 remember 方法的閉包將會被執行，而且閉包的執行結果將會被存放在快取中。

你可能也會結合 remember 和 forever 這兩個方法：

$value = Cache::rememberForever('users', function() {
    return DB::table('users')->get();
});

取出與刪除

如果你需要從快取中取出一個項目並刪除它，你可能會使用 pull 方法。與 get 相似，如果物件不存在快取中，pull 方法將會回傳 null：

$value = Cache::pull('key');

存放項目到快取中

你可能會在 Cache facade 中使用 put 方法來存放項目到快取中。當你將一個項目放進快取時，你需要指定「幾分鐘」給將要存放的值：

Cache::put('key', 'value', $minutes);

如果不指定分鐘數直到存放的項目過期，你也可能傳遞一個 PHP 的 DateTime 實例來表示該快取項目過期的時間點：

$expiresAt = Carbon::now()->addMinutes(10);

Cache::put('key', 'value', $expiresAt);

add 方法只會把還不存在快取中的項目放入快取。如果成功存放，會回傳 true，否回傳 false：

Cache::add('key', 'value', $minutes);

forever 方法可以用來存放永久的項目到快取中。這些值必須被手動的刪除，這可以透過 forget 方法達成：

Cache::forever('key', 'value');

刪除快取中的項目

你可能會使用 forget 方法在 Cache facade 下從快取中移除一個項目：

Cache::forget('key');

你可以使用 flush 方法清除所有快取：

Cache::flush();

清空快取並不會遵從快取的前綴，並會將快取中所有的項目刪除。在清除與其他應用程式共用的快取時應謹慎考慮這一點。

快取標籤

注意： 當你使用 file 或 database 快取驅動時，快取標籤不支援他們。此外，當使用多個標籤以及將快取儲存到「forever」， 像是性能較好的驅動：memached，可以自動的清除舊的歷史記錄。

寫入被標記的快取項目

快取標籤允許你在快取中標記關聯的項目，並清空所有已分配指定標籤的快取值。你可以透過傳遞一組標籤名稱的有序陣列，以存取被標記的快取。舉例來說，讓我們存取一個被標記的快取並 put 值給它：

Cache::tags(['people', 'artists'])->put('John', $john, $minutes);

Cache::tags(['people', 'authors'])->put('Anne', $anne, $minutes);

當然，你不必限制於 put 方法。你可以在利用標籤時使用任何快取儲存系統的方法。

取得被標記的快取項目

若要取得一個被標記的快取項目，只要傳遞一樣的標籤有序列表至 tags 方法：

$john = Cache::tags(['people', 'artists'])->get('John');

$anne = Cache::tags(['people', 'authors'])->get('Anne');

你可以清空已分配單一標籤或是一組標籤列表中的所有項目。例如，下方的語法會將被標記 people、authors，或兩者的快取給移除。所以，Anne 與 John 都從快取中被移除：

Cache::tags(['people', 'authors'])->flush();

相反的，下方的語法只會刪除被標記為 authors 的快取，所以 Anne 會被移除，但 John 不會。

Cache::tags('authors')->flush();

加入客製化的快取驅動

為了要透過客製化的驅動來擴充 Laravel 快取，我們將會在 Cache facade 中使用 extend 方法，它被用來綁定一個客製化驅動的解析器到管理者上，通常這可以透過服務容器來完成。

例如，要註冊一個名為「mongo」的快取驅動：

<?php

namespace App\Providers;

use Cache;
use App\Extensions\MongoStore;
use Illuminate\Support\ServiceProvider;

class CacheServiceProvider extends ServiceProvider
{
    /**
     * 執行註冊後的啟動服務。
     *
     * @return void
     */
    public function boot()
    {
        Cache::extend('mongo', function($app) {
            return Cache::repository(new MongoStore);
        });
    }

    /**
     * 在容器中註冊綁定。
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

第一個傳給 extend 方法的參數是驅動的名稱，這個名稱要與你在 config/cache.php 設定檔中，driver 選項指定的名稱相同，第二個參數是一個應回傳一個 Illuminate\Cache\Repository 實例的閉包，這個閉包會被傳入一個 $app 實例，這個實例是屬於類別服務容器。

呼叫 Cache::extend 的工作可以在新加入的 Laravel 應用程式中預設的 App\Providers\AppServiceProvider 的 boot 方法中完成，或者你可以建立你自己的服務提供者來管理擴充功能（只是請別忘了在 config/app.php 中的服務提供者陣列註冊這個提供者）。

為了建立我們的客製化快取驅動，首先需要實作 Illuminate\Contracts\Cache\Store contract。因此我們的 MongoDB 快取實作大概會長這樣子：

<?php

namespace App\Extensions;

class MongoStore implements \Illuminate\Contracts\Cache\Store
{
    public function get($key) {}
    public function put($key, $value, $minutes) {}
    public function increment($key, $value = 1) {}
    public function decrement($key, $value = 1) {}
    public function forever($key, $value) {}
    public function forget($key) {}
    public function flush() {}
    public function getPrefix() {}
}

我們只需要透過一個 MongoDB 的連線來實作這些方法，一旦我們完成實作，我們就可以接著完成註冊我們的客製化驅動：

Cache::extend('mongo', function($app) {
    return Cache::repository(new MongoStore);
});

一旦你的擴充功能完成，你只需要簡單的更新 config/cache.php 設定檔中的 driver 選項為你的擴充功能名稱即可。

如果你不知道要將你的客製化快取驅動程式碼放置在何處，可以考慮將它放在 Packagist 上！或者你可以在你的 app 目錄下建立一個 Extension 的命名空間。但是請記住，Laravel 沒有硬性規定的應用程式結構，你可以依照你的喜好任意組織你的應用程式。

快取事件

如果要在每次操作快取時執行程式，你可以為快取觸發事件進行監聽。一般來說，你必須將事件監聽器放置在 EventServiceProvider 的 boot 方法中：

/**
 * 為你的應用程式註冊任何其它事件。
 *
 * @var array
 */
protected $listen = [
    'Illuminate\Cache\Events\CacheHit' => [
        'App\Listeners\LogCacheHit',
    ],

    'Illuminate\Cache\Events\CacheMissed' => [
        'App\Listeners\LogCacheMissed',
    ],

    'Illuminate\Cache\Events\KeyForgotten' => [
        'App\Listeners\LogKeyForgotten',
    ],

    'Illuminate\Cache\Events\KeyWritten' => [
        'App\Listeners\LogKeyWritten',
    ],
];