Imperator 开源项目教程

Imperator 开源项目教程

imperator Imperator is a gem for creating small command objects 项目地址: https://gitcode.com/gh_mirrors/im/imperator

1、项目介绍

Imperator 是一个用于创建小型命令对象的 Ruby gem。命令模式是一种设计模式，用于封装执行方法或过程所需的所有信息。在 Web 应用程序中，命令通常用于将方法的执行延迟到后台处理器，从而避免在请求周期内执行。

为什么使用命令对象？

• 解耦控制器：Rails 控制器的职责是响应请求，而不是处理业务逻辑。命令对象可以将业务逻辑从控制器中分离出来，减少控制器的复杂性。
• 后台处理：命令对象非常适合用于将任务放入后台处理，如使用 Delayed::Job、Resque 或 Sidekiq 等后台处理器。
• 验证逻辑：命令对象提供了一个合适的地方来处理交互验证，而不是将验证逻辑放在数据模型中。

2、项目快速启动

安装

在 Gemfile 中添加以下内容：

gem 'imperator'

然后运行 bundle install 安装 gem。

创建命令对象

以下是一个简单的命令对象示例：

class DoSomethingCommand < Imperator::Command
  include ActiveModel::Validations

  attribute :some_object_id
  attribute :some_value

  validates_presence_of :some_object_id

  action do
    obj = SomeObject.find(self.some_object_id)
    obj.do_something(self.some_value)
  end
end

使用命令对象

在控制器中使用命令对象：

class SomeController < ApplicationController
  def update
    command = DoSomethingCommand.new(params[:do_something])
    if command.valid?
      command.perform
      redirect_to root_url
    else
      render edit_some_resource_path(command.some_object_id)
    end
  end
end

3、应用案例和最佳实践

表单处理

命令对象可以用于表单处理，替代 ActiveRecord 模型。首先，确保命令对象遵循 ActiveModel 的命名接口：

class DoSomethingCommand < Imperator::Command
  include ActiveModel::Naming
  # ...
end

然后，在表单中使用命令对象：

<%= form_for(@command, as: :do_something, url: some_resource_path(@command.some_object_id), method: :put) do |f| %>
  <!-- 表单内容 -->
<% end %>

后台处理

使用 Delayed::Job 将命令对象放入后台处理：

Delayed::Job.enqueue command

自定义后台处理器

可以创建自定义的后台处理器，只需实现 #commit 方法：

class Imperator::NullBackgroundProcessor
  def self.commit(command, options = nil)
    command.perform
  end
end

4、典型生态项目

Virtus

Imperator 依赖于 Virtus gem，用于定义命令对象的属性。Virtus 是一个用于 Ruby 对象的属性定义和类型转换库。

ActiveModel

Imperator 支持 ActiveModel 接口，如验证和命名接口，使得命令对象可以与 Rails 表单和验证系统无缝集成。

Delayed::Job

Delayed::Job 是一个简单的 Ruby 后台任务处理器，Imperator 可以与 Delayed::Job 集成，将命令对象的执行延迟到后台。

Resque 和 Sidekiq

Resque 和 Sidekiq 是更强大的后台任务处理器，Imperator 也可以与它们集成，提供更高效的后台处理能力。

imperator Imperator is a gem for creating small command objects 项目地址: https://gitcode.com/gh_mirrors/im/imperator