Laradoc

Appearance

快取 ​

介紹 ​

應用程式執行的某些資料擷取或處理任務可能會佔用大量 CPU 或需要數秒才能完成。在這種情況下，通常會將擷取的資料快取一段時間，以便在後續對相同資料的請求中快速取回。快取的資料通常儲存在非常快速的資料儲存區中，例如 Memcached 或 Redis。

幸運的是，Laravel 為各種快取後端提供了一個富有表達力且統一的 API，讓你可以利用它們極快的資料擷取速度來加速你的網路應用程式。

設定 ​

應用程式的快取設定檔位於 config/cache.php。在此檔案中，你可以指定應用程式中預設要使用的快取儲存區。Laravel 支援開箱即用的熱門快取後端，例如 Memcached、Redis、DynamoDB 和關聯式資料庫。此外，還提供了基於檔案的快取驅動器，而 array 和 null 快取驅動器則為你的自動化測試提供了方便的快取後端。

快取設定檔也包含你可以審閱的各種其他選項。預設情況下，Laravel 配置為使用 database 快取驅動器，該驅動器會將序列化的快取物件儲存在應用程式的資料庫中。

驅動器前置條件 ​

資料庫 ​

當使用 database 快取驅動器時，你需要一個資料庫資料表來包含快取資料。通常，這已包含在 Laravel 預設的 0001_01_01_000001_create_cache_table.php 資料庫遷移中；但是，如果你的應用程式不包含此遷移，你可以使用 make:cache-table Artisan 命令來建立它：

shell
php artisan make:cache-table

php artisan migrate

Memcached ​

使用 Memcached 驅動器需要安裝 Memcached PECL 套件。你可以在 config/cache.php 設定檔中列出所有 Memcached 伺服器。此檔案已包含一個 memcached.servers 條目供你開始使用：

php
'memcached' => [
    // ...

    'servers' => [
        [
            'host' => env('MEMCACHED_HOST', '127.0.0.1'),
            'port' => env('MEMCACHED_PORT', 11211),
            'weight' => 100,
        ],
    ],
],

如有需要，你可以將 host 選項設定為 UNIX socket 路徑。如果你這樣做，port 選項應設定為 0：

php
'memcached' => [
    // ...

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

Redis ​

在 Laravel 中使用 Redis 快取之前，你需要透過 PECL 安裝 PhpRedis PHP 擴充功能，或透過 Composer 安裝 predis/predis 套件 (~2.0)。Laravel Sail 已包含此擴充功能。此外，官方 Laravel 應用程式平台，例如 Laravel Cloud 和 Laravel Forge，預設都安裝了 PhpRedis 擴充功能。

有關配置 Redis 的更多資訊，請查閱其 Laravel 文件頁面。

DynamoDB ​

在使用 DynamoDB 快取驅動器之前，你必須建立一個 DynamoDB 資料表來儲存所有快取資料。通常，此資料表應命名為 cache。但是，你應該根據 cache 設定檔中 stores.dynamodb.table 設定值來命名資料表。資料表名稱也可以透過 DYNAMODB_CACHE_TABLE 環境變數來設定。

此資料表也應具有一個字串分割區鍵 (partition key)，其名稱與應用程式 cache 設定檔中 stores.dynamodb.attributes.key 設定項目的值相對應。預設情況下，分割區鍵應命名為 key。

通常，DynamoDB 不會主動從資料表中移除過期的項目。因此，你應該在資料表上啟用存留時間 (TTL)。在配置資料表的 TTL 設定時，你應該將 TTL 屬性名稱設定為 expires_at。

接著，安裝 AWS SDK，以便你的 Laravel 應用程式可以與 DynamoDB 進行通訊：

shell
composer require aws/aws-sdk-php

此外，你應確保為 DynamoDB 快取儲存區的設定選項提供了值。通常，這些選項，例如 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY，應在你的應用程式 .env 設定檔中定義：

php
'dynamodb' => [
    'driver' => 'dynamodb',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
    'endpoint' => env('DYNAMODB_ENDPOINT'),
],

MongoDB ​

如果你正在使用 MongoDB，官方的 mongodb/laravel-mongodb 套件提供了 mongodb 快取驅動器，並且可以使用 mongodb 資料庫連線進行配置。MongoDB 支援 TTL 索引，可用於自動清除過期的快取項目。

有關配置 MongoDB 的更多資訊，請參閱 MongoDB 的 快取和鎖定文件。

快取使用 ​

取得快取實例 ​

要取得快取儲存實例，您可以使用 Cache Facade，這也是我們在本文件中會一直使用的。Cache Facade 提供了方便、簡潔的方式來存取 Laravel 快取契約的底層實作：

php
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * Show a list of all users of the application.
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // ...
        ];
    }
}

