Redis

webman/redis是在illuminate/redis的基礎上添加了連接池功能，支持協程和非協程環境，用法與laravel相同。

使用illuminate/redis之前必須先給php-cli安裝redis擴展。

注意
當前手冊為 webman v2 版本，如果您使用的是webman v1版本，請查看 v1版本手冊
此組件需要安裝redis擴展，使用命令php -m | grep redis查看php-cli是否裝了redis擴展。

安裝

composer require -W webman/redis illuminate/events

安裝後需要restart重啟(reload無效)

配置

redis配置檔案在config/redis.php

return [
    'default' => [
        'host'     => '127.0.0.1',
        'password' => null,
        'port'     => 6379,
        'database' => 0,
        'pool' => [ // 連接池配置
            'max_connections' => 10,     // 連接池最大連接數
            'min_connections' => 1,      // 連接池最小連接數
            'wait_timeout' => 3,         // 從連接池獲取連接最大等待時間
            'idle_timeout' => 50,        // 連接池中連接空閒超時時間，超過該時間會被關閉，直到連接數為min_connections
            'heartbeat_interval' => 50,  // 心跳檢測間隔，不要大於60秒
        ],
    ]
];

關於連接池

每個進程有自己的連接池，進程間不共享連接池。
不開啟協程時，業務在進程內排隊執行，不會產生並發，所以連接池最多只有1個連接。
開啟協程後，業務在進程內並發執行，連接池會根據需要動態調整連接數，最多不超過max_connections，最少不小於min_connections。
因為連接池連接數最大為max_connections，當操作Redis的協程數大於max_connections時，會有協程排隊等待，最多等待wait_timeout秒，超過則觸發異常。
在空閒的情況下(包括協程和非協程環境)，連接會在idle_timeout時間後被回收，直到連接數為min_connections(min_connections可為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' => [
        // ...
    ],
];

管道命令

當你需要在一個操作中給伺服器發送很多命令時，推薦你使用管道命令。 pipeline 方法接受一個 Redis 實例的闭包。你可以將所有的命令發送給 Redis 實例，它們都會在一個操作中執行完成：

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