缓存队列 · 函数

Redis流组读取

通过消费者组从 Redis 流读取消息。

调用签名

(客户端, 组名: 'str', 消费者: 'str', 流映射: 'dict', 数量: 'int | None' = None, 阻塞毫秒: 'int | None' = None)

RZHONGWEN
PYTHON

Chinese example

中文代码示例

# 案例：查看缓存队列入口
设 功能 = 缓存队列.Redis流组读取
打印(功能)

可直接放进 .cs / .中py 文件运行。转换器会把中文代码交给真实 Python 解释器。

Parameters

参数说明

6 个参数

参数类型 / 传入方式说明

客户端可选 · 默认无

未声明位置参数或字段名=值

按函数业务含义传入客户端;首次使用建议先打印(结果) 确认其作用。

常见错误：漏传或对象为 None 会报 TypeError/AttributeError;先调用对应的创建函数拿到客户端再传入

组名可选 · 默认无

str位置参数或字段名=值

字符串类型的组名参数,按函数业务含义传入对应文本。

常见错误：漏传会报 TypeError: missing required argument: '组名';检查调用是否漏了这行

消费者可选 · 默认无

str位置参数或字段名=值

字符串类型的消费者参数,按函数业务含义传入对应文本。

常见错误：漏传会报 TypeError: missing required argument: '消费者';检查调用是否漏了这行

流映射可选 · 默认无

dict位置参数或字段名=值

字典类型的流映射参数,按函数业务含义传入对应键值对。

常见错误：漏传会报 TypeError: missing required argument: '流映射';检查调用是否漏了这行

数量可选 · 默认 None

int | None位置参数或字段名=值

一次读取或处理的数据点数量。

常见错误：类型不匹配会报 TypeError;按字段类型(int | None) 传值

阻塞毫秒可选 · 默认 None

int | None位置参数或字段名=值

按函数业务含义传入阻塞毫秒;首次使用建议先打印(结果) 确认其作用。

常见错误：类型不匹配会报 TypeError;按字段类型(int | None) 传值

Playbook

基础用法 · 进阶组合 · 错误排查

# 案例：查看缓存队列入口
设 功能 = 缓存队列.Redis流组读取
打印(功能)

# 进阶组合:Redis流组读取 配合 缓存队列 业务流使用
设 连接 = 缓存队列.连接Redis(主机="127.0.0.1", 端口=6379)
设 结果 = 缓存队列.Redis流组读取(
    客户端="示例值",  # 必填
    组名="示例",  # 必填
    消费者="示例",  # 必填
)
缓存队列.关闭(连接)
打印(结果)

# 错误排查:覆盖 3 个必填参数

## 参数 1: 客户端
# 错误:漏传或为 None 会报 TypeError/AttributeError
# 设 结果 = 缓存队列.Redis流组读取(客户端=None)  # AttributeError
# 修复:先建立 客户端 再传入
设 客户端 = "已准备好的对象"
设 结果 = 缓存队列.Redis流组读取(客户端=客户端)

## 参数 2: 组名
# 错误:漏传会报 TypeError: missing required argument
# 设 结果 = 缓存队列.Redis流组读取()  # TypeError
# 修复:补上必填字段
设 结果 = 缓存队列.Redis流组读取(组名="示例")

## 参数 3: 消费者
# 错误:漏传会报 TypeError: missing required argument
# 设 结果 = 缓存队列.Redis流组读取()  # TypeError
# 修复:补上必填字段
设 结果 = 缓存队列.Redis流组读取(消费者="示例")
打印(结果)