Redis

安装

  1. composer require hyperf/redis

配置

配置项 类型 默认值 备注
host string ‘localhost’ Redis 地址
auth string 无 密码
port integer 6379 端口
db integer 0 DB
cluster.enable boolean false 是否集群模式
cluster.name string null 集群名
cluster.seeds array [] 集群连接地址数组 [‘host:port’]
pool object {} 连接池配置
options object {} Redis 配置选项 
  1. <?php
  2. return [
  3.     'default' => [
  4.         'host' => env('REDIS_HOST', 'localhost'),
  5.         'auth' => env('REDIS_AUTH', ''),
  6.         'port' => (int) env('REDIS_PORT', 6379),
  7.         'db' => (int) env('REDIS_DB', 0),
  8.         'cluster' => [
  9.             'enable' => (bool) env('REDIS_CLUSTER_ENABLE', false),
  10.             'name' => null,
  11.             'seeds' => [],
  12.         ],
  13.         'pool' => [
  14.             'min_connections' => 1,
  15.             'max_connections' => 10,
  16.             'connect_timeout' => 10.0,
  17.             'wait_timeout' => 3.0,
  18.             'heartbeat' => -1,
  19.             'max_idle_time' => (float) env('REDIS_MAX_IDLE_TIME', 60),
  20.         ],
  21.     ],
  22. ];

使用

hyperf/redis 实现了 ext-redis 代理和连接池，用户可以直接通过依赖注入容器注入 \Redis 来使用 Redis 客户端，实际获得的是 Hyperf\Redis\Redis 的一个代理对象。

  1. <?php
  2. use Hyperf\Utils\ApplicationContext;
  4. $container = ApplicationContext::getContainer();
  6. $redis = $container->get(\Redis::class);
  7. $result = $redis->keys('*');

多库配置

有时候在实际使用中，一个 Redis 库并不满足需求，一个项目往往需要配置多个库，这个时候，我们就需要修改一下配置文件 redis.php，如下：

  1. <?php
  3. return [
  4.     'default' => [
  5.         'host' => env('REDIS_HOST', 'localhost'),
  6.         'auth' => env('REDIS_AUTH', ''),
  7.         'port' => (int) env('REDIS_PORT', 6379),
  8.         'db' => (int) env('REDIS_DB', 0),
  9.         'cluster' => [
  10.             'enable' => (bool) env('REDIS_CLUSTER_ENABLE', false),
  11.             'name' => null,
  12.             'seeds' => [],
  13.         ],
  14.         'pool' => [
  15.             'min_connections' => 1,
  16.             'max_connections' => 10,
  17.             'connect_timeout' => 10.0,
  18.             'wait_timeout' => 3.0,
  19.             'heartbeat' => -1,
  20.             'max_idle_time' => (float) env('REDIS_MAX_IDLE_TIME', 60),
  21.         ],
  22.     ],
  23.     // 增加一个名为 foo 的 Redis 连接池
  24.     'foo' => [
  25.         'host' => env('REDIS_HOST', 'localhost'),
  26.         'auth' => env('REDIS_AUTH', ''),
  27.         'port' => (int) env('REDIS_PORT', 6379),
  28.         'db' => 1,
  29.         'pool' => [
  30.             'min_connections' => 1,
  31.             'max_connections' => 10,
  32.             'connect_timeout' => 10.0,
  33.             'wait_timeout' => 3.0,
  34.             'heartbeat' => -1,
  35.             'max_idle_time' => (float) env('REDIS_MAX_IDLE_TIME', 60),
  36.         ],
  37.     ],
  38. ];

通过代理类使用

我们可以重写一个 FooRedis 类并继承 Hyperf\Redis\Redis 类，修改 poolName 为上述的 foo，即可完成对连接池的切换，示例：

<?php
use Hyperf\Redis\Redis;

class FooRedis extends Redis
{
    // 对应的 Pool 的 key 值
    protected $poolName = 'foo';
}

// 通过 DI 容器获取或直接注入当前类
$redis = $this->container->get(FooRedis::class);

$result = $redis->keys('*');

使用工厂类

在每个库对应一个固定的使用场景时，通过代理类是一种很好的区分的方法，但有时候需求可能会更加的动态，这时候我们可以通过 Hyperf\Redis\RedisFactory 工厂类来动态的传递 poolName 来获得对应的连接池的客户端，而无需为每个库创建代理类，示例如下：

<?php
use Hyperf\Redis\RedisFactory;
use Hyperf\Utils\ApplicationContext;

$container = ApplicationContext::getContainer();

// 通过 DI 容器获取或直接注入 RedisFactory 类
$redis = $container->get(RedisFactory::class)->get('foo');
$result = $redis->keys('*');

集群模式

使用 name

配置 cluster，修改修改 redis.ini，也可以修改 Dockerfile 如下

    # - config PHP
    && { \
        echo "upload_max_filesize=100M"; \
        echo "post_max_size=108M"; \
        echo "memory_limit=1024M"; \
        echo "date.timezone=${TIMEZONE}"; \
        echo "redis.clusters.seeds = \"mycluster[]=localhost:7000&mycluster[]=localhost:7001\""; \
        echo "redis.clusters.timeout = \"mycluster=5\""; \
        echo "redis.clusters.read_timeout = \"mycluster=10\""; \
        echo "redis.clusters.auth = \"mycluster=password\"";
    } | tee conf.d/99-overrides.ini \

对应 PHP 配置如下

<?php
// 省略其他配置
return [
    'default' => [
        'cluster' => [
            'enable' => true,
            'name' => 'mycluster',
            'seeds' => [],
        ],
    ],
];

使用 seeds

当然不配置 name 直接使用 seeds 也是可以的。如下

<?php
// 省略其他配置
return [
    'default' => [
        'cluster' => [
            'enable' => true,
            'name' => null,
            'seeds' => [
                '192.168.1.110:6379',
                '192.168.1.111:6379',
            ],
        ],
    ],
];

Options

用户可以修改 options，来设置 Redis 配置选项。

例如修改 Redis 序列化为 PHP 序列化。

<?php

declare(strict_types=1);

return [
    'default' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'auth' => env('REDIS_AUTH', null),
        'port' => (int) env('REDIS_PORT', 6379),
        'db' => (int) env('REDIS_DB', 0),
        'pool' => [
            'min_connections' => 1,
            'max_connections' => 10,
            'connect_timeout' => 10.0,
            'wait_timeout' => 3.0,
            'heartbeat' => -1,
            'max_idle_time' => (float) env('REDIS_MAX_IDLE_TIME', 60),
        ],
        'options' => [
            Redis::OPT_SERIALIZER => Redis::SERIALIZER_PHP,
        ],
    ],
];

比如设置 Redis 永不超时

<?php

declare(strict_types=1);

return [
    'default' => [
        'host' => env('REDIS_HOST', 'localhost'),
        'auth' => env('REDIS_AUTH', null),
        'port' => (int) env('REDIS_PORT', 6379),
        'db' => (int) env('REDIS_DB', 0),
        'pool' => [
            'min_connections' => 1,
            'max_connections' => 10,
            'connect_timeout' => 10.0,
            'wait_timeout' => 3.0,
            'heartbeat' => -1,
            'max_idle_time' => (float) env('REDIS_MAX_IDLE_TIME', 60),
        ],
        'options' => [
            Redis::OPT_READ_TIMEOUT => -1,
        ],
    ],
];

有的 phpredis 扩展版本，option 的 value 必须是 string 类型。