Laradoc

Appearance

Redis ​

簡介 ​

Redis 是一個開源、先進的鍵值對 (key-value) 儲存系統。它通常被稱為資料結構伺服器，因為鍵 (key) 可以包含 字串 (strings)、雜湊 (hashes)、列表 (lists)、集合 (sets) 以及 有序集合 (sorted sets)。

在將 Redis 與 Laravel 搭配使用之前，我們建議您透過 PECL 安裝並使用 PhpRedis PHP 擴充功能。與「使用者層級 (user-land)」的 PHP 套件相比，該擴充功能的安裝過程較為複雜，但對於重度使用 Redis 的應用程式來說，可以提供更好的效能。如果您使用的是 Laravel Sail，則該擴充功能已經預裝在您的應用程式 Docker 容器中。

如果您無法安裝 PhpRedis 擴充功能，您可以透過 Composer 安裝 predis/predis 套件。Predis 是一個完全由 PHP 編寫的 Redis 用戶端，不需要任何額外的擴充功能：

shell
composer require predis/predis

設定 ​

您可以透過 config/database.php 設定檔來設定應用程式的 Redis 設定。在此檔案中，您會看到一個 redis 陣列，其中包含您的應用程式所使用的 Redis 伺服器：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
    ],

    'default' => [
        'url' => env('REDIS_URL'),
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'username' => env('REDIS_USERNAME'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', '6379'),
        'database' => env('REDIS_DB', '0'),
    ],

    'cache' => [
        'url' => env('REDIS_URL'),
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'username' => env('REDIS_USERNAME'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', '6379'),
        'database' => env('REDIS_CACHE_DB', '1'),
    ],

],

除非您定義單個 URL 來代表 Redis 連線，否則設定檔中定義的每個 Redis 伺服器都必須包含名稱、主機 (host) 和通訊埠 (port)：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
    ],

    'default' => [
        'url' => 'tcp://127.0.0.1:6379?database=0',
    ],

    'cache' => [
        'url' => 'tls://user:[email protected]:6380?database=1',
    ],

],

設定連線配置 (Scheme) ​

預設情況下，Redis 客戶端在連線到您的 Redis 伺服器時會使用 tcp 配置；但是，您可以透過在 Redis 伺服器設定陣列中指定 scheme 設定選項來使用 TLS / SSL 加密：

php
'default' => [
    'scheme' => 'tls',
    'url' => env('REDIS_URL'),
    'host' => env('REDIS_HOST', '127.0.0.1'),
    'username' => env('REDIS_USERNAME'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', '6379'),
    'database' => env('REDIS_DB', '0'),
],

叢集 ​

如果您的應用程式正在使用 Redis 伺服器叢集，您應該在 Redis 設定的 clusters 鍵中定義這些叢集。此設定鍵預設並不存在，因此您需要在應用程式的 config/database.php 設定檔中建立它：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
    ],

    'clusters' => [
        'default' => [
            [
                'url' => env('REDIS_URL'),
                'host' => env('REDIS_HOST', '127.0.0.1'),
                'username' => env('REDIS_USERNAME'),
                'password' => env('REDIS_PASSWORD'),
                'port' => env('REDIS_PORT', '6379'),
                'database' => env('REDIS_DB', '0'),
            ],
        ],
    ],

    // ...
],

預設情況下，Laravel 會使用原生 Redis 叢集，因為 options.cluster 設定值設為 redis。Redis 叢集是一個很好的預設選項，因為它能優雅地處理故障轉移 (Failover)。

Laravel 在使用 Predis 時也支援客戶端分片 (Client-side sharding)。但是，客戶端分片並不處理故障轉移；因此，它主要適用於可從另一個主要資料儲存庫取得的暫時性快取資料。

如果您想使用客戶端分片而不是原生 Redis 叢集，您可以移除應用程式 config/database.php 設定檔中的 options.cluster 設定值：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'clusters' => [
        // ...
    ],

    // ...
],

Predis ​

如果您希望應用程式透過 Predis 套件與 Redis 進行互動，您應確保 REDIS_CLIENT 環境變數的值為 predis：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'predis'),

    // ...
],

除了預設的設定選項外，Predis 還支援可為每個 Redis 伺服器定義的額外 連線參數 (Connection Parameters)。要使用這些額外的設定選項，請將它們加入到應用程式 config/database.php 設定檔中的 Redis 伺服器設定中：

php
'default' => [
    'url' => env('REDIS_URL'),
    'host' => env('REDIS_HOST', '127.0.0.1'),
    'username' => env('REDIS_USERNAME'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', '6379'),
    'database' => env('REDIS_DB', '0'),
    'read_write_timeout' => 60,
],

PhpRedis ​

預設情況下，Laravel 會使用 PhpRedis 擴充功能與 Redis 進行通訊。Laravel 用於與 Redis 通訊的客戶端是由 redis.client 設定選項的值決定的，這通常反映了 REDIS_CLIENT 環境變數的值：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    // ...
],