存取多個快取儲存 ​

使用 Cache Facade，您可以透過 store 方法存取各種快取儲存。傳遞給 store 方法的鍵應對應您 cache 設定檔中 stores 設定陣列中所列的其中一個儲存：

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

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

從快取中取回項目 ​

Cache Facade 的 get 方法用於從快取中取回項目。如果項目在快取中不存在，將會回傳 null。如果您希望，可以向 get 方法傳遞第二個引數，指定如果項目不存在時您希望回傳的預設值：

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

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

您甚至可以傳遞一個閉包作為預設值。如果指定項目在快取中不存在，則會執行閉包的結果並回傳。傳遞閉包允許您延遲從資料庫或其他外部服務中取回預設值：

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

判斷項目是否存在 ​

has 方法可以用來判斷項目是否存在於快取中。如果項目存在但其值為 null，此方法也會回傳 false：

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

遞增 / 遞減值 ​

increment 和 decrement 方法可用於調整快取中整數項目的值。這兩個方法都接受一個可選的第二個引數，指示要遞增或遞減項目值的數量：

php
// Initialize the value if it does not exist...
Cache::add('key', 0, now()->addHours(4));

// Increment or decrement the value...
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);

取回並儲存 ​

有時您可能希望從快取中取回一個項目，但如果請求的項目不存在，也儲存一個預設值。例如，您可能希望從快取中取回所有使用者，或者如果他們不存在，則從資料庫中取回並將他們新增到快取中。您可以使用 Cache::remember 方法來執行此操作：

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

如果項目不存在於快取中，則傳遞給 remember 方法的閉包將被執行，其結果將被放入快取。

您可以使用 rememberForever 方法從快取中取回項目，或者如果它不存在，則永久儲存它：

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

陳舊時重新驗證 ​

當使用 Cache::remember 方法時，如果快取值已過期，某些使用者可能會遇到緩慢的回應時間。對於某些類型的資料，在快取值於背景中重新計算時允許提供部分陳舊的資料會很有用，這可以防止某些使用者在快取值計算期間遇到緩慢的回應時間。這通常被稱為「陳舊時重新驗證 (stale-while-revalidate)」模式，而 Cache::flexible 方法提供了此模式的實作。

flexible 方法接受一個陣列，該陣列指定快取值被視為「新鮮」的時間長度以及何時變為「陳舊」。陣列中的第一個值表示快取被視為新鮮的秒數，而第二個值定義了它可以作為陳舊資料提供多長時間，然後才需要重新計算。

如果在新鮮期間內（第一個值之前）提出請求，則快取會立即回傳而無需重新計算。如果在陳舊期間內（兩個值之間）提出請求，則陳舊值會提供給使用者，並且會註冊一個 延遲函式 以在回應發送給使用者後刷新快取值。如果在第二個值之後提出請求，則快取被視為已過期，並且會立即重新計算值，這可能會導致使用者回應速度變慢：

php
$value = Cache::flexible('users', [5, 10], function () {
    return DB::table('users')->get();
});

取回並刪除 ​

如果您需要從快取中取回項目然後刪除它，您可以使用 pull 方法。與 get 方法一樣，如果項目不存在於快取中，則會回傳 null：

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

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

在快取中儲存項目 ​

您可以使用 Cache Facade 的 put 方法將項目儲存到快取中：

php
Cache::put('key', 'value', $seconds = 10);

如果未將儲存時間傳遞給 put 方法，則該項目將無限期儲存：

php
Cache::put('key', 'value');

除了將秒數作為整數傳遞之外，您還可以傳遞一個表示快取項目所需到期時間的 DateTime 實例：

