Active Jobの基本

$ bin/rails generate job guests_cleanup
invoke  test_unit
create    test/jobs/guests_cleanup_job_test.rb
create  app/jobs/guests_cleanup_job.rb

$ bin/rails generate job guests_cleanup --queue urgent

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  def perform(*guests)
    # 何かしらの処理
  end
end

$ bin/rails generate job process_payment --parent=payment_job

class ProcessPaymentJob < PaymentJob
  queue_as :default

  def perform(*args)
    # 何かしらの処理
  end
end

# キューが空くとすぐに実行されるようにジョブをエンキューします。
GuestsCleanupJob.perform_later guest

# 明日の正午に実行されるようにジョブをエンキューします。
GuestsCleanupJob.set(wait_until: Date.tomorrow.noon).perform_later(guest)

# 1週間後に実行されるようにジョブをエンキューします。
GuestsCleanupJob.set(wait: 1.week).perform_later(guest)

# `perform_now`と`perform_later`は内部で`perform`を呼び出すため、
# 後者で定義されている引数の数だけ引数を渡すことができます。
GuestsCleanupJob.perform_later(guest1, guest2, filter: 'some_filter')

# config/application.rb
module YourApp
  class Application < Rails::Application
    # アダプタのgemがGemfileにあることを確認し、
    # アダプタの特定のインストールとデプロイ手順に従ってください。
    config.active_job.queue_adapter = :sidekiq
  end
end

class GuestsCleanupJob < ApplicationJob
  self.queue_adapter = :resque
  # ...
end

# これでジョブは、`config.active_job.queue_adapter`で設定されたものを上書きして、
# `resque`をバックエンドキューアダプタとして使用します。

class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# config/application.rb
module YourApp
  class Application < Rails::Application
    config.active_job.queue_name_prefix = Rails.env
  end
end

# app/jobs/guests_cleanup_job.rb
class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# これで、ジョブは本番環境のproduction_low_priorityキューで実行され、ステージング環境のstaging_low_priorityキューで実行されます。

class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  self.queue_name_prefix = nil
  # ...
end

# これで、ジョブのキュー名にはプレフィックスが付かず、`config.active_job.queue_name_prefix`で設定された内容を上書きします。

# config/application.rb
module YourApp
  class Application < Rails::Application
    config.active_job.queue_name_prefix = Rails.env
    config.active_job.queue_name_delimiter = '.'
  end
end

# app/jobs/guests_cleanup_job.rb
class GuestsCleanupJob < ApplicationJob
  queue_as :low_priority
  # ...
end

# これで、ジョブは本番環境のproduction.low_priorityキューで実行され、ステージング環境のstaging.low_priorityキューで実行されます。

MyJob.set(queue: :another_queue).perform_later(record)

class ProcessVideoJob < ApplicationJob
  queue_as do
    video = self.arguments.first
    if video.owner.premium?
      :premium_videojobs
    else
      :videojobs
    end
  end

  def perform(video)
    # 動画の処理を行う
  end
end

ProcessVideoJob.perform_later(Video.last)

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  around_perform :around_cleanup

  def perform
    # 後で何かを行う
  end

  private
    def around_cleanup
      # performの前に何かを行う
      yield
      # performの後に何かを行う
    end
end

class ApplicationJob < ActiveJob::Base
  before_enqueue { |job| $statsd.increment "#{job.class.name.underscore}.enqueue" }
end

# メールを即時に送信する場合は#deliver_nowを使用します
UserMailer.welcome(@user).deliver_now

# Active Jobを介してメールを送信する場合は#deliver_laterを使用します
UserMailer.welcome(@user).deliver_later

I18n.locale = :eo

UserMailer.welcome(@user).deliver_later # メールはエスペラント語にローカライズされます。

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

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

# app/serializers/money_serializer.rb
class MoneySerializer < ActiveJob::Serializers::ObjectSerializer
  # このシリアライザで引数をシリアライズする必要があるかどうかをチェックします。
  def serialize?(argument)
    argument.is_a? Money
  end

  # サポートされるオブジェクトタイプを使用して、オブジェクトをよりシンプルな表現に変換します。
  # 推奨される表現は、特定のキーを持つハッシュです。キーは基本的なタイプのみにする必要があります。
  # カスタムシリアライザタイプをハッシュに追加するために`super`を呼び出す必要があります。
  def serialize(money)
    super(
      "amount" => money.amount,
      "currency" => money.currency
    )
  end

  # シリアライズされた値を適切なオブジェクトに変換します。
  def deserialize(hash)
    Money.new(hash["amount"], hash["currency"])
  end
end

# config/initializers/custom_serializers.rb
Rails.application.config.active_job.custom_serializers << MoneySerializer

# config/application.rb
module YourApp
  class Application < Rails::Application
    config.autoload_once_paths << Rails.root.join('app', 'serializers')
  end
end

class GuestsCleanupJob < ApplicationJob
  queue_as :default

  rescue_from(ActiveRecord::RecordNotFound) do |exception|
    # 例外を処理する
  end

  def perform
    # 何かを後で実行する
  end
end

class RemoteServiceJob < ApplicationJob
  retry_on CustomAppException # デフォルトでは3秒待機、5回の試行

  discard_on ActiveJob::DeserializationError

  def perform(*args)
    # CustomAppExceptionまたはActiveJob::DeserializationErrorが発生する可能性があります
  end
end