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 в качестве части их драгоценного камня или как самостоятельный драгоценный камень. Обсуждение этого можно найти в следующих PR: 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