Beetle 项目技术文档

1. 安装指南

环境准备

在安装 Beetle 之前，请确保您的系统满足以下要求：

• 至少 2 个 AMQP 服务器（推荐使用 RabbitMQ）
• 至少 1 个 Redis 服务器（推荐使用主从配置）
• MySQL 数据库（用于测试）
• Ruby 环境
• Go 环境（用于编译和运行集成测试）

依赖安装

Beetle 依赖多个 Ruby 和 Go 库，您可以使用 bundler 来管理 Ruby 依赖。首先，确保您已经安装了 bundler：

gem install bundler

然后，在项目根目录下运行以下命令来安装所有依赖：

bundle install

对于 Go 依赖，您可以通过以下命令编译 Beetle 的 Go 二进制文件：

make

测试环境设置

为了运行测试，您需要设置 MySQL 和 Redis 环境。首先，创建一个名为 beetle_test 的 MySQL 数据库：

mysql -e 'create database beetle_test;'

然后，启动 Redis 服务器：

redis-server

使用 Docker 启动测试环境

如果您希望使用 Docker 来启动测试环境，可以运行以下命令：

docker-compose pull
docker-compose up

这将启动 MySQL、两个 Redis 服务器、两个 RabbitMQ 实例和一个 Consul 开发节点。

2. 项目使用说明

配置

首先，您需要配置 Beetle 的运行环境。可以通过以下代码进行配置：

Beetle.config do |config|
  config.servers = "broker1:5672, broker2:5672"
  config.redis_server = "redis1:6379"
end

实例化客户端

配置完成后，您可以实例化一个 Beetle 客户端：

b = Beetle::Client.new

配置交换机、队列、绑定、消息和处理器

接下来，您需要配置交换机、队列、绑定、消息和处理器：

b.configure do
  queue :test
  message :test
  handler(:test) { |message| puts message.data }
end

发布消息

使用以下代码发布消息：

b.publish :test, "I'm a test message"

订阅消息

使用以下代码订阅消息：

b.listen_queues

3. 项目 API 使用文档

Beetle::Client

Beetle::Client 是 Beetle 的核心类，提供了以下主要方法：

• new: 创建一个新的 Beetle 客户端实例。
• configure: 配置交换机、队列、绑定、消息和处理器。
• publish: 发布消息到指定的队列。
• listen_queues: 订阅并监听队列中的消息。

Beetle.config

Beetle.config 用于配置 Beetle 的运行环境，支持以下配置项：

• servers: 指定 AMQP 服务器的地址和端口。
• redis_server: 指定 Redis 服务器的地址和端口。

4. 项目安装方式

通过 RubyGems 安装

您可以通过 RubyGems 安装 Beetle：

gem install beetle

从源码安装

您也可以从源码安装 Beetle。首先，克隆项目仓库：

git clone https://github.com/xing/beetle.git

然后，进入项目目录并安装依赖：

cd beetle
bundle install

最后，编译 Go 二进制文件：

make

运行测试

在安装完成后，您可以运行测试来验证安装是否成功：

rake test

如果您希望运行集成测试，可以使用以下命令：

cucumber

通过以上步骤，您应该能够成功安装并使用 Beetle 项目。