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)

# 將一個工作排隊，以便在一周後執行。
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
    # 確保在你的 Gemfile 中有適配器的 gem，
    # 並遵循適配器的特定安裝和部署說明。
    config.active_job.queue_adapter = :sidekiq
  end
end

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

# 現在你的工作將使用 `resque` 作為其後端排隊適配器，覆蓋了在 `config.active_job.queue_adapter` 中配置的設置。

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
      # 在執行之前執行某些操作
      yield
      # 在執行之後執行某些操作
    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

  # 使用支援的物件類型將物件轉換為較簡單的表示形式。
  # 推薦的表示形式是具有特定鍵的 Hash。鍵只能是基本類型。
  # 您應該調用 `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