Redis

webman/redis是在illuminate/redis的基础上添加了连接池功能,支持协程和非协程环境,用法与laravel相同。

使用illuminate/redis之前必须先给php-cli安装redis扩展。

注意
此组件需要安装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);
    }
});
编辑于2025-02-20 13:20:05 完善本页 +发起讨论
赞助商
×