Active Job – 稍后执行工作

Active Job 是一个用于声明作业并使其在各种队列后端上运行的框架。这些作业可以是任何内容，从定期安排的清理到计费、再到邮件发送——任何可以切分成小工作单元并并行运行的内容。

它还充当 Action Mailer 的 deliver_later 功能的后端，该功能可以轻松地将任何邮件变成稍后运行的作业。这是现代 Web 应用程序中最常见的作业之一：在请求-响应周期之外发送电子邮件，这样用户不必等待它。

重点是确保所有 Rails 应用程序都具有一个作业基础设施，即使它采用“立即运行程序”的形式。然后，我们可以在此基础上构建框架功能和其他 gem，而无需担心 Delayed Job 和 Resque 之间的 API 差异。选择队列后端会更多地成为一个操作问题。您将能够在它们之间切换，而无需重写作业。

您可以在 Active Job 基础知识 指南中阅读有关 Active Job 的更多信息。

用法

要了解如何使用您首选的队列后端，请参阅 ActiveJob::QueueAdapters 中的适配器文档。

像这样声明一个作业

class MyJob < ActiveJob::Base
  queue_as :my_jobs

  def perform(record)
    record.do_work
  end
end

像这样排队一个作业

MyJob.perform_later record  # Enqueue a job to be performed as soon as the queuing system is free.

MyJob.set(wait_until: Date.tomorrow.noon).perform_later(record)  # Enqueue a job to be performed tomorrow at noon.

MyJob.set(wait: 1.week).perform_later(record) # Enqueue a job to be performed 1 week from now.

就是这样！

GlobalID 支持

Active Job 支持 GlobalID 序列化 以用于参数。这使得可以将实时 Active Record 对象传递给作业，而不是类/ID 对，然后必须手动反序列化它们。以前，作业看起来像这样

class TrashableCleanupJob
  def perform(trashable_class, trashable_id, depth)
    trashable = trashable_class.constantize.find(trashable_id)
    trashable.cleanup(depth)
  end
end

现在您可以简单地执行

class TrashableCleanupJob
  def perform(trashable, depth)
    trashable.cleanup(depth)
  end
end

这适用于任何混合了 GlobalID::Identification 的类，默认情况下已混合到 Active Record 类中。

支持的队列系统

Active Job 已为多个队列后端（Sidekiq、Resque、Delayed Job 等）内置了适配器。要获取适配器的最新列表，请参阅 ActiveJob::QueueAdapters 的 API 文档。

请注意：我们不接受新适配器的拉取请求。我们鼓励库作者在其 gem 或独立 gem 中提供 ActiveJob 适配器。有关此内容的讨论，请参阅以下 PR：23311、21406 和 #32285。

下载和安装

可以使用 RubyGems 安装最新版本的 Active Job

$ gem install activejob

源代码可作为 GitHub 上的 Rails 项目的一部分下载

• github.com/rails/rails/tree/main/activejob

许可证

Active Job 在 MIT 许可证下发布

• opensource.org/licenses/MIT

支持

API 文档位于

• api.rubyonrails.org

Ruby on Rails 项目的错误报告可在此处提交

• github.com/rails/rails/issues

功能请求应在此处的 rails-core 邮件列表中讨论

• discuss.rubyonrails.org/c/rubyonrails-core