Sidekiq 与 ActiveJob 的关系

2017-10-17 本文已影响0人李行风

文章原文地址：https://github.com/mperham/sidekiq/wiki/Active-Job

Active Job

Active Job Introduction

Rails 4.2 引入了 Active Job。Active Job 是一个为了与任务执行者进行交互而提供的标准的接口。Active Job 可以被配置成与 Sidekiq 一起工作。

需要注意的是，许多高级的 Sidekiq 特性（sidekiq_options）无法通过ActiveJob控制或者配置，例如，保存回溯（backtraces）

Active Job Setup

Active Job 装配器可能被设置为 :sidekiq 或者它仅仅简单的使用默认的 :inline。在 config/application.rb 中像这样做是可行的：

class Application < Rails::Application
    #...
    config.active_job.queue_adapter = :sidekiq
end

我们可以用发生器来创建一个新的任务。

rails generate job Example

上面的命令将会创建 /app/jobs/example_job.rb

class ExampleJob < ActiveJob::Base
    # Set the Queue as Default
    queue_as :default
    
    def perform(*args)
      # Perform Job
    end
end

Usage

任务可以在任何地方被添加到任务队列。我们可以通过以下方式添加一个任务到队列当中：

    ExampleJob.perform_later args

这样，Sidekiq 会为我们运行这个任务。如果任务因为某些原因失败了，Sidekiq 通常会重试这些任务。

Customizing error handling

Activejob 不支持 Sidekiq 的丰富的 retry 特性.取而代之的是，它为编写任务的重试功能提供了一个简单抽象，在你遇到特定的异常时。

class ExampleJob < ActiveJob::Base
  rescue_from(ErrorLoadingSite) do
    retry_job wait: 5.minutes, queue: :low_priority 
  end 

  def perform(*args)
    # Perform Job
  end
end

警告：如果你使用ActiveJob实现重试功能，你将会失去一系列的 Sidekiq 的功能：

可视化网页（Retries 选项卡将会是空）
你不能使用 Sidekiq::RetrySet 的 API 来进行重试任务
Sidekiq 的日期将不会包含任务错误或回溯
错误将不会被报告给Sidekiq的全局错误处理函数
你将无法使用一些与 AJ 的重试有关的高级 Sidekiq 的特性

Action Mailer

Action Mailer 现在带来了一个名为 #deliver_later 的方法，这个方法会异步（你的邮件将会在后台任务中发送）的发邮件。如果 Active Job 被设置成用 Sdiekiq ，我们可以使用 #deliver_later 方法。不同于 Sidekiq，使用 Active Job 会用全局ID 来序列化所有的 activerecord 实例对象。之后这些实例对象可能会被反序列化。

发件人会被放进邮件队列。记住启动 sidekiq 处理上面所说的队列：

bundle exec sidekiq -q default -q mailers

为了发送一条普通信息到任务队列中，我们可以使用：

UserMailer.welcome_email(@user).deliver_later

如果你想绕过任务队列并且异步执行任务，你可以使用：

UserMailer.welcome_email(@user).deliver_now

使用 Sidekiq 我们可以选择设置延迟来发送邮件。我们也能通过 Active Job 做同样的事情。

在 Sidekiq 中，以前的发送延迟消息的语法：

UserMailer.delay_for(1.hour).welcome_email(@user.id)
UserMailer.delay_until(5.days.from_now).welcome_email(@user.id)

新的语法通过 Active Job 发送延迟消息：

UserMailer.welcome_email(@user).deliver_later(wait: 1.hour)
UserMailer.welcome_email(@user).deliver_later(wait_until: 10.hours.from_now)

Limitations

ActiveJob 使用全局ID，允许序列化全部的 ActiveRecord 对象作为 #perform 方法的一个参数，结果就是

def perform(user_id)
  user = User.find(user_id)
  user.send_welcome_email!
end

可以被替换为

def perform(user)
  user.send_welcome_email!
end

不幸的是这就意味着如果 User 记录在任务已经进入队列但是 perform 方法被执行之前被删掉了，异常的处理方式会发生变化。对于通常的 Sdiekiq，你可以这样子来处理：

def perform(user_id)
  user = User.find_by(id: user_id)

  if user
    user.send_welcome_email!
  else
    # handle a deleted user record
  end
end

而使用 ActiveJob ，那么 perform(user) 将反而 raise 缺失记录异常作为反序列化 User 实例的一部分。

你可以这样解决这个问题：

class MyJob < ActiveJob::Base
  rescue_from ActiveJob::DeserializationError do |exception|
    # handle a deleted user record
  end

  # ...
end

Job ID

ActiveJob 有自己的 Job ID ，但是这对于 Sidekiq 来说没有意义。在 Rails 5 中，你将能够获得 Sidekiq 的 JID，通过使用 provider_job_id 方法

job = SomeJob.perform_later
jid = job.provider_job_id

Commercial Features

许多 Sidekiq 专业版和商业版的特性，如果你尝试使用 ActiveJob 来利用这些特性那么它们将会以无法预料的方式停止。举个例子，创建一批 ActiveJobs 能在基本情况下运行良好，但是如果在那些任务中使用 ActiveJob 的重试机制将会失败。如有疑问，不要混用 AJ 和 Sidekiq 的原生 APIs