php
Cache::put('key', 'value', now()->addMinutes(10));

不存在時儲存 ​

add 方法只會在快取儲存中不存在該項目時才將其新增到快取。如果該項目確實新增到快取中，該方法將回傳 true。否則，該方法將回傳 false。add 方法是一個原子操作：

php
Cache::add('key', 'value', $seconds);

永久儲存項目 ​

forever 方法可用於將項目永久儲存到快取中。由於這些項目不會過期，因此必須使用 forget 方法手動將它們從快取中移除：

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

📌 備註

如果您使用的是 Memcached 驅動器，則當快取達到其大小限制時，永久儲存的項目可能會被移除。

從快取中移除項目 ​

您可以使用 forget 方法從快取中移除項目：

php
Cache::forget('key');

您也可以透過提供零或負數的到期秒數來移除項目：

php
Cache::put('key', 'value', 0);

Cache::put('key', 'value', -5);

您可以使用 flush 方法清除整個快取：

php
Cache::flush();

⚠️ 警告

清除快取不會遵守您設定的快取「前綴 (prefix)」，並且會移除快取中的所有項目。在清除由其他應用程式共用的快取時，請仔細考慮這一點。

快取記憶化 ​

Laravel 的 memo 快取驅動器允許您在單次請求或任務執行期間，暫時將已解析的快取值儲存在記憶體中。這可以防止在相同執行中重複命中快取，從而顯著提升效能。

要使用記憶化快取，請呼叫 memo 方法：

php
use Illuminate\Support\Facades\Cache;

$value = Cache::memo()->get('key');

memo 方法可選擇地接受快取儲存區的名稱，它指定了記憶化驅動器將裝飾的底層快取儲存區：

php
// Using the default cache store...
$value = Cache::memo()->get('key');

// Using the Redis cache store...
$value = Cache::memo('redis')->get('key');

針對指定鍵的首次 get 呼叫會從您的快取儲存區中取回值，但相同請求或任務中的後續呼叫將從記憶體中取回該值：

php
// Hits the cache...
$value = Cache::memo()->get('key');

// Does not hit the cache, returns memoized value...
$value = Cache::memo()->get('key');

當呼叫修改快取值的方法（例如 put、increment、remember 等）時，記憶化快取會自動忘記記憶化的值，並將修改方法呼叫委派給底層快取儲存區：

php
Cache::memo()->put('name', 'Taylor'); // Writes to underlying cache...
Cache::memo()->get('name');           // Hits underlying cache...
Cache::memo()->get('name');           // Memoized, does not hit cache...

Cache::memo()->put('name', 'Tim');    // Forgets memoized value, writes new value...
Cache::memo()->get('name');           // Hits underlying cache again...

快取輔助函式 ​

除了使用 Cache facade 之外，您也可以使用全域 cache 函式來透過快取取回和儲存資料。當 cache 函式以單一字串參數呼叫時，它將回傳指定鍵的值：

php
$value = cache('key');

如果您提供一個鍵/值對的陣列以及一個到期時間給該函式，它將在快取中儲存值，並持續指定的期間：

php
cache(['key' => 'value'], $seconds);

cache(['key' => 'value'], now()->addMinutes(10));

當 cache 函式在沒有任何引數的情況下呼叫時，它會回傳 Illuminate\Contracts\Cache\Factory 實作的一個實例，允許您呼叫其他快取方法：

php
cache()->remember('users', $seconds, function () {
    return DB::table('users')->get();
});

📌 備註

當測試對全域 cache 函式的呼叫時，您可以像測試 facade 一樣使用 Cache::shouldReceive 方法。

快取標籤 ​

⚠️ 警告

使用 file、dynamodb 或 database 快取驅動器時，不支援快取標籤。

儲存帶有標籤的快取項目 ​

快取標籤允許您為快取中的相關項目設定標籤，然後清除所有指定了某個標籤的快取值。您可以透過傳入一個有序的標籤名稱陣列來存取帶有標籤的快取。例如，讓我們存取一個帶有標籤的快取並 put 一個值到快取中：

php
use Illuminate\Support\Facades\Cache;

