Active Job – Выполнять работу позже

Active Job — это фреймворк для объявления задач и их выполнения в различных очередях. Эти задачи могут включать всё, от плановых задач очистки до выставления счетов и рассылки почты — всё, что можно разделить на небольшие единицы работы и выполнять параллельно.

Он также используется в качестве бэкенда для функциональности deliver_later в Action Mailer, что позволяет легко преобразовывать любую рассылку в задачу для выполнения позже. Это одна из наиболее распространённых задач в современных веб-приложениях: отправка электронных писем вне цикла запросов и ответов, чтобы пользователь не ждал.

Главная цель — обеспечить наличие инфраструктуры для задач во всех приложениях Rails, даже если это «непосредственный исполнитель». Затем на этой основе могут быть построены функции фреймворка и другие драгоценности, не беспокоясь о различиях API между Delayed Job и Resque. Выбор бэкенда очереди становится операционной проблемой. И вы сможете переключаться между ними, не переписывая свои задачи.

Подробнее о Active Job можно прочитать в руководстве Основы Active Job.

Использование

Чтобы узнать, как использовать предпочитаемый вами бэкенд очереди, ознакомьтесь с документацией его адаптера по адресу ActiveJob::QueueAdapters.

Объявите задачу следующим образом:

class MyJob < ActiveJob::Base
  queue_as :my_jobs

  def perform(record)
    record.do_work
  end
end

Добавьте задачу в очередь следующим образом:

MyJob.perform_later record  # Enqueue a job to be performed as soon as the queuing system is free.

MyJob.set(wait_until: Date.tomorrow.noon).perform_later(record)  # Enqueue a job to be performed tomorrow at noon.

MyJob.set(wait: 1.week).perform_later(record) # Enqueue a job to be performed 1 week from now.

Всё!

Поддержка GlobalID

Active Job поддерживает сериализацию GlobalID для параметров. Это позволяет передавать реальные объекты Active Record в вашу задачу вместо пар «класс/id», которые затем необходимо вручную десериализовать. Раньше задачи выглядели так:

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

Теперь вы можете просто сделать так:

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

Это работает с любым классом, в который включена GlobalID::Identification, которая по умолчанию включена в классы Active Record.

Поддерживаемые системы очередей

Active Job имеет встроенные адаптеры для нескольких бэкендов очереди (Sidekiq, Resque, Delayed Job и другие). Чтобы получить актуальный список адаптеров, ознакомьтесь с документацией API для ActiveJob::QueueAdapters.

Обратите внимание: Мы не принимаем запросы на новые адаптеры. Мы рекомендуем авторам библиотек предоставлять адаптер ActiveJob в составе своего драгоценного камня или как самостоятельный драгоценный камень. Обсуждение этого можно найти в следующих запросах на изменение: 23311, 21406 и #32285.

Загрузка и установка

Последнюю версию Active Job можно установить с помощью RubyGems:

$ gem install activejob

Исходный код можно загрузить как часть проекта Rails на GitHub:

• github.com/rails/rails/tree/main/activejob

Лицензия

Active Job распространяется по лицензии MIT:

• opensource.org/licenses/MIT

Поддержка

Документация API находится по адресу:

• api.rubyonrails.org

Отчёты об ошибках для проекта Ruby on Rails можно подать здесь:

• github.com/rails/rails/issues

Предложения по новым функциям следует обсудить на почтовой рассылке rails-core по этому адресу:

• discuss.rubyonrails.org/c/rubyonrails-core