Haigha - 同步与异步的AMQP客户端库技术文档

1. 安装指南

Haigha是一个用于与AMQP代理交互的客户端库，支持同步和异步操作。以下是安装Haigha的步骤：

使用pip安装

Haigha可以通过pip从PyPI安装：

pip install haigha

从源码安装

如果你希望从源码安装Haigha，可以按照以下步骤操作：

1. 克隆Haigha的GitHub仓库：

   git clone https://github.com/agoragames/haigha.git
   

2. 进入项目目录：

   cd haigha
   

3. 安装依赖：

   • 如果需要安装开发依赖（如测试框架）：

     pip install -r development.txt
     

   • 如果不需要开发依赖：

     pip install -r requirements.txt
     

安装异步支持

Haigha支持多种异步传输类型，包括libevent和gevent。默认情况下，Haigha不会自动安装这些依赖。如果你需要使用libevent，可以手动安装：

pip install event-agora==0.4.1

2. 项目的使用说明

Haigha提供了一个简单易用的接口来与AMQP代理进行交互。以下是一个简单的使用示例，展示了如何连接、声明交换机和队列、发布消息以及获取消息：

from haigha.connection import Connection
from haigha.message import Message

# 创建连接
connection = Connection(
    user='guest', password='guest',
    vhost='/', host='localhost',
    heartbeat=None, debug=True
)

# 创建通道
ch = connection.channel()

# 声明交换机
ch.exchange.declare('test_exchange', 'direct')

# 声明队列
ch.queue.declare('test_queue', auto_delete=True)

# 绑定队列到交换机
ch.queue.bind('test_queue', 'test_exchange', 'test_key')

# 发布消息
ch.basic.publish(Message('body', application_headers={'hello': 'world'}),
                 'test_exchange', 'test_key')

# 获取消息
print(ch.basic.get('test_queue'))

# 关闭连接
connection.close()

使用RabbitMQ协议扩展

如果你需要使用RabbitMQ的协议扩展，可以使用RabbitConnection类来初始化连接：

from haigha.connections.rabbit_connection import RabbitConnection

connection = RabbitConnection(
    user='guest', password='guest',
    vhost='/', host='localhost',
    heartbeat=None, debug=True
)

3. 项目API使用文档

Haigha的API设计简洁，易于使用。以下是一些常用的API方法：

连接管理

• Connection(user, password, vhost, host, heartbeat, debug)：创建一个新的AMQP连接。
• connection.channel()：创建一个新的通道。
• connection.close()：关闭连接。

通道管理

• channel.exchange.declare(exchange, type)：声明一个交换机。
• channel.queue.declare(queue, auto_delete)：声明一个队列。
• channel.queue.bind(queue, exchange, routing_key)：将队列绑定到交换机。
• channel.basic.publish(message, exchange, routing_key)：发布消息到指定的交换机和路由键。
• channel.basic.get(queue)：从队列中获取一条消息。

消息管理

• Message(body, application_headers)：创建一个新的消息对象。

4. 项目安装方式

Haigha可以通过多种方式安装，具体取决于你的需求：

使用pip安装

pip install haigha

从源码安装

1. 克隆仓库：

   git clone https://github.com/agoragames/haigha.git
   

2. 进入项目目录：

   cd haigha
   

3. 安装依赖：

   • 安装开发依赖：

     pip install -r development.txt
     

   • 安装生产依赖：

     pip install -r requirements.txt
     

安装异步支持

如果你需要使用libevent或gevent，可以手动安装相关依赖：

pip install event-agora==0.4.1

总结

Haigha是一个功能强大且易于使用的AMQP客户端库，支持同步和异步操作。通过本文档，你可以快速了解如何安装、使用Haigha，并掌握其核心API的使用方法。希望本文档能帮助你更好地理解和使用Haigha。