SimpleAmqpClient 技术文档

1. 安装指南

SimpleAmqpClient 是一个易于使用的 C++ 包装库，基于 rabbitmq-c C 库。下面是在不同环境中安装 SimpleAmqpClient 的指南。

环境支持

• Windows 10 (MSVC 2019, Win64)
• Windows 7 (MSVC 10, Win64, Win32)。可能适用于其他版本，但未经测试
• Linux (RHEL 6.0, GCC-4.4.5, 32 和 64 位)。可能适用于其他配置，但未经测试
• Mac OS X (10.7, 10.6, gcc-4.2, 32 和 64 位)。可能适用于旧版本，但未经测试

预先条件

• boost-1.47.0 或更新版本（使用 chrono、system 以及其他基于头的库，例如 sharedptr 和 noncopyable）
• rabbitmq-c 版本 0.8.0 或更高版本
• cmake 3.5 或更高版本，用于构建系统
• Doxygen（可选），仅用于生成 API 文档

构建过程

此项目是一个典型的 cmake 项目，构建过程与其他 typical cmake 项目类似：

在源代码解压目录的同级目录下：

mkdir simpleamqpclient-build
cd simpleamqpclient-build
cmake ..

然后使用适当的构建工具构建库（make、msbuild）。

有趣的目标：

• test - 构建并运行测试
• install - 将库和头文件安装到 CMAKE_INSTALL_PREFIX 定义的路径
• doc - 如果已设置 doxygen，将生成 API 文档

注意：

• 可以通过向 cmake 传递 -DENABLE_TESTING=ON 来启用基于 google-test 的测试套件

Windows 构建过程

需要 Boost 库，可以使用 nuget 安装：

nuget install boost_chrono-vc142 -Version 1.77.0
nuget install boost_system-vc142 -Version 1.77.0
nuget install boost -Version 1.77.0

要成功构建和安装，rabbitmq-c 应该被构建为 共享库。

让 boost_chrono 和 boost_system 位于同一目录 C:\boost，rabbitmq-c 位于 C:\rabbitmq-c，SSL 关闭，并使用 VS2019，CMake CLI 命令是：

cd cmake -G "Visual Studio 16" -A x64 -DBoost_INCLUDE_DIR="C:/boost.XX.XX.X.X/lib/native/include" -DBOOST_ROOT="C:/boost.X.XX.X.X" -DBOOST_LIBRARYDIR="C:/boost" -DRabbitmqc_INCLUDE_DIR="C:/rabbitmq-c/include" -DRabbitmqc_LIBRARY="C:/rabbitmq-c/lib/rabbitmq.4.lib" -DBoost_USE_STATIC_LIBS=ON -DBUILD_STATIC_LIBS=ON -DENABLE_SSL_SUPPORT=OFF ..

2. 项目使用说明

要使用 SimpleAmqpClient 库，首先包含以下头文件：

#include <SimpleAmqpClient/SimpleAmqpClient.h>

这将包含使用库所需的所有头文件。对应的库是 SimpleAmqpClient。

库的主要接口是 AmqpClient::Channel 类。它表示到 AMQP 代理的连接，连接在创建此类实例时建立。

AmqpClient::Channel::ptr_t connection = AmqpClient::Channel::Create("localhost");

所有类都有一个 typedef ptr_t，等价于 boost::shared_ptr<> 的容器类。所有类还有一个 Create() 方法，使用 boost::make_shared<>() 创建一个新的 ptr_t。建议您使用这些方法在库中构造对象。

处理声明/绑定/解绑/删除交换和队列的命令都是通过上述 AmqpClient::Channel 对象完成的。如果其中一条命令无法完成，将抛出 AmqpClient::ChannelException，可以捕获它，AmqpClient::Channel 对象仍然可用。如果发生更严重的错误，可能会抛出 AmqpClient::ConnectionException 或 AmqpClient::AmqpResponseLibraryException，在这种情况下，Channel 对象将不再处于可用状态，进一步使用只会生成更多异常。

消费消息是通过使用 BasicConsume 方法设置消费者完成的。此方法返回一个消费者标签，该标签应与 BasicConsumeMessage、BasicQos、BasicRecover 和 BasicCancel 一起使用。

std::string consumer_tag = channel->BasicConsume("my_queue", "");
Envelope::ptr_t envelope = channel->BasicConsumeMessage(consumer_tag);
// 或者：
Envelope::ptr_t envelope;
channel->BasicConsumeMessage(consumer_tag, envelope, 10); // 10 毫秒超时
// 确认：
channel->BasicAck(envelope);
// 取消：
channel->BasicCancel(consumer_tag);

3. 项目 API 使用文档

SimpleAmqpClient 提供了丰富的 API 用于操作 AMQP 消息队列。以下是一些主要类的简要说明：

• AmqpClient::Channel: 表示到 AMQP 代理的连接。
• AmqpClient::Channel::ptr_t: 类型定义，表示对 AmqpClient::Channel 的智能指针。
• AmqpClient::Envelope: 表示 AMQP 消息。

更多 API 细节，请参阅项目官方文档。

4. 项目安装方式

项目安装方式已在“1. 安装指南”中详细描述。以下是简要步骤：

使用 cmake 构建：

mkdir simpleamqpclient-build
cd simpleamqpclient-build
cmake ..

然后使用适当的构建工具（如 make 或 msbuild）构建库。

要安装库和头文件，运行以下命令：

cmake --build . --target install