Rails Event Store 教程：实现发布-订阅模式的消息总线-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00703/article/details/148993165

Rails Event Store 教程：实现发布-订阅模式的消息总线

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

前言

在现代应用开发中，事件驱动架构(EDA)越来越受到重视。Rails Event Store 作为一个强大的事件存储和发布-订阅系统，为Ruby on Rails应用提供了完善的解决方案。本文将深入讲解如何使用Rails Event Store实现发布-订阅模式的消息总线。

事件定义基础

在Rails Event Store中，事件是系统的核心概念。每个事件都是一个不可变的事实记录，代表系统中发生的某个重要事情。

定义事件非常简单，只需继承RailsEventStore::Event基类：

class OrderCancelled < RailsEventStore::Event
end

这里我们定义了一个OrderCancelled事件，表示订单被取消的事实。事件类可以包含自定义方法和属性，但通常我们会将数据存储在data哈希中。

配置Rails Event Store客户端

要在应用中使用Rails Event Store，首先需要进行基本配置：

# config/application.rb
module YourAppName
  class Application < Rails::Application
    config.to_prepare { Rails.configuration.event_store = RailsEventStore::Client.new }
  end
end

这段代码将Rails Event Store客户端实例存储在Rails配置中，使其在整个应用中都可用。to_prepare确保在每次代码重新加载后都会重新初始化。

发布事件

发布事件是事件驱动架构中的关键操作。以下是典型的发布事件示例：

class CancelOrdersService
  def call(order_id, user_id)
    order = Order.find_by!(customer_id: user_id, order_id: order_id)
    order.cancel!
    event_store.publish(
      OrderCancelled.new(data: { order_id: order.id, customer_id: order.customer_id }),
      stream_name: "Order-#{order.id}",
    )
  end

  private

  def event_store
    Rails.configuration.event_store
  end
end

关键点说明：

我们创建了一个包含相关数据的新事件实例
使用publish方法发布事件
可以指定事件流名称(stream_name)，用于事件分类和查询

订阅事件

订阅事件有三种主要方式：对象订阅、块订阅和全局订阅。

对象订阅方式

任何响应call方法的对象都可以作为事件处理器：

cancel_order = CancelOrder.new
event_store = Rails.configuration.event_store
listener = OrderNotifier.new

event_store.within { cancel_order.call(order_id, user_id) }.subscribe(listener, to: [OrderCancelled]).call

处理器类示例：

class OrderNotifier
  def call(event)
    order_id = order.data.fetch(:order_id)
    case event
    when OrderCancelled
      # 处理订单取消通知逻辑
    else
      raise "不支持的事件类型 #{event.inspect}"
    end
  end
end

块订阅方式

对于简单逻辑，可以直接使用块：

event_store
  .within { cancel_order.call(order_id, user_id) }
  .subscribe(to: [OrderCancelled]) { |event| Rails.logger.warn(event.inspect) }
  .call

全局订阅方式

全局订阅器在应用启动时配置，会处理所有匹配的事件：

# config/application.rb
module YourAppName
  class Application < Rails::Application
    config.to_prepare do
      Rails.configuration.event_store = event_store = RailsEventStore::Client.new
      event_store.subscribe(OrderNotifier.new, to: [OrderCancelled])
    end
  end
end