Rails Event Store 使用教程

Rails Event Store 使用教程

rails_event_storeA Ruby implementation of an Event Store based on Active Record项目地址:https://gitcode.com/gh_mirrors/ra/rails_event_store

1. 项目介绍

Rails Event Store (RES) 是一个基于 Active Record 的 Ruby 实现的事件存储库。它旨在为 Rails 应用程序提供一个事件驱动架构的基础设施。通过 RES，您可以将事件作为一等公民来处理，从而实现以下功能：

• 作为发布-订阅总线，解耦核心业务逻辑与外部关注点。
• 替代 ActiveRecord 回调和观察者。
• 作为松耦合组件之间的通信层，同步或异步响应事件。
• 将副作用（如通知、指标等）从控制器和服务中提取到事件处理程序中。
• 构建审计日志。

2. 项目快速启动

安装

首先，将 Rails Event Store 添加到您的 Gemfile 中：

gem 'rails_event_store'

然后运行 bundle install 安装依赖。

初始化

在您的 Rails 应用程序中，运行以下命令来生成必要的配置文件和数据库表：

rails generate rails_event_store_active_record:install
rails db:migrate

配置

在 config/application.rb 中配置 Rails Event Store：

require 'rails_event_store'
require 'aggregate_root'
require 'arkency/command_bus'

Rails.configuration.to_prepare do
  Rails.configuration.event_store = RailsEventStore::Client.new
  Rails.configuration.command_bus = Arkency::CommandBus.new

  AggregateRoot.configure do |config|
    config.default_event_store = Rails.configuration.event_store
  end
end

发布和订阅事件

发布事件

event_store = Rails.configuration.event_store

event = MyEvent.new(data: { foo: 'bar' })
event_store.publish(event, stream_name: 'stream_name')

订阅事件

event_store.subscribe(MyEventHandler, to: [MyEvent])

3. 应用案例和最佳实践

应用案例

• 订单系统：在订单系统中，可以使用 Rails Event Store 来记录订单状态的变化事件，如“订单创建”、“订单支付”、“订单取消”等。这些事件可以被订阅者用于更新订单状态、发送通知或生成报表。

• 用户注册：在用户注册流程中，可以使用事件来记录用户注册事件，并触发后续的欢迎邮件发送、用户权限设置等操作。

最佳实践

• 事件命名：使用清晰且有意义的事件名称，确保事件名称能够准确描述事件的含义。
• 事件数据：事件数据应包含足够的信息，以便订阅者能够正确处理事件。
• 事件版本控制：随着业务需求的变化，事件的数据结构可能会发生变化。建议在事件中包含版本信息，以便订阅者能够正确处理不同版本的事件。

4. 典型生态项目

• ruby_event_store-active_record：提供基于 ActiveRecord 的事件存储实现。
• ruby_event_store-browser：提供一个 Web 界面，用于浏览和查询事件存储中的事件。
• ruby_event_store-rspec：提供 RSpec 测试支持，方便编写事件存储相关的测试用例。
• ruby_event_store-newrelic：集成 New Relic 监控，用于监控事件存储的性能。

通过这些生态项目，您可以进一步扩展和定制 Rails Event Store 的功能，以满足特定的业务需求。

rails_event_storeA Ruby implementation of an Event Store based on Active Record项目地址:https://gitcode.com/gh_mirrors/ra/rails_event_store