Redis

webmanのRedisコンポーネントはデフォルトでilluminate/redisを使用しており、つまりlaravelのRedisライブラリを使用しています。使用法はlaravelと同じです。

illuminate/redisを使用する前に、php-cliにRedis拡張機能をインストールする必要があります。

注意
コマンドphp -m | grep redisを使用してphp-cliにRedis拡張機能がインストールされているかどうかを確認します。注意：php-fpmにRedis拡張機能をインストールしていても、php-cliで使用できるとは限りません。なぜならphp-cliとphp-fpmは異なるアプリケーションであり、異なるphp.iniの設定を使用する可能性があるからです。使用中のphp-cliがどのphp.ini設定ファイルを使用しているかを確認するには、php --iniコマンドを使用します。

インストール

composer require -W illuminate/redis illuminate/events

インストール後にrestartを行う必要があります（reloadでは適用されません）。

設定

Redisの設定ファイルはconfig/redis.phpにあります。

return [
    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
    ]
];

サンプル

<?php
namespace app\controller;

use support\Request;
use support\Redis;

class UserController
{
    public function db(Request $request)
    {
        $key = 'test_key';
        Redis::set($key, rand());
        return response(Redis::get($key));
    }
}

Redisインターフェース

Redis::append($key, $value)
Redis::bitCount($key)
Redis::decr($key, $value)
Redis::decrBy($key, $value)
Redis::get($key)
Redis::getBit($key, $offset)
Redis::getRange($key, $start, $end)
Redis::getSet($key, $value)
Redis::incr($key, $value)
Redis::incrBy($key, $value)
Redis::incrByFloat($key, $value)
Redis::mGet(array $keys)
Redis::getMultiple(array $keys)
Redis::mSet($pairs)
Redis::mSetNx($pairs)
Redis::set($key, $value, $expireResolution = null, $expireTTL = null, $flag = null)
Redis::setBit($key, $offset, $value)
Redis::setEx($key, $ttl, $value)
Redis::pSetEx($key, $ttl, $value)
Redis::setNx($key, $value)
Redis::setRange($key, $offset, $value)
Redis::strLen($key)
Redis::del(...$keys)
Redis::exists(...$keys)
Redis::expire($key, $ttl)
Redis::expireAt($key, $timestamp)
Redis::select($dbIndex)

これは以下と同等です。

$redis = Redis::connection('default');
$redis->append($key, $value)
$redis->bitCount($key)
$redis->decr($key, $value)
$redis->decrBy($key, $value)
$redis->get($key)
$redis->getBit($key, $offset)
...

注意
Redis::select($db)インターフェースを慎重に使用してください。webmanは常駐メモリのフレームワークのため、あるリクエストがRedis::select($db)を使用してデータベースを切り替えると、後続のリクエストに影響を与える可能性があります。複数のデータベースを使用する場合は、異なる$dbを異なるRedis接続設定に設定することをお勧めします。

複数のRedis接続の使用

たとえば、設定ファイルconfig/redis.phpには次のように記述されています。

return [
    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
    ],

    'cache' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 1,
    ],

]

デフォルトではdefaultの接続が使用されますが、Redis::connection()メソッドを使用してどのRedis接続を使用するかを選択することができます。

$redis = Redis::connection('cache');
$redis->get('test_key');

クラスタ構成

アプリケーションでRedisサーバークラスタを使用する場合は、クラスタを定義するにはRedis設定ファイルでclustersキーを使用する必要があります。

return [
    'clusters' => [
        'default' => [
            [
                'host'     => 'localhost',
                'password' => null,
                'port'     => 6379,
                'database' => 0,
            ],
        ],
    ],

];

デフォルトでは、クラスタはノード上でクライアントシャーディングを実装することができ、ノードプールの作成や大量の利用可能なメモリを実現することができます。ただし、クライアント側の共有は障害を処理しません。そのため、この機能は主に別のメインデータベースからキャッシュデータを取得する場合に適しています。Redisのネイティブクラスタを使用する場合は、設定ファイルのoptionsキーで次のように指定する必要があります。

return[
    'options' => [
        'cluster' => 'redis',
    ],

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

パイプラインコマンド

1つの操作でサーバに多くのコマンドを送信する必要がある場合は、パイプラインコマンドを使用することをお勧めします。pipelineメソッドはRedisインスタンスのクロージャを受け入れます。すべてのコマンドをRedisインスタンスに送信することができますが、それらは1つの操作で実行されます。

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