https://github.com/mix-php/redis-subscriber

Redis native protocol Subscriber based on Swoole coroutine / 基于 Swoole 协程的 Redis 原生协议订阅库
https://github.com/mix-php/redis-subscriber

coroutine redis subscribe subscriber swoole

Last synced: 3 months ago
JSON representation

Redis native protocol Subscriber based on Swoole coroutine / 基于 Swoole 协程的 Redis 原生协议订阅库

• Host: GitHub
• URL: https://github.com/mix-php/redis-subscriber
• Owner: mix-php
• Created: 2019-10-19T07:49:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-07T02:32:25.000Z (7 months ago)
• Last Synced: 2024-05-22T08:33:33.893Z (6 months ago)
• Topics: coroutine, redis, subscribe, subscriber, swoole
• Language: PHP
• Homepage: https://openmix.org/mix-php
• Size: 33.2 KB
• Stars: 15
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-swoole - mix/redis-subscriber

README

        
## Mix Redis Subscriber

Redis native protocol Subscriber based on Swoole coroutine

基于 Swoole 协程的 Redis 原生协议订阅库

使用 Socket 直接连接 Redis 服务器，不依赖 phpredis 扩展，该订阅器有如下优点：

- 平滑修改：可随时增加、取消订阅通道，实现无缝切换通道的需求。

- 跨协程安全关闭：可在任意时刻关闭订阅。

- 通道获取消息：该库封装风格参考 golang 语言 [go-redis](https://github.com/go-redis/redis) 库封装，通过 channel 获取订阅的消息。

## Installation

- Swoole >= 4.4

```

composer require mix/redis-subscriber

```

## 订阅频道

- 连接、订阅失败会抛出异常

```php

$sub = new \Mix\Redis\Subscriber\Subscriber('127.0.0.1', 6379, '', 5); // 连接失败将抛出异常

$sub->subscribe('foo', 'bar'); // 订阅失败将抛出异常

$chan = $sub->channel();

while (true) {

    $data = $chan->pop();

    if (empty($data)) { // 手动close与redis异常断开都会导致返回false

        if (!$sub->closed) {

            // redis异常断开处理

            var_dump('Redis connection is disconnected abnormally');

        }

        break;

    }

    var_dump($data);

}

```

接收到订阅消息：

```

object(Mix\Redis\Subscriber\Message)#8 (2) {

  ["channel"]=>

  string(2) "foo"

  ["payload"]=>

  string(4) "test"

}

```

## 全部方法

|  方法  |  描述  |

| --- | --- |

|  subscribe(string ...$channels) : void  |  增加订阅  |

|  unsubscribe(string ...$channels) : void  |  取消订阅  |

|  channel() : Swoole\Coroutine\Channel  |  获取消息通道  |

|  close() : void  |  关闭订阅  |

## License

Apache License Version 2.0, http://www.apache.org/licenses/