Rails Event Store 中使用 Protobuf 协议的高级指南-CSDN博客

Rails Event Store 中使用 Protobuf 协议的高级指南

什么是 Protobuf 及其优势

Protocol Buffers (Protobuf) 是 Google 开发的一种高效的数据序列化协议。相比 JSON 等文本格式，Protobuf 具有以下优势：

更小的数据体积：二进制格式比文本格式更紧凑
更快的序列化/反序列化速度：处理效率更高
强类型系统：明确定义数据结构，减少运行时错误
跨语言支持：支持多种编程语言，便于不同系统间通信

在 Rails Event Store 中使用 Protobuf 特别适合需要与其他微服务共享事件数据的场景。

环境配置

安装必要依赖

在 Gemfile 中添加以下依赖：

gem "google-protobuf"      # Protobuf 核心库
gem "protobuf_nested_struct" # 支持嵌套结构的扩展
gem "rails_event_store"    # Rails Event Store 核心
gem "ruby_event_store-protobuf" # RES 的 Protobuf 适配器

运行 bundle install 安装这些 gem。

配置 Protobuf 映射器

在 Rails 配置中设置 Protobuf 作为默认的序列化映射器：

require "ruby_event_store/protobuf"

Rails.application.configure do
  config.to_prepare do
    Rails.configuration.event_store = RailsEventStore::Client.new(
      mapper: RubyEventStore::Mappers::Protobuf.new
    )
  end
end

定义 Protobuf 事件

创建 .proto 文件

首先需要定义事件的数据结构。创建一个 events.proto3 文件：

syntax = "proto3";
package my_app;

message OrderPlaced {
  string order_id = 1;    // 字段编号1，字符串类型
  int32 customer_id = 2;  // 字段编号2，32位整数
}

生成 Ruby 类

使用 Protobuf 编译器生成对应的 Ruby 类：

# 自动生成的代码，通常不需要手动编辑
require "google/protobuf"

Google::Protobuf::DescriptorPool.generated_pool.build do
  add_message "my_app.OrderPlaced" do
    optional :order_id, :string, 1
    optional :customer_id, :int32, 2
  end
end

module MyApp
  OrderPlaced = Google::Protobuf::DescriptorPool.generated_pool.lookup("my_app.OrderPlaced").msgclass
end

事件操作

发布事件

event_store = Rails.configuration.event_store

# 创建 Protobuf 事件对象
event_data = MyApp::OrderPlaced.new(
  order_id: "K3THNX9", 
  customer_id: 123
)

# 包装成 RES 事件并发布
event = RubyEventStore::Proto.new(data: event_data)
event_store.publish(event, stream_name: "Order-K3THNX9")

读取事件

# 从事件流中读取最后一个事件
event = client.read.stream("test").last

# 访问事件数据
order_id = event.data.order_id
customer_id = event.data.customer_id

事件订阅

同步订阅处理

# 使用 lambda 表达式定义同步处理器
event_store.subscribe(
  ->(event) {
    puts "处理订单: #{event.data.order_id}"
    # 其他处理逻辑...
  }, 
  to: [MyApp::OrderPlaced.descriptor.name] # 指定要监听的事件类型
)

异步订阅处理

对于耗时操作，建议使用异步处理：

class SendOrderEmailHandler < ActiveJob::Base
  # 设置队列适配器，生产环境建议使用其他适配器如 :sidekiq
  self.queue_adapter = :inline

  def perform(payload)
    # 反序列化事件
    event = event_store.deserialize(payload.symbolize_keys)
    
    # 获取事件数据
    order_id = event.data.order_id
    customer_id = event.data.customer_id
    
    # 发送邮件等业务逻辑
    OrderMailer.confirmation(order_id, customer_id).deliver_later
  end

  private
  
  def event_store
    Rails.configuration.event_store
  end
end

# 订阅事件
event_store.subscribe(
  SendOrderEmailHandler, 
  to: [MyApp::OrderPlaced.descriptor.name]
)