Circuitry 开源项目安装与使用指南

Circuitry 开源项目安装与使用指南

circuitry Decouple ruby applications using SNS fanout with SQS processing. 项目地址: https://gitcode.com/gh_mirrors/ci/circuitry

1. 项目目录结构及介绍

Circuitry 是一个用于Ruby应用程序的解耦工具，利用AWS的SNS（Simple Notification Service）进行消息发布，并通过SQS（Simple Queue Service）实现处理任务的扇出机制。下面是其主要的目录结构概述：

• bin: 包含可执行脚本。
• exe: 存放由gem命令生成的应用可执行文件。
• lib: 核心代码库所在位置，包括Circuitry的主要类和模块。
• spec: 测试规范，用于确保代码质量。
• .gitignore: 指定Git应忽略的文件和目录。
• rspec: 与RSpec测试框架相关的配置。
• rubocop.yml: RuboCop配置文件，用于检查Ruby代码风格。
• CHANGELOG.md: 记录了项目的所有更新历史。
• LICENSE.txt: 项目的MIT许可证文件。
• README.md: 项目的基本介绍和快速入门指南。
• Rakefile: 定义了Rake任务，简化项目管理。
• circuitry.gemspec: Gem规格文件，描述了Gem的元数据。

2. 项目的启动文件介绍

Circuitry本身不需要特定的“启动文件”来运行，而是作为一个库集成到您的Ruby应用中。您需要在您的应用中配置并初始化Circuitry。不过，如果要快速开始测试或使用Circuitry功能，您可以参考示例应用或者在自己的应用中添加以下到初始化阶段（比如config/application.rb对于Rails应用）:

require 'circuitry'
Circuitry.configure do |config|
  # 配置详情参照配置文件介绍部分
end

对于实际应用的启动，重点是确保已正确设置环境并加载了Circuitry配置。

3. 项目的配置文件介绍

Circuitry支持两种配置方式：通过代码初始化和YAML配置文件(config/circuitry.yml)。

通过代码初始化配置

可以在配置块中自定义每个细节，如：

Circuitry.subscriber_config do |c|
  # 示例配置，具体值需替换为真实AWS信息
  c.queue_name = "#{Rails.env}-yourapp"
  c.access_key = 'YOUR_AWS_ACCESS_KEY'
  c.secret_key = 'YOUR_AWS_SECRET_KEY'
  # 更多配置项...
end

Circuitry.publisher_config do |c|
  # 类似地配置publisher
end

YAML配置文件

更简便的方式是在config/circuitry.yml（或.erb以支持嵌入Ruby）定义配置，示例如下：

access_key: "YOUR_AWS_ACCESS_KEY"
secret_key: "YOUR_AWS_SECRET_KEY"
region: "us-east-1"

development:
  publisher:
    topic_names: ["topic-dev-name"]
  subscriber:
    queue_name: "queue-dev-name"
    # 其他环境配置...

production:
  # 生产环境配置...

在配置文件中，你可以分别对生产与开发环境设定不同的配置，包括队列名、主题名等。记住在部署时选择正确的环境配置。

完成上述步骤后，您的Ruby应用便具备了使用Circuitry进行消息发布与订阅的能力，进一步实现系统的微服务化和模块间的解耦。

circuitry Decouple ruby applications using SNS fanout with SQS processing. 项目地址: https://gitcode.com/gh_mirrors/ci/circuitry