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 вместо пар класс/идентификатор, которые раньше приходилось десериализовывать вручную. Раньше задачи выглядели так:

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.

Обратите внимание: мы не принимаем запросы на слияние с новыми адаптерами и активно выносим существующие адаптеры в отдельные проекты. Мы рекомендуем авторам библиотек добавлять адаптер Active Job в состав своего гема или выпускать его как отдельный гем.

Продолжения

Продолжения позволяют прерывать задачи и возобновлять их выполнение. Подробнее см. в разделе ActiveJob::Continuation.

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

Последнюю версию 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

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

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