除了預設的設定選項外，PhpRedis 還支援以下額外的連線參數：name、persistent、persistent_id、prefix、read_timeout、retry_interval、max_retries、backoff_algorithm、backoff_base、backoff_cap、timeout 以及 context。您可以將這些選項中的任何一個添加到 config/database.php 設定檔中的 Redis 伺服器設定中：

php
'default' => [
    'url' => env('REDIS_URL'),
    'host' => env('REDIS_HOST', '127.0.0.1'),
    'username' => env('REDIS_USERNAME'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', '6379'),
    'database' => env('REDIS_DB', '0'),
    'read_timeout' => 60,
    'context' => [
        // 'auth' => ['username', 'secret'],
        // 'stream' => ['verify_peer' => false],
    ],
],

重試與退避設定 ​

retry_interval、max_retries、backoff_algorithm、backoff_base 以及 backoff_cap 選項可用於設定 PhpRedis 客戶端應如何嘗試重新連線到 Redis 伺服器。支援以下退避 (Backoff) 演算法：default、decorrelated_jitter、equal_jitter、exponential、uniform 以及 constant：

php
'default' => [
    'url' => env('REDIS_URL'),
    'host' => env('REDIS_HOST', '127.0.0.1'),
    'username' => env('REDIS_USERNAME'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', '6379'),
    'database' => env('REDIS_DB', '0'),
    'max_retries' => env('REDIS_MAX_RETRIES', 3),
    'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
    'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
    'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],

Predis 3.4.0 及更高版本支援透過 Retry 類別進行內建的重試與退避設定。使用 retry 選項搭配以下策略之一進行設定：NoBackoff、EqualBackoff 或 ExponentialBackoff：

php
use Predis\Retry;
use Predis\Retry\Strategy\ExponentialBackoff;

'default' => [
    'url' => env('REDIS_URL'),
    // ...
    'retry' => new Retry(
        new ExponentialBackoff(
            env('REDIS_BACKOFF_BASE', 100),
            env('REDIS_BACKOFF_CAP', 1000),
            true, // Enables jitter
        ),
        env('REDIS_MAX_RETRIES', 3)
    )
],

Unix Socket 連線 ​

Redis 連線也可以設定為使用 Unix Socket 而非 TCP。這可以透過消除與應用程式位於同一台伺服器上的 Redis 執行個體連線的 TCP 開銷來提高效能。要將 Redis 設定為使用 Unix Socket，請將您的 REDIS_HOST 環境變數設定為 Redis Socket 的路徑，並將 REDIS_PORT 環境變數設定為 0：

env
REDIS_HOST=/run/redis/redis.sock
REDIS_PORT=0

PhpRedis 序列化與壓縮 ​

PhpRedis 擴充功能也可以設定為使用各種序列化器 (Serializer) 和壓縮演算法。這些演算法可以透過 Redis 設定中的 options 陣列進行設定：

php
'redis' => [

    'client' => env('REDIS_CLIENT', 'phpredis'),

    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
        'serializer' => Redis::SERIALIZER_MSGPACK,
        'compression' => Redis::COMPRESSION_LZ4,
    ],

    // ...
],

目前支援的序列化器包括：Redis::SERIALIZER_NONE (預設值)、Redis::SERIALIZER_PHP、Redis::SERIALIZER_JSON、Redis::SERIALIZER_IGBINARY 以及 Redis::SERIALIZER_MSGPACK。

支援的壓縮演算法包括：Redis::COMPRESSION_NONE (預設值)、Redis::COMPRESSION_LZF、Redis::COMPRESSION_ZSTD 以及 Redis::COMPRESSION_LZ4。

與 Redis 互動 ​

您可以透過呼叫 Redis facade 上的各種方法與 Redis 互動。Redis facade 支援動態方法，這代表您可以在 facade 上呼叫任何 Redis 指令，該指令將直接傳遞給 Redis。在此範例中，我們將透過呼叫 Redis facade 上的 get 方法來呼叫 Redis 的 GET 指令：

php
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Redis;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     */
    public function show(string $id): View
    {
        return view('user.profile', [
            'user' => Redis::get('user:profile:'.$id)
        ]);
    }
}

如上所述，您可以在 Redis facade 上呼叫任何 Redis 指令。Laravel 使用魔術方法將指令傳遞給 Redis 伺服器。如果 Redis 指令需要參數，您應該將其傳遞給 facade 對應的方法：

php
use Illuminate\Support\Facades\Redis;

Redis::set('name', 'Taylor');

$values = Redis::lrange('names', 5, 10);

或者，您也可以使用 Redis facade 的 command 方法將指令傳遞給伺服器，該方法接受指令名稱作為其第一個參數，並接受一個值陣列作為其第二個參數：

php
$values = Redis::command('lrange', ['name', 5, 10]);

使用多個 Redis 連線 ​

您應用程式的 config/database.php 設定檔允許您定義多個 Redis 連線 / 伺服器。您可以使用 Redis facade 的 connection 方法取得特定的 Redis 連線：

php
$redis = Redis::connection('connection-name');

若要取得預設的 Redis 連線執行個體，您可以呼叫 connection 方法而不帶任何參數：

php
$redis = Redis::connection();

交易 ​

Redis facade 的 transaction 方法為 Redis 原生的 MULTI 與 EXEC 指令提供了一個便利的封裝。transaction 方法接受一個閉包作為其唯一參數。此閉包將接收一個 Redis 連線執行個體，並可以向此執行個體發出任何想要的指令。閉包內發出的所有 Redis 指令都將在單個原子性交易中執行：

php
use Redis;
use Illuminate\Support\Facades;

Facades\Redis::transaction(function (Redis $redis) {
    $redis->incr('user_visits', 1);
    $redis->incr('total_visits', 1);
});

⚠️ 警告

在定義 Redis 交易時，您不能從 Redis 連線中取得任何值。請記住，您的交易是作為單個原子性操作執行的，並且在您的整個閉包完成執行其指令之前，該操作不會被執行。

Lua 指令碼 ​

eval 方法提供了另一種在單個原子性操作中執行多個 Redis 指令的方法。然而，eval 方法的優點是在該操作期間能夠與 Redis 鍵值進行互動並檢查其內容。Redis 指令碼是用 Lua 程式語言 編寫的。

eval 方法起初可能有點令人畏懼，但我們將探索一個基礎範例來打破僵局。eval 方法需要幾個參數。首先，您應該將 Lua 指令碼（作為字串）傳遞給該方法。其次，您應該傳遞該指令碼互動的鍵數量（作為整數）。第三，您應該傳遞這些鍵的名稱。最後，您可以傳遞在指令碼中需要存取的任何其他額外參數。

在此範例中，我們將遞增一個計數器，檢查其新值，如果第一個計數器的值大於 5，則遞增第二個計數器。最後，我們將回傳第一個計數器的值：

php
$value = Redis::eval(<<<'LUA'
    local counter = redis.call("incr", KEYS[1])

    if counter > 5 then
        redis.call("incr", KEYS[2])
    end

    return counter
LUA, 2, 'first-counter', 'second-counter');

⚠️ 警告

請參閱 Redis 官方文件 以瞭解更多關於 Redis 指令碼的資訊。

管線指令 ​

有時您可能需要執行數十個 Redis 指令。與其為每個指令都與 Redis 伺服器進行一次網路往返，不如使用 pipeline 方法。pipeline 方法接受一個參數：一個接收 Redis 執行個體的閉包。您可以向此 Redis 執行個體發出所有指令，它們將同時被發送到 Redis 伺服器，以減少往返伺服器的網路次數。指令仍將按照發出的順序執行：

php
use Redis;
use Illuminate\Support\Facades;

Facades\Redis::pipeline(function (Redis $pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});

發佈 / 訂閱 ​

Laravel 為 Redis 的 publish 與 subscribe 指令提供了一個便利的介面。這些 Redis 指令允許您監聽特定「頻道」上的訊息。您可以從另一個應用程式，甚至使用另一種程式語言向該頻道發佈訊息，從而實現應用程式與程序之間的輕鬆通訊。

首先，讓我們使用 subscribe 方法設定一個頻道監聽器。我們將此方法呼叫放置在 Artisan 指令 中，因為呼叫 subscribe 方法會開始一個長期執行的程序：

php
<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;

class RedisSubscribe extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'redis:subscribe';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Subscribe to a Redis channel';

    /**
     * Execute the console command.
     */
    public function handle(): void
    {
        Redis::subscribe(['test-channel'], function (string $message) {
            echo $message;
        });
    }
}

現在，我們可以使用 publish 方法向頻道發佈訊息：

php
use Illuminate\Support\Facades\Redis;

Route::get('/publish', function () {
    // ...

    Redis::publish('test-channel', json_encode([
        'name' => 'Adam Wathan'
    ]));
});

萬用字元訂閱 ​

使用 psubscribe 方法，您可以訂閱萬用字元頻道，這對於擷取所有頻道上的所有訊息非常有用。頻道名稱將作為第二個參數傳遞給提供的閉包：

php
Redis::psubscribe(['*'], function (string $message, string $channel) {
    echo $message;
});

Redis::psubscribe(['users.*'], function (string $message, string $channel) {
    echo $message;
});