Cache::tags(['people', 'artists'])->put('John', $john, $seconds);
Cache::tags(['people', 'authors'])->put('Anne', $anne, $seconds);

存取帶有標籤的快取項目 ​

透過標籤儲存的項目，若沒有提供用於儲存該值的標籤，則無法被存取。若要取回帶有標籤的快取項目，請將相同的有序標籤列表傳遞給 tags 方法，然後呼叫 get 方法並帶上您希望取回的鍵：

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

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

移除帶有標籤的快取項目 ​

您可以清除所有指定了單一標籤或標籤列表的項目。例如，以下程式碼將移除所有標記為 people、authors 或兩者皆有的快取。因此，Anne 和 John 都將從快取中移除：

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

相反地，以下程式碼只會移除標記為 authors 的快取值，因此 Anne 會被移除，但 John 不會：

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

原子鎖 ​

⚠️ 警告

要使用此功能，您的應用程式必須將 memcached、redis、dynamodb、database、file 或 array 快取驅動器作為應用程式的預設快取驅動器。此外，所有伺服器都必須與相同的中央快取伺服器進行通訊。

管理鎖 ​

原子鎖允許操作分散式鎖，而無需擔心競爭條件。例如，Laravel Cloud 使用原子鎖來確保伺服器上一次只執行一個遠端任務。您可以使用 Cache::lock 方法來建立和管理鎖：

php
use Illuminate\Support\Facades\Cache;

$lock = Cache::lock('foo', 10);

if ($lock->get()) {
    // Lock acquired for 10 seconds...

    $lock->release();
}

get 方法也接受一個閉包。閉包執行後，Laravel 將自動釋放鎖：

php
Cache::lock('foo', 10)->get(function () {
    // Lock acquired for 10 seconds and automatically released...
});

如果當您請求鎖時它不可用，您可以指示 Laravel 等待指定的秒數。如果鎖無法在指定的時間限制內取得，將拋出 Illuminate\Contracts\Cache\LockTimeoutException：

php
use Illuminate\Contracts\Cache\LockTimeoutException;

$lock = Cache::lock('foo', 10);

try {
    $lock->block(5);

    // Lock acquired after waiting a maximum of 5 seconds...
} catch (LockTimeoutException $e) {
    // Unable to acquire lock...
} finally {
    $lock->release();
}

上述範例可以透過將閉包傳遞給 block 方法來簡化。當閉包傳遞給此方法時，Laravel 將嘗試在指定的秒數內取得鎖，並在閉包執行後自動釋放鎖：

php
Cache::lock('foo', 10)->block(5, function () {
    // Lock acquired for 10 seconds after waiting a maximum of 5 seconds...
});

跨程序管理鎖 ​

有時，您可能希望在一個程序中取得鎖，並在另一個程序中釋放它。例如，您可能在網頁請求期間取得鎖，並希望在該請求觸發的排隊 Job 結束時釋放鎖。在此情況下，您應該將鎖的作用域「擁有者 Token」傳遞給排隊 Job，以便 Job 可以使用給定的 Token 重新實例化鎖。

在下面的範例中，如果成功取得鎖，我們將分派一個排隊 Job。此外，我們將透過鎖的 owner 方法將鎖的擁有者 Token 傳遞給排隊 Job：

php
$podcast = Podcast::find($id);

$lock = Cache::lock('processing', 120);

if ($lock->get()) {
    ProcessPodcast::dispatch($podcast, $lock->owner());
}

在應用程式的 ProcessPodcast Job 中，我們可以使用擁有者 Token 恢復並釋放鎖：

php
Cache::restoreLock('processing', $this->owner)->release();

如果您想在不考慮其目前擁有者的情況下釋放鎖，可以使用 forceRelease 方法：

php
Cache::lock('processing')->forceRelease();

快取容錯移轉 ​

failover 快取驅動器在與快取互動時提供自動容錯移轉功能。如果主要快取儲存因任何原因而失敗，Laravel 將自動嘗試使用列表中下一個設定的儲存。這對於確保在快取可靠性至關重要的生產環境中實現高可用性特別有用。

