跳至内容 跳至搜索

Active Job Core

提供将包含在从 ActiveJob::Base 继承的每个 Active Job 对象中的常规行为。

命名空间
方法
D
N
S

属性

[RW] arguments

作业参数
[RW] enqueue_error

跟踪后端引发的任何异常，以便调用方可以检查错误。
[RW] enqueued_at

跟踪作业入队的时间
[RW] exception_executions

散列，其中包含此作业为每个特定 retry_on 声明处理错误的次数。键是 retry_on 声明中列出的异常的字符串表示形式，而其关联值保存了相应 retry_on 声明处理其列出的异常之一的执行次数。
[RW] executions

此作业已执行的次数（每次重试都会增加，例如异常之后）。
[RW] job_id

作业标识符
[RW] locale

作业期间要使用的 I18n.locale。
[W] priority

作业将具有的优先级（较低表示优先级较高）。
[RW] provider_job_id

适配器可选提供的 ID
[W] queue_name

作业将驻留的队列。
[R] scheduled_at

时间，表示应执行作业的时间
[W] serialized_arguments
[RW] timezone

作业期间要使用的时区。

类公共方法

new(*arguments)

创建一个新的作业实例。获取将传递给 perform 方法的参数。

源代码： 显示 | 在 GitHub 上 

# File activejob/lib/active_job/core.rb, line 95
def initialize(*arguments)
  @arguments  = arguments
  @job_id     = SecureRandom.uuid
  @queue_name = self.class.queue_name
  @scheduled_at = nil
  @_scheduled_at_time = nil
  @priority   = self.class.priority
  @executions = 0
  @exception_executions = {}
  @timezone   = Time.zone&.name
end

实例公共方法

deserialize(job_data)

将存储的作业数据附加到当前实例。接收从 serialize 返回的哈希

示例

class DeliverWebhookJob < ActiveJob::Base
  attr_writer :attempt_number

  def attempt_number
    @attempt_number ||= 0
  end

  def serialize
    super.merge('attempt_number' => attempt_number + 1)
  end

  def deserialize(job_data)
    super
    self.attempt_number = job_data['attempt_number']
  end

  rescue_from(Timeout::Error) do |exception|
    raise exception if attempt_number > 5
    retry_job(wait: 10)
  end
end

源代码：显示 | 在 GitHub 上 

# File activejob/lib/active_job/core.rb, line 153
def deserialize(job_data)
  self.job_id               = job_data["job_id"]
  self.provider_job_id      = job_data["provider_job_id"]
  self.queue_name           = job_data["queue_name"]
  self.priority             = job_data["priority"]
  self.serialized_arguments = job_data["arguments"]
  self.executions           = job_data["executions"]
  self.exception_executions = job_data["exception_executions"]
  self.locale               = job_data["locale"] || I18n.locale.to_s
  self.timezone             = job_data["timezone"] || Time.zone&.name
  self.enqueued_at          = Time.iso8601(job_data["enqueued_at"]) if job_data["enqueued_at"]
  self.scheduled_at         = Time.iso8601(job_data["scheduled_at"]) if job_data["scheduled_at"]
end

scheduled_at=(value)

源代码：显示 | 在 GitHub 上 

# File activejob/lib/active_job/core.rb, line 177
    def scheduled_at=(value)
      @_scheduled_at_time = if value&.is_a?(Numeric)
        ActiveJob.deprecator.warn(<<~MSG.squish)
          Assigning a numeric/epoch value to scheduled_at is deprecated. Use a Time object instead.
        MSG
        Time.at(value)
      else
        value
      end
      @scheduled_at = value
    end

serialize()

返回一个哈希，其中包含可以安全传递给排队适配器的作业数据。

源代码：显示 | 在 GitHub 上 

# File activejob/lib/active_job/core.rb, line 110
def serialize
  {
    "job_class"  => self.class.name,
    "job_id"     => job_id,
    "provider_job_id" => provider_job_id,
    "queue_name" => queue_name,
    "priority"   => priority,
    "arguments"  => serialize_arguments_if_needed(arguments),
    "executions" => executions,
    "exception_executions" => exception_executions,
    "locale"     => I18n.locale.to_s,
    "timezone"   => timezone,
    "enqueued_at" => Time.now.utc.iso8601(9),
    "scheduled_at" => _scheduled_at_time ? _scheduled_at_time.utc.iso8601(9) : nil,
  }
end

successfully_enqueued?()

源代码：显示 | 在 GitHub 上 

# File activejob/lib/active_job/core.rb, line 53
def successfully_enqueued?
  @successfully_enqueued
end