Redis

• 簡介

• 設定

  • 叢集
  • Predis
  • PhpRedis

• 使用 Redis

  • Transaction
  • 指令管道

• Pub / Sub

簡介

Redis is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, and sorted sets.

Before using Redis with Laravel, we encourage you to install and use the PhpRedis PHP extension via PECL. The extension is more complex to install compared to "user-land" PHP packages but may yield better performance for applications that make heavy use of Redis. If you are using Laravel Sail, this extension is already installed in your application's Docker container.

If you are unable to install the PhpRedis extension, you may install the predis/predis package via Composer. Predis is a Redis client written entirely in PHP and does not require any additional extensions:

1composer require predis/predis:^2.0
1composer require predis/predis:^2.0

設定

我們可以在 config/database.php 設定檔中設定專案的 Redis 設定。在該檔案中，可以看到一個 redis 陣列，其中存放的就是專案要使用的 Redis 伺服器：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => env('REDIS_URL'),
12        'host' => env('REDIS_HOST', '127.0.0.1'),
13        'username' => env('REDIS_USERNAME'),
14        'password' => env('REDIS_PASSWORD'),
15        'port' => env('REDIS_PORT', '6379'),
16        'database' => env('REDIS_DB', '0'),
17    ],
18 
19    'cache' => [
20        'url' => env('REDIS_URL'),
21        'host' => env('REDIS_HOST', '127.0.0.1'),
22        'username' => env('REDIS_USERNAME'),
23        'password' => env('REDIS_PASSWORD'),
24        'port' => env('REDIS_PORT', '6379'),
25        'database' => env('REDIS_CACHE_DB', '1'),
26    ],
27 
28],
 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => env('REDIS_URL'),
12        'host' => env('REDIS_HOST', '127.0.0.1'),
13        'username' => env('REDIS_USERNAME'),
14        'password' => env('REDIS_PASSWORD'),
15        'port' => env('REDIS_PORT', '6379'),
16        'database' => env('REDIS_DB', '0'),
17    ],
18 
19    'cache' => [
20        'url' => env('REDIS_URL'),
21        'host' => env('REDIS_HOST', '127.0.0.1'),
22        'username' => env('REDIS_USERNAME'),
23        'password' => env('REDIS_PASSWORD'),
24        'port' => env('REDIS_PORT', '6379'),
25        'database' => env('REDIS_CACHE_DB', '1'),
26    ],
27 
28],

除非使用單一 URL 來代表 Redis 連線，否則該設定檔中所定義的每個 Redis 伺服器都必須有名稱、主機、連接埠：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => 'tcp://127.0.0.1:6379?database=0',
12    ],
13 
14    'cache' => [
15        'url' => 'tls://user:[email protected]:6380?database=1',
16    ],
17 
18],
 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => 'tcp://127.0.0.1:6379?database=0',
12    ],
13 
14    'cache' => [
15        'url' => 'tls://user:[email protected]:6380?database=1',
16    ],
17 
18],

Configuring the Connection Scheme

預設情況下，Redis 用戶端會使用 tcp Scheme(配置) 來連線到 Redis 伺服器。不過，我們也可以在 Redis 伺服器設定陣列中指定 scheme 設定選項來使用 TLS / SSL 加密：

1'default' => [
2    'scheme' => 'tls',
3    'url' => env('REDIS_URL'),
4    'host' => env('REDIS_HOST', '127.0.0.1'),
5    'username' => env('REDIS_USERNAME'),
6    'password' => env('REDIS_PASSWORD'),
7    'port' => env('REDIS_PORT', '6379'),
8    'database' => env('REDIS_DB', '0'),
9],
1'default' => [
2    'scheme' => 'tls',
3    'url' => env('REDIS_URL'),
4    'host' => env('REDIS_HOST', '127.0.0.1'),
5    'username' => env('REDIS_USERNAME'),
6    'password' => env('REDIS_PASSWORD'),
7    'port' => env('REDIS_PORT', '6379'),
8    'database' => env('REDIS_DB', '0'),
9],

叢集