要設定容錯移轉快取儲存，請指定 failover 驅動器並提供一個依序嘗試的儲存名稱陣列。預設情況下，Laravel 在您的應用程式的 config/cache.php 設定檔中包含一個範例容錯移轉設定：

php
'failover' => [
    'driver' => 'failover',
    'stores' => [
        'database',
        'array',
    ],
],

一旦您設定了一個使用 failover 驅動器的儲存，您可能會想要在應用程式的 .env 檔案中將該容錯移轉儲存設定為預設快取儲存：

ini
CACHE_STORE=failover

當快取儲存操作失敗並啟動容錯移轉時，Laravel 將分派 Illuminate\Cache\Events\CacheFailedOver 事件，允許您報告或記錄快取儲存已失敗。

新增自訂快取驅動器 ​

編寫驅動器 ​

若要建立我們的自訂快取驅動器，我們首先需要實作 Illuminate\Contracts\Cache\Store 契約。因此，一個 MongoDB 快取實作可能看起來像這樣：

php
<?php

namespace App\Extensions;

use Illuminate\Contracts\Cache\Store;

class MongoStore implements Store
{
    public function get($key) {}
    public function many(array $keys) {}
    public function put($key, $value, $seconds) {}
    public function putMany(array $values, $seconds) {}
    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 連線來實作這些方法。有關如何實作這些方法的範例，請查看 Laravel 框架原始碼中的 Illuminate\Cache\MemcachedStore。一旦我們的實作完成，我們就可以透過呼叫 Cache 外觀的 extend 方法來完成自訂驅動器的註冊：

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

📌 備註

如果您想知道在哪裡放置自訂快取驅動器程式碼，您可以在 app 目錄中建立一個 Extensions 命名空間。不過，請記住 Laravel 沒有嚴格的應用程式結構，您可以根據自己的偏好自由組織應用程式。

註冊驅動器 ​

若要向 Laravel 註冊自訂快取驅動器，我們將使用 Cache 外觀上的 extend 方法。由於其他服務提供者可能會嘗試在其 boot 方法中讀取快取值，我們將在 booting 回呼中註冊我們的自訂驅動器。透過使用 booting 回呼，我們可以確保自訂驅動器在應用程式的服務提供者呼叫其 boot 方法之前，但在所有服務提供者呼叫其 register 方法之後註冊。我們將在應用程式的 App\Providers\AppServiceProvider 類別的 register 方法中註冊 booting 回呼：

php
<?php

namespace App\Providers;

use App\Extensions\MongoStore;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->booting(function () {
             Cache::extend('mongo', function (Application $app) {
                 return Cache::repository(new MongoStore);
             });
         });
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        // ...
    }
}

傳遞給 extend 方法的第一個引數是驅動器的名稱。這將對應於您在 config/cache.php 設定檔中的 driver 選項。第二個引數是一個閉包，它應該回傳一個 Illuminate\Cache\Repository 實例。該閉包將傳入一個 $app 實例，該實例是 服務容器 的一個實例。

一旦您的擴充功能註冊完成，請將您的 CACHE_STORE 環境變數或應用程式 config/cache.php 設定檔中的 default 選項更新為您擴充功能的名稱。

事件 ​

若要在每個快取操作上執行程式碼，您可以監聽快取分派的各種事件：

事件名稱
Illuminate\Cache\Events\CacheFlushed
Illuminate\Cache\Events\CacheFlushing
Illuminate\Cache\Events\CacheHit
Illuminate\Cache\Events\CacheMissed
Illuminate\Cache\Events\ForgettingKey
Illuminate\Cache\Events\KeyForgetFailed
Illuminate\Cache\Events\KeyForgotten
Illuminate\Cache\Events\KeyWriteFailed
Illuminate\Cache\Events\KeyWritten
Illuminate\Cache\Events\RetrievingKey
Illuminate\Cache\Events\RetrievingManyKeys
Illuminate\Cache\Events\WritingKey
Illuminate\Cache\Events\WritingManyKeys

為了提高效能，您可以透過在應用程式的 config/cache.php 設定檔中為給定的快取儲存將 events 設定選項設定為 false 來禁用快取事件：

php
'database' => [
    'driver' => 'database',
    // ...
    'events' => false,
],