Pika 技术文档

1. 安装指南

安装环境要求

• Python 3.7 及以上版本
• 支持纯 Python 实现的 AMQP 0-9-1 协议，包括 RabbitMQ 的扩展

安装步骤

1. 使用 pip 安装 Pika：

   pip install pika
   

2. 验证安装是否成功：

   import pika
   print(pika.__version__)
   

2. 项目使用说明

简介

Pika 是一个用于 Python 的 RabbitMQ (AMQP 0-9-1) 客户端库。它是一个纯 Python 实现，支持 RabbitMQ 的扩展功能，并且不依赖于线程、greenlets、回调、continuations 或 generators。Pika 的核心设计允许它在多种网络环境中使用，并且提供了多种连接适配器以适应不同的使用场景。

主要特性

• 支持 Python 3.7+
• 不强制使用线程，但也不禁止
• 支持多种异步和同步的连接适配器
• 提供了多种连接参数配置，支持故障转移

示例代码

发送消息

import pika

connection = pika.BlockingConnection()
channel = connection.channel()
channel.basic_publish(exchange='test', routing_key='test', body=b'Test message.')
connection.close()

消费消息

import pika

connection = pika.BlockingConnection()
channel = connection.channel()

for method_frame, properties, body in channel.consume('test'):
    print(method_frame, properties, body)
    channel.basic_ack(method_frame.delivery_tag)

    if method_frame.delivery_tag == 10:
        break

requeued_messages = channel.cancel()
print('Requeued %i messages' % requeued_messages)
connection.close()

3. 项目API使用文档

主要API

pika.BlockingConnection

• 描述: 同步连接适配器，适用于简单的使用场景。
• 使用示例:

  connection = pika.BlockingConnection()
  channel = connection.channel()
  

pika.SelectConnection

• 描述: 异步连接适配器，不依赖第三方库。
• 使用示例:

  import pika
  
  parameters = pika.ConnectionParameters(host='localhost')
  connection = pika.SelectConnection(parameters)
  

pika.adapters.asyncio_connection.AsyncioConnection

• 描述: 异步连接适配器，适用于 Python 3 的 asyncio 框架。
• 使用示例:

  import pika
  import asyncio
  
  parameters = pika.ConnectionParameters(host='localhost')
  connection = pika.adapters.asyncio_connection.AsyncioConnection(parameters)
  

连接参数配置

• 描述: 支持多个连接参数配置，用于故障转移。
• 使用示例:

  parameters = (
      pika.ConnectionParameters(host='rabbitmq.zone1.yourdomain.com'),
      pika.ConnectionParameters(host='rabbitmq.zone2.yourdomain.com', connection_attempts=5, retry_delay=1)
  )
  connection = pika.BlockingConnection(parameters)
  

消息确认

• 描述: 从另一个线程请求消息确认。
• 使用示例:

  def ack_message(channel, delivery_tag):
      if channel.is_open:
          channel.basic_ack(delivery_tag)
  
  connection.add_callback_threadsafe(functools.partial(ack_message, channel, delivery_tag))
  

4. 项目安装方式

使用 pip 安装

pip install pika

从源码安装

1. 克隆项目仓库：

   git clone https://github.com/pika/pika.git
   

2. 进入项目目录并安装：

   cd pika
   python setup.py install
   

验证安装

import pika
print(pika.__version__)

通过以上步骤，您可以成功安装并使用 Pika 库进行 RabbitMQ 的开发。