ActiveInteraction 使用教程

ActiveInteraction 使用教程

active_interaction:briefcase: Manage application specific business logic.项目地址:https://gitcode.com/gh_mirrors/ac/active_interaction

项目介绍

ActiveInteraction 是一个用于管理应用程序特定业务逻辑的 Ruby gem。它实现了所谓的服务对象、交互器或命令模式。无论你如何称呼它，它的设计目的是与 Rails 无缝协作。ActiveInteraction 可以帮助你清晰地定义和执行复杂的业务逻辑，同时保持代码的整洁和可维护性。

项目快速启动

安装

首先，在你的 Gemfile 中添加以下内容：

gem 'active_interaction'

然后运行：

bundle install

基本使用

创建一个基本的交互器类：

# app/interactions/example_interaction.rb
class ExampleInteraction < ActiveInteraction::Base
  string :name

  def execute
    "Hello, #{name}!"
  end
end

运行交互器：

result = ExampleInteraction.run(name: 'World')
if result.valid?
  puts result.result
else
  puts result.errors.full_messages
end

应用案例和最佳实践

应用案例

假设你有一个电子商务网站，需要处理订单创建的业务逻辑。你可以使用 ActiveInteraction 来封装这一逻辑：

# app/interactions/create_order_interaction.rb
class CreateOrderInteraction < ActiveInteraction::Base
  integer :user_id
  array :items do
    hash do
      integer :product_id
      integer :quantity
    end
  end

  def execute
    order = Order.create(user_id: user_id)
    items.each do |item|
      order.order_items.create(product_id: item[:product_id], quantity: item[:quantity])
    end
    order
  end
end

最佳实践

1. 单一职责原则：每个交互器应该只处理一个特定的业务逻辑。
2. 输入验证：使用 ActiveInteraction 提供的过滤器来验证输入数据。
3. 错误处理：确保在交互器中处理所有可能的错误情况，并返回有意义的错误信息。

典型生态项目

ActiveInteraction::Extras

ActiveInteraction::Extras 是一个扩展 gem，提供了一些额外的功能和过滤器，以增强 ActiveInteraction 的能力。你可以通过以下方式安装：

gem 'active_interaction-extras'

安装后，你可以使用一些额外的过滤器和功能，例如：

# app/interactions/example_interaction.rb
class ExampleInteraction < ActiveInteraction::Base
  include ActiveInteraction::Extras::All

  anything :model
  uuid :id
end

其他相关项目

• ActiveModel：ActiveInteraction 依赖于 ActiveModel 和 ActiveSupport，这两个库提供了强大的模型和工具支持。
• RSpec：用于测试 ActiveInteraction 交互器的测试框架。

通过这些生态项目，你可以构建一个强大且易于维护的 Ruby 应用程序。

active_interaction:briefcase: Manage application specific business logic.项目地址:https://gitcode.com/gh_mirrors/ac/active_interaction