node-amqp 项目技术文档

1. 安装指南

在开始使用 node-amqp 项目前，请确保您的系统中已经安装了 Node.js。以下为安装 node-amqp 的步骤：

npm install amqp

2. 项目使用说明

node-amqp 是一个用于连接 RabbitMQ（或其他支持 AMQP 协议的服务器）的客户端库。以下是一个连接到服务器并监听队列的示例：

const amqp = require('amqp');

const connection = amqp.createConnection({ host: 'dev.rabbitmq.com' });

// 添加错误处理
connection.on('error', function(e) {
  console.log("Error from amqp: ", e);
});

// 等待连接建立
connection.on('ready', function () {
  // 使用默认的 'amq.topic' 交换机
  connection.queue('my-queue', function (q) {
      // 绑定所有消息
      q.bind('#');
    
      // 接收消息
      q.subscribe(function (message) {
        // 打印消息到控制台
        console.log(message);
      });
  });
});

3. 项目API使用文档

以下是 node-amqp 的一些主要 API 使用说明：

连接

• new amqp.Connection(): 实例化一个新的连接。使用 connection.connect() 连接到服务器。
• amqp.createConnection(): 返回一个 amqp.Connection 实例，其中包含一个 net.Socket 实例在其 socket 属性上。

队列

• connection.queue(name[, options][, openCallback]): 在连接上创建一个新队列。
• queue.subscribe([options,] listener): 订阅队列中的消息。
• queue.subscribeRaw([options,] listener): 以原始格式订阅队列中的消息。
• queue.unsubscribe(consumerTag): 取消队列的订阅。
• queue.shift([reject[, requeue]]): 从队列中获取下一个消息。
• queue.bind([exchange,] routing): 将队列与交换机绑定。
• queue.unbind([exchange,] routing): 将队列与交换机解绑。
• queue.bind_headers([exchange,] routing): 使用头信息将队列与交换机绑定。
• queue.destroy(options): 销毁队列。

交换机

• exchange.on('open', callback): 当交换机打开时触发。
• connection.exchange(): 获取一个交换机实例。
• connection.exchange(name, options={}, openCallback): 在连接上创建一个新交换机。
• exchange.publish(routingKey, message, options, callback): 将消息发布到交换机。
• exchange.destroy(ifUnused = true): 如果未使用，销毁交换机。
• exchange.bind(srcExchange, routingKey [, callback]): 将交换机与源交换机绑定。
• exchange.unbind(srcExchange, routingKey [, callback]): 将交换机与源交换机解绑。
• exchange.bind_headers(exchange, routing [, bindCallback]): 使用头信息将交换机与另一个交换机绑定。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中说明，使用 npm 命令进行安装：

npm install amqp

以上就是关于 node-amqp 项目的技术文档，希望对您有所帮助。