Redis

webman/redis是在illuminate/redis的基礎(chǔ)上添加了連接池功能，支持協(xié)程和非協(xié)程環(huán)境，用法與laravel相同。

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

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

安裝

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,     // 連接池最大連接數(shù)
            'min_connections' => 1,      // 連接池最小連接數(shù)
            'wait_timeout' => 3,         // 從連接池獲取連接最大等待時(shí)間
            'idle_timeout' => 50,        // 連接池中連接空閑超時(shí)時(shí)間，超過該時(shí)間會(huì)被關(guān)閉，直到連接數(shù)為min_connections
            'heartbeat_interval' => 50,  // 心跳檢測(cè)間隔，不要大于60秒
        ],
    ]
];

關(guān)于連接池

• 每個(gè)進(jìn)程有自己的連接池，進(jìn)程間不共享連接池。
• 不開啟協(xié)程時(shí)，業(yè)務(wù)在進(jìn)程內(nèi)排隊(duì)執(zhí)行，不會(huì)產(chǎn)生并發(fā)，所以連接池最多只有1個(gè)連接。
• 開啟協(xié)程后，業(yè)務(wù)在進(jìn)程內(nèi)并發(fā)執(zhí)行，連接池會(huì)根據(jù)需要?jiǎng)討B(tài)調(diào)整連接數(shù)，最多不超過max_connections，最少不小于min_connections。
• 因?yàn)檫B接池連接數(shù)最大為max_connections，當(dāng)操作Redis的協(xié)程數(shù)大于max_connections時(shí)，會(huì)有協(xié)程排隊(duì)等待，最多等待wait_timeout秒，超過則觸發(fā)異常。
• 在空閑的情況下(包括協(xié)程和非協(xié)程環(huán)境)，連接會(huì)在idle_timeout時(shí)間后被回收，直到連接數(shù)為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)

等價(jià)于

$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是常駐內(nèi)存的框架，如果某一個(gè)請(qǐng)求使用Redis::select($db)切換數(shù)據(jù)庫后將會(huì)影響后續(xù)其他請(qǐng)求。多數(shù)據(jù)庫建議將不同的$db配置成不同的Redis連接配置。

使用多個(gè) 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,
    ],

]

默認(rèn)使用的是default下配置的連接，你可以用Redis::connection()方法選擇使用哪個(gè)redis連接。

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

集群配置

如果你的應(yīng)用使用 Redis 服務(wù)器集群，你應(yīng)該在 Redis 配置文件中使用 clusters 鍵來定義這些集群：

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

];

默認(rèn)情況下，集群可以在節(jié)點(diǎn)上實(shí)現(xiàn)客戶端分片，允許你實(shí)現(xiàn)節(jié)點(diǎn)池以及創(chuàng)建大量可用內(nèi)存。這里要注意，客戶端共享不會(huì)處理失敗的情況；因此，這個(gè)功能主要適用于從另一個(gè)主數(shù)據(jù)庫獲取的緩存數(shù)據(jù)。如果要使用 Redis 原生集群，需要在配置文件下的 options 鍵中做出如下指定：

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

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

管道命令

當(dāng)你需要在一個(gè)操作中給服務(wù)器發(fā)送很多命令時(shí)，推薦你使用管道命令。 pipeline 方法接受一個(gè) Redis 實(shí)例的 閉包 。你可以將所有的命令發(fā)送給 Redis 實(shí)例，它們都會(huì)在一個(gè)操作中執(zhí)行完成：

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