Redis\Server

一个兼容Redis服务器端协议的Server类，可基于此类实现Redis协议的服务器程序。

?> Swoole\Redis\Server继承自Server，所以Server提供的所有API和配置项都可以使用，进程模型也是一致的。请参考Server章节。

• 可用的客户端

  • 任意编程语言的redis客户端，包括PHP的redis扩展和phpredis库
  • Swoole\Coroutine\Redis 协程客户端
  • Redis提供的命令行工具，包括redis-cli、redis-benchmark

方法

Swoole\Redis\Server继承自Swoole\Server，可以使用父类提供的所有方法。

setHandler

?> 设置Redis命令字的处理器。

!> Redis\Server不需要设置onReceive回调。只需使用setHandler方法设置对应命令的处理函数，收到未支持的命令后会自动向客户端发送ERROR响应，消息为ERR unknown command '$command'。

Swoole\Redis\Server->setHandler(string $command, callable $callback);

• 参数

  • string $command

    • 功能：命令的名称
    • 默认值：无
    • 其它值：无

  • callable $callback

    • 功能：命令的处理函数【回调函数返回字符串类型时会自动发送给客户端】
    • 默认值：无
    • 其它值：无

    !> 返回的数据必须为Redis格式，可使用format静态方法进行打包

format

?> 格式化命令响应数据。

Swoole\Redis\Server::format(int $type, mixed $value = null);

• 参数

  • int $type

    • 功能：数据类型，对应常量参考下文 格式参数常量。
    • 默认值：无
    • 其它值：无

    !> 当$type为NIL类型时，不需要传入$value；ERROR和STATUS类型$value可选；INT、STRING、SET、MAP必填。

  • mixed $value

    • 功能：值
    • 默认值：无
    • 其它值：无

send

?> 使用Swoole\Server中的send()方法将数据发送给客户端。

Swoole\Server->send(int $fd, string $data): bool

常量

格式参数常量

主要用于format函数打包Redis响应数据

使用示例

服务端

use Swoole\Redis\Server;

define('DB_FILE', __DIR__ . '/db');

$server = new Server("127.0.0.1", 9501, SWOOLE_BASE);

if (is_file(DB_FILE)) {
    $server->data = unserialize(file_get_contents(DB_FILE));
} else {
    $server->data = array();
}

$server->setHandler('GET', function ($fd, $data) use ($server) {
    if (count($data) == 0) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'GET' command"));
    }

    $key = $data[0];
    if (empty($server->data[$key])) {
        return $server->send($fd, Server::format(Server::NIL));
    } else {
        return $server->send($fd, Server::format(Server::STRING, $server->data[$key]));
    }
});

$server->setHandler('SET', function ($fd, $data) use ($server) {
    if (count($data) < 2) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'SET' command"));
    }

    $key = $data[0];
    $server->data[$key] = $data[1];
    return $server->send($fd, Server::format(Server::STATUS, "OK"));
});

$server->setHandler('sAdd', function ($fd, $data) use ($server) {
    if (count($data) < 2) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'sAdd' command"));
    }

    $key = $data[0];
    if (!isset($server->data[$key])) {
        $array[$key] = array();
    }

    $count = 0;
    for ($i = 1; $i < count($data); $i++) {
        $value = $data[$i];
        if (!isset($server->data[$key][$value])) {
            $server->data[$key][$value] = 1;
            $count++;
        }
    }

    return $server->send($fd, Server::format(Server::INT, $count));
});

$server->setHandler('sMembers', function ($fd, $data) use ($server) {
    if (count($data) < 1) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'sMembers' command"));
    }
    $key = $data[0];
    if (!isset($server->data[$key])) {
        return $server->send($fd, Server::format(Server::NIL));
    }
    return $server->send($fd, Server::format(Server::SET, array_keys($server->data[$key])));
});

$server->setHandler('hSet', function ($fd, $data) use ($server) {
    if (count($data) < 3) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'hSet' command"));
    }

    $key = $data[0];
    if (!isset($server->data[$key])) {
        $array[$key] = array();
    }
    $field = $data[1];
    $value = $data[2];
    $count = !isset($server->data[$key][$field]) ? 1 : 0;
    $server->data[$key][$field] = $value;
    return $server->send($fd, Server::format(Server::INT, $count));
});

$server->setHandler('hGetAll', function ($fd, $data) use ($server) {
    if (count($data) < 1) {
        return $server->send($fd, Server::format(Server::ERROR, "ERR wrong number of arguments for 'hGetAll' command"));
    }
    $key = $data[0];
    if (!isset($server->data[$key])) {
        return $server->send($fd, Server::format(Server::NIL));
    }
    return $server->send($fd, Server::format(Server::MAP, $server->data[$key]));
});

$server->on('WorkerStart', function ($server) {
    $server->tick(10000, function () use ($server) {
        file_put_contents(DB_FILE, serialize($server->data));
    });
});

$server->start();

客户端

$ redis-cli -h 127.0.0.1 -p 9501
127.0.0.1:9501> set name swoole
OK
127.0.0.1:9501> get name
"swoole"
127.0.0.1:9501> sadd swooler rango
(integer) 1
127.0.0.1:9501> sadd swooler twosee guoxinhua
(integer) 2
127.0.0.1:9501> smembers swooler
1) "rango"
2) "twosee"
3) "guoxinhua"
127.0.0.1:9501> hset website swoole "www.swoole.com"
(integer) 1
127.0.0.1:9501> hset website swoole "swoole.com"
(integer) 0
127.0.0.1:9501> hgetall website
1) "swoole"
2) "swoole.com"
127.0.0.1:9501> test
(error) ERR unknown command 'test'
127.0.0.1:9501>