如何将自定义的延迟作业作业与 ActiveJob 一起使用？

Posted 2023-02-15

【中文标题】如何将自定义的延迟作业作业与 ActiveJob 一起使用？

【英文标题】：How do I use custom delayed_job jobs with ActiveJob?

【发布时间】：2015-04-21 14:42:21

【问题描述】：

我正在使用 DelayedJob，我想更新我的 Rails 4.2 应用以使用 ActiveJob。问题是我有一堆看起来像这样的自定义作业：

AssetDeleteJob = Struct.new(:user_id, :params) do
  def perform
    # code
  end
  # more methods n' stuff
end

然后在某处的控制器中，作业使用以下语法排队：

@asset_delete_job = AssetDeleteJob.new(current_admin_user.id, params)
Delayed::Job.enqueue @asset_delete_job

我想找到 ActiveJob 的等价物。以上内容基本上直接来自 DJ 文档。使用它来排队单个调用就像调用作业的 perform 方法一样简单，就像使用 DJ 一样。但我的更复杂，需要 DJ 的 Struct 语法和传递给它的参数。

这是我迄今为止尝试过的：

class AssetDeleteJob < ActiveJob::Base
  queue_as :default

  def initialize(user_id, params)
    @user_id  = user_id
    @params   = params
  end

  def perform
  #code
  end

  # more methods n' stuff

end

job = AssetDeleteJob.new(1, ids: [1,2,3])

不幸的是，实例化的对象没有我所期望的 #perform_later 方法。它确实有#enqueue，但我得到一个奇怪的错误：

无法记录“enqueue.active_job”事件。 NoMethodError：未定义的方法“任何？”对于 nil:NilClass

...后跟数组中的堆栈跟踪，以

结尾

NoMethodError: nil:NilClass 的未定义方法 `map'

几个奇怪的错误，但我可能不应该直接访问#enqueue。就 ActiveJob 正在寻找的内容而言，上述内容似乎很有趣。我错过了什么？

【参考方案1】：

我可以看到两个问题。首先，您已经在自定义作业类中定义了initialize 方法，从而覆盖了ActiveJob 类中的initialize 方法。这就是引发异常的原因。我不确定您是否可以摆弄活动作业的实例化。其次，您试图在该类的实例上调用类方法 perform_later，而 ruby​​ 不允许这样做。

解决起来很简单，只需将参数添加到自定义类中的perform 方法即可：

class AssetDeleteJob < ActiveJob::Base
  #code

  def perform(user_id, params)
    #do a thing
  end

  #more code
end

然后通过调用类似的方法将作业排队：

AssetDeleteJob.perform_later(1, ids: [1,2,3])

【讨论】：

这是正确的。如果您确实想修改 initialize 以覆盖某些默认值，您可以调用 super() 作为自定义初始化中的最后一个命令。我最近这样做是为了允许一次性调用（使用自定义参数）和预定的默认值。

【参考方案2】：

# in jobs/asset_delete_job.rb
class AssetDeleteJob < ActiveJob::Base 
  queue_as :default
  def perform(user_id, params)
    AssetService.new(user_id, params).delete # for example
  end
end

# somewhere in your controllers/assets_controller.rb 
  AssetDeleteJob.perform_later(1, ids: [1,2,3])