若專案使用 Redis 伺服器叢集 (Cluster)，則應在 Redis 設定中的 clusters 索引鍵下定義這些叢集。預設情況下沒有該設定索引鍵，因此我們需要手動在 config/database.php 設定檔中建立該索引鍵：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'clusters' => [
11        'default' => [
12            [
13                'url' => env('REDIS_URL'),
14                'host' => env('REDIS_HOST', '127.0.0.1'),
15                'username' => env('REDIS_USERNAME'),
16                'password' => env('REDIS_PASSWORD'),
17                'port' => env('REDIS_PORT', '6379'),
18                'database' => env('REDIS_DB', '0'),
19            ],
20        ],
21    ],
22 
23    // ...
24],
 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'clusters' => [
11        'default' => [
12            [
13                'url' => env('REDIS_URL'),
14                'host' => env('REDIS_HOST', '127.0.0.1'),
15                'username' => env('REDIS_USERNAME'),
16                'password' => env('REDIS_PASSWORD'),
17                'port' => env('REDIS_PORT', '6379'),
18                'database' => env('REDIS_DB', '0'),
19            ],
20        ],
21    ],
22 
23    // ...
24],

By default, Laravel will use native Redis clustering since the options.cluster configuration value is set to redis. Redis clustering is a great default option, as it gracefully handles failover.

Laravel also supports client-side sharding. However, client-side sharding does not handle failover; therefore, it is primarily suited for transient cached data that is available from another primary data store.

If you would like to use client-side sharding instead of native Redis clustering, you may remove the options.cluster configuration value within your application's config/database.php configuration file:

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'clusters' => [
 6        // ...
 7    ],
 8 
 9    // ...
10],
 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'clusters' => [
 6        // ...
 7    ],
 8 
 9    // ...
10],

Predis

若專案通過 Predis 套件來使用 Redis，則請確定 REDIS_CLIENT 環境變數是否有設為 predis：

1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'predis'),
4 
5    // ...
6],
1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'predis'),
4 
5    // ...
6],

In addition to the default configuration options, Predis supports additional connection parameters that may be defined for each of your Redis servers. To utilize these additional configuration options, add them to your Redis server configuration in your application's config/database.php configuration file:

1'default' => [
2    'url' => env('REDIS_URL'),
3    'host' => env('REDIS_HOST', '127.0.0.1'),
4    'username' => env('REDIS_USERNAME'),
5    'password' => env('REDIS_PASSWORD'),
6    'port' => env('REDIS_PORT', '6379'),
7    'database' => env('REDIS_DB', '0'),
8    'read_write_timeout' => 60,
9],
1'default' => [
2    'url' => env('REDIS_URL'),
3    'host' => env('REDIS_HOST', '127.0.0.1'),
4    'username' => env('REDIS_USERNAME'),
5    'password' => env('REDIS_PASSWORD'),
6    'port' => env('REDIS_PORT', '6379'),
7    'database' => env('REDIS_DB', '0'),
8    'read_write_timeout' => 60,
9],

PhpRedis

By default, Laravel will use the PhpRedis extension to communicate with Redis. The client that Laravel will use to communicate with Redis is dictated by the value of the redis.client configuration option, which typically reflects the value of the REDIS_CLIENT environment variable:

1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'phpredis'),
4 
5    // ...
6],
1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'phpredis'),
4 
5    // ...
6],

In addition to the default configuration options, PhpRedis supports the following additional connection parameters: name, persistent, persistent_id, prefix, read_timeout, retry_interval, timeout, and context. You may add any of these options to your Redis server configuration in the config/database.php configuration file:

 1'default' => [
 2    'url' => env('REDIS_URL'),
 3    'host' => env('REDIS_HOST', '127.0.0.1'),
 4    'username' => env('REDIS_USERNAME'),
 5    'password' => env('REDIS_PASSWORD'),
 6    'port' => env('REDIS_PORT', '6379'),
 7    'database' => env('REDIS_DB', '0'),
 8    'read_timeout' => 60,
 9    'context' => [
10        // 'auth' => ['username', 'secret'],
11        // 'stream' => ['verify_peer' => false],
12    ],
13],
 1'default' => [
 2    'url' => env('REDIS_URL'),
 3    'host' => env('REDIS_HOST', '127.0.0.1'),
 4    'username' => env('REDIS_USERNAME'),
 5    'password' => env('REDIS_PASSWORD'),
 6    'port' => env('REDIS_PORT', '6379'),
 7    'database' => env('REDIS_DB', '0'),
 8    'read_timeout' => 60,
 9    'context' => [
10        // 'auth' => ['username', 'secret'],
11        // 'stream' => ['verify_peer' => false],
12    ],
13],

PhpRedis Serialization and Compression

The PhpRedis extension may also be configured to use a variety of serializers and compression algorithms. These algorithms can be configured via the options array of your Redis configuration:

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8        'serializer' => Redis::SERIALIZER_MSGPACK,
 9        'compression' => Redis::COMPRESSION_LZ4,
10    ],
11 
12    // ...
13],
 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8        'serializer' => Redis::SERIALIZER_MSGPACK,
 9        'compression' => Redis::COMPRESSION_LZ4,
10    ],
11 
12    // ...
13],

Currently supported serializers include: Redis::SERIALIZER_NONE (default), Redis::SERIALIZER_PHP, Redis::SERIALIZER_JSON, Redis::SERIALIZER_IGBINARY, and 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 指令：

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Support\Facades\Redis;
 7use Illuminate\View\View;
 8 
 9class UserController extends Controller
10{
11    /**
12     * Show the profile for the given user.
13     */
14    public function show(string $id): View
15    {
16        return view('user.profile', [
17            'user' => Redis::get('user:profile:'.$id)
18        ]);
19    }
20}
 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Support\Facades\Redis;
 7use Illuminate\View\View;
 8 
 9class UserController extends Controller
10{
11    /**
12     * Show the profile for the given user.
13     */
14    public function show(string $id): View
15    {
16        return view('user.profile', [
17            'user' => Redis::get('user:profile:'.$id)
18        ]);
19    }
20}

剛才也提到過，我們可以在 Redis Facade 上呼叫任何的 Redis 指令。Laravel 會使用 Magic Method 來將這些指令傳給 Redis 伺服器。若是有要求引數的 Redis 指令，則我們可以將引數傳給 Facade 上對應的方法：

1use Illuminate\Support\Facades\Redis;
2 
3Redis::set('name', 'Taylor');
4 
5$values = Redis::lrange('names', 5, 10);
1use Illuminate\Support\Facades\Redis;
2 
3Redis::set('name', 'Taylor');
4 
5$values = Redis::lrange('names', 5, 10);

或者，我們也可以使用 Redis Facade 的 command 方法來將指令傳給 Redis 伺服器。command 方法的第一個引數是指令名稱，而第二個引數則是一個陣列：

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

使用多個 Redis 連線

在專案的 config/database.php 設定檔中，我們可以定義多個 Redis 連線／伺服器。我們可以使用 Redis Facade 上的 connection 方法來取得一個特定的 Redis 連線：

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

若要取得預設的 Redis 連線，可直接呼叫 connection 方法而不帶任何引數：

1$redis = Redis::connection();
1$redis = Redis::connection();

Transaction

Redis Facade 的 transaction 方法提供了一個 Redis 原生 MULTI 與 EXEC 指令的方便包裝。transaction 方法只有一個引數，該引數為一個閉包。傳入的閉包會收到一個 Redis 連線實體，並可在該實體上下任何指令。在該閉包中所下的所有指令，都會被放在單一、不可部分完成 (Atomic) 的 Transaction 內執行：

1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::transaction(function (Redis $redis) {
5    $redis->incr('user_visits', 1);
6    $redis->incr('total_visits', 1);
7});
1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::transaction(function (Redis $redis) {
5    $redis->incr('user_visits', 1);
6    $redis->incr('total_visits', 1);
7});

Lua Script

eval 方法提供了另一種以單一、不可部分完成動作執行多個 Redis 指令的方法。不過，使用 eval 方法還有個好處，就是能在動作的期間處理與偵測 Redis 的索引鍵值。Redis Script 使用 Lua 程式語言撰寫。

雖然，一開始，eval 方法可能有點可怕。不過我們會先來看看一個簡單的例子。eval 方法接受多個引數。首先，我們需要先 (以字串形式) 傳入 Lua Script 給該方法。然後。我們需要將該 Script 要處理的索引鍵數量 (以整數形式) 傳入。再來，我們需要傳入這些索引鍵的名稱。最後，我們可以傳入在該 Script 中需要存取的其他引數。

在這個範例中，我們會遞增一個計數器，並取得該計數器的值，判斷該值是否大於 5。如果大於 5，就再遞增另一個計數器。最後，回傳第一個計數器的值：

1$value = Redis::eval(<<<'LUA'
2    local counter = redis.call("incr", KEYS[1])
3 
4    if counter > 5 then
5        redis.call("incr", KEYS[2])
6    end
7 
8    return counter
9LUA, 2, 'first-counter', 'second-counter');
1$value = Redis::eval(<<<'LUA'
2    local counter = redis.call("incr", KEYS[1])
3 
4    if counter > 5 then
5        redis.call("incr", KEYS[2])
6    end
7 
8    return counter
9LUA, 2, 'first-counter', 'second-counter');

指令管道

有時候，我們會需要執行多個 Redis 指令。除了個別以網路連線將每個指令傳給 Redis，我們還可以使用 pipeline 方法。pipeline 方法只有一個引數：一個接收 Redis 實體的閉包。我們可以使用這個 Redis 實體來下指令，下的所有指令會被一次性地傳送給 Redis 伺服器，以減少網路使用。指令會依照所下的順序執行：

1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::pipeline(function (Redis $pipe) {
5    for ($i = 0; $i < 1000; $i++) {
6        $pipe->set("key:$i", $i);
7    }
8});
1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::pipeline(function (Redis $pipe) {
5    for ($i = 0; $i < 1000; $i++) {
6        $pipe->set("key:$i", $i);
7    }
8});

Pub / Sub

Laravel 中為 Redis 的 publish 與 subscribe 指令提供了一個方便的介面。使用這兩個 Redis 指令，我們就能在給定的「頻道 (Channel)」上監聽訊息。接著，我們可以在另一個專案內、甚至使用另一個程式語言來 Publish(發佈) 訊息。這樣一來我們就能輕鬆地在不同專案或處理程序間進行溝通。

首先，我們先使用 subscribe 方法來建立一個頻道的 Listener(監聽程式)。我們將這個指令放在一個 Artisan 指令內呼叫。因為，呼叫 `subscribe`(訂閱) 方法就代表要開啟一個執行時間較長的處理程序：

 1<?php
 2 
 3namespace App\Console\Commands;
 4 
 5use Illuminate\Console\Command;
 6use Illuminate\Support\Facades\Redis;
 7 
 8class RedisSubscribe extends Command
 9{
10    /**
11     * The name and signature of the console command.
12     *
13     * @var string
14     */
15    protected $signature = 'redis:subscribe';
16 
17    /**
18     * The console command description.
19     *
20     * @var string
21     */
22    protected $description = 'Subscribe to a Redis channel';
23 
24    /**
25     * Execute the console command.
26     */
27    public function handle(): void
28    {
29        Redis::subscribe(['test-channel'], function (string $message) {
30            echo $message;
31        });
32    }
33}
 1<?php
 2 
 3namespace App\Console\Commands;
 4 
 5use Illuminate\Console\Command;
 6use Illuminate\Support\Facades\Redis;
 7 
 8class RedisSubscribe extends Command
 9{
10    /**
11     * The name and signature of the console command.
12     *
13     * @var string
14     */
15    protected $signature = 'redis:subscribe';
16 
17    /**
18     * The console command description.
19     *
20     * @var string
21     */
22    protected $description = 'Subscribe to a Redis channel';
23 
24    /**
25     * Execute the console command.
26     */
27    public function handle(): void
28    {
29        Redis::subscribe(['test-channel'], function (string $message) {
30            echo $message;
31        });
32    }
33}

接著，我們就能使用 publish 方法來將訊息發佈到頻道上：

1use Illuminate\Support\Facades\Redis;
2 
3Route::get('/publish', function () {
4    // ...
5 
6    Redis::publish('test-channel', json_encode([
7        'name' => 'Adam Wathan'
8    ]));
9});
1use Illuminate\Support\Facades\Redis;
2 
3Route::get('/publish', function () {
4    // ...
5 
6    Redis::publish('test-channel', json_encode([
7        'name' => 'Adam Wathan'
8    ]));
9});

使用萬用字元來 Subscribe

使用 psubscribe 方法，我們就能以萬用字元來 Subscribe 頻道。若要從所有頻道中取得所有的訊息，就適合使用這個方法。頻道名稱會以第二個引數傳給所提供的閉包：

1Redis::psubscribe(['*'], function (string $message, string $channel) {
2    echo $message;
3});
4 
5Redis::psubscribe(['users.*'], function (string $message, string $channel) {
6    echo $message;
7});
1Redis::psubscribe(['*'], function (string $message, string $channel) {
2    echo $message;
3});
4 
5Redis::psubscribe(['users.*'], function (string $message, string $channel) {
6    echo $message;
7});