Sidekiq 与 ActiveJob 的关系

文章原文地址: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 的功能:

  1. 可视化网页(Retries 选项卡将会是空)
  2. 你不能使用 Sidekiq::RetrySet 的 API 来进行重试任务
  3. Sidekiq 的 日期将不会包含任务错误或回溯
  4. 错误将不会被报告给Sidekiq的全局错误处理函数
  5. 你将无法使用一些与 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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,444评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,421评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,363评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,460评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,502评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,511评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,280评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,736评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,014评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,190评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,848评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,531评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,159评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,411评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,067评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,078评论 2 352

推荐阅读更多精彩内容