Aioredis 技术文档

Aioredis 技术文档

aioredis-py asyncio (PEP 3156) Redis support 项目地址: https://gitcode.com/gh_mirrors/ai/aioredis-py

1. 安装指南

1.1 安装步骤

Aioredis 已经集成到 redis-py 4.2.0rc1 及以上版本中。要安装 Aioredis，只需执行以下命令：

pip install redis>=4.2.0rc1

1.2 推荐安装

为了提高性能和稳定性，建议同时安装 hiredis：

pip install hiredis

1.3 依赖项

Aioredis 依赖以下 Python 包：

• Python 3.6 及以上版本
• hiredis（可选但推荐）
• async-timeout
• typing-extensions

2. 项目使用说明

2.1 导入 Aioredis

在代码中导入 Aioredis 时，请使用以下方式：

from redis import asyncio as aioredis

这样可以确保你的代码与 Aioredis 的集成无缝衔接，只需更改导入部分即可。

2.2 功能支持

Aioredis 提供了丰富的功能支持，包括但不限于：

• hiredis 解析器
• 纯 Python 解析器
• 低级和高级 API
• 管道支持
• 事务支持
• 连接池
• 发布/订阅支持
• 哨兵支持
• ACL 支持
• 流支持

需要注意的是，Aioredis 目前不支持 Redis 集群。

3. 项目 API 使用文档

3.1 低级 API

低级 API 提供了对 Redis 命令的直接访问，适合需要精细控制的应用场景。

3.2 高级 API

高级 API 提供了更抽象的接口，简化了 Redis 命令的使用，适合快速开发。

3.3 管道支持

Aioredis 支持管道操作，可以批量发送多个命令，提高性能。

3.4 事务支持

Aioredis 支持 Redis 的事务操作，确保一组命令的原子性执行。

3.5 连接池

Aioredis 提供了连接池功能，可以有效管理 Redis 连接，避免频繁创建和销毁连接的开销。

3.6 发布/订阅支持

Aioredis 支持 Redis 的发布/订阅模式，适用于实时消息传递场景。

3.7 哨兵支持

Aioredis 支持 Redis 哨兵模式，可以自动发现和切换主从节点。

3.8 ACL 支持

Aioredis 支持 Redis 的 ACL（访问控制列表）功能，可以对用户进行细粒度的权限控制。

3.9 流支持

Aioredis 支持 Redis 流数据结构，适用于日志记录和消息队列等场景。

4. 项目安装方式

Aioredis 的安装方式非常简单，只需使用 pip 命令即可完成安装。推荐安装 hiredis 以提高性能和稳定性。

pip install redis>=4.2.0rc1
pip install hiredis

通过以上步骤，你可以轻松地将 Aioredis 集成到你的项目中，并利用其强大的功能进行开发。

aioredis-py asyncio (PEP 3156) Redis support 项目地址: https://gitcode.com/gh_mirrors/ai/aioredis-py