5monkeys/socker

socker - 基于asyncio的Redis发布/订阅WebSocket代理服务器

概述

socker是一个基于asyncio的单进程服务，采用非阻塞I/O模型，作为Redis发布/订阅（pub/sub）与WebSocket之间的代理服务器。它通过WebSocket服务器端口接收客户端连接，同时与Redis建立连接并订阅指定通道，实现Redis消息与WebSocket客户端之间的实时转发。socker使用独立的Redis发布/订阅通道，支持与其他应用共享Redis数据库。

核心功能与特性

• 非阻塞I/O：基于asyncio实现高效的非阻塞I/O操作，支持高并发连接
• 单进程服务：轻量级部署，运行简单，资源占用低
• Redis兼容：使用独立的Redis发布/订阅通道，可与其他应用共享Redis数据库
• 灵活订阅：支持WebSocket客户端通过通配符（如foo.*、foo.bar.*）订阅消息
• 可配置性：支持自定义监听接口、端口及Redis连接参数（主机、端口、数据库、密码等）

使用场景与适用范围

适用于需要通过WebSocket实现实时消息推送的场景，如：

• 实时通知系统（如即时消息、状态更新）
• 实时数据监控（如仪表盘、日志流）
• 多客户端实时通信场景
• 需要连接Redis消息系统与WebSocket客户端的中间件需求

安装

通过pip安装socker：

bash
pip install socker

使用方法

命令行选项

启动socker服务器的基本命令格式：

bash
$ socker [选项]

主要选项说明

查看帮助

bash
$ socker --help

启动服务器示例

启动默认配置的socker服务器：

bash
socker

自定义监听端口和Redis连接参数：

bash
socker -i 0.0.0.0 -p 9000 --redis-host=redis.example.com --redis-port=6380 --redis-db=1 --redis-password=secret

发布消息到socker

从其他应用向socker发布消息需通过Redis客户端发送Message对象到socker通道。以下是Python示例：

python
from socker import Message
import redis

# 初始化Redis客户端
redis_client = redis.Redis(host='localhost', port=6379, db=0)

# 定义消息通道和数据
channel = 'foo.bar.42'
data = {
    'yes': [
        'yes',
        'no',
        'baz'
    ]
}

# 发布消息到socker
redis_client.publish('socker', Message(channel, data))

WebSocket客户端订阅规则

WebSocket客户端订阅以下模式将收到上述示例消息：

• 精确匹配：foo.bar.42
• 层级通配：foo.bar.*（匹配foo.bar.下的所有子通道）
• 多级通配：foo.*（匹配foo.下的所有层级子通道）

发布新版本到PyPi

发布步骤

1. 更新VERSION文件中的版本号
2. 提交更改并创建版本标签：

   bash
   git commit -m "Bump version to x.y.z"
   git tag -a vx.y.z -m "Version x.y.z"
   

3. 构建源码分发包和wheel包：

   bash
   python setup.py sdist
   python setup.py bdist_wheel
   

4. 使用Twine上传分发版：

   bash
   twine upload dist/*
   

注：Twine是安全上传Python包到PyPi的工具，详情参见https://github.com/pypa/twine%E3%80%82

致谢

感谢以下开源项目提供的技术支持：

• https://github.com/aaugustin/websockets - 高性能WebSocket库
• https://github.com/jonathanslenders/asyncio-redis - asyncio Redis客户端实现