модуль ActiveRecord::Callbacks

Включенные модули:: ActiveModel::Validations::Callbacks

Обработчики Active Record

Обработчики — это крючки в жизненном цикле объекта Active Record, которые позволяют запускать логику до или после изменения состояния объекта. Это можно использовать, чтобы убедиться, что связанные и зависимые объекты удаляются при вызове ActiveRecord::Base#destroy (переопределением before_destroy) или чтобы обработать атрибуты перед валидацией (переопределением before_validation). В качестве примера обработчиков, инициированных вызовом ActiveRecord::Base#save для нового записы, рассмотрим:

(-) save
(-) valid
(1) before_validation
(-) validate
(2) after_validation
(3) before_save
(4) before_create
(-) create
(5) after_create
(6) after_save
(7) after_commit

Также, обработчик after_rollback может быть настроен для запуска всякий раз, когда выполняется откат. Подробнее о after_commit и after_rollback см. ActiveRecord::Transactions.

Кроме того, обработчик after_touch запускается всякий раз, когда объект изменяется.

Наконец, обработчик after_find и after_initialize запускается для каждого объекта, который находит и инициализирует поиск, при этом after_initialize запускается после инициализации новых объектов.

Всего существует девятнадцать обработчиков, которые предоставляют значительный контроль над реакцией и подготовкой к каждому этапу жизненного цикла Active Record. Последовательность вызовов ActiveRecord::Base#save для существующей записи аналогична, за исключением того, что каждый обработчик _create заменяется соответствующим обработчиком _update.

Примеры:

class CreditCard < ActiveRecord::Base
  # Strip everything but digits, so the user can specify "555 234 34" or
  # "5552-3434" and both will mean "55523434"
  before_validation(on: :create) do
    self.number = number.gsub(/[^0-9]/, "") if attribute_present?("number")
  end
end

class Subscription < ActiveRecord::Base
  before_create :record_signup

  private
    def record_signup
      self.signed_up_on = Date.today
    end
end

class Firm < ActiveRecord::Base
  # Disables access to the system, for associated clients and people when the firm is destroyed
  before_destroy { |record| Person.where(firm_id: record.id).update_all(access: 'disabled')   }
  before_destroy { |record| Client.where(client_of: record.id).update_all(access: 'disabled') }
end

Наследуемые очереди обработчиков

Помимо переопределяемых методов обработчиков, также можно регистрировать обработчики с помощью макросов обработчиков. Их основное преимущество состоит в том, что макросы добавляют поведение в очередь обработчиков, которая сохраняется в иерархии наследования.

class Topic < ActiveRecord::Base
  before_destroy :destroy_author
end

class Reply < Topic
  before_destroy :destroy_readers
end

Когда выполняется Topic#destroy, вызывается только destroy_author. Когда выполняется Reply#destroy, вызываются оба destroy_author и destroy_readers.

ВАЖНО: Для работы наследования для очередей обработчиков необходимо указать обработчики до указания ассоциаций. В противном случае вы можете вызвать загрузку дочернего элемента до того, как родительский элемент зарегистрирует обработчики, и они не будут унаследованы.

Типы обработчиков

Существует три типа обработчиков, принимаемых макросами обработчиков: ссылки на методы (символы), объекты обработчиков, встроенные методы (с использованием блока). Ссылки на методы и объекты обработчиков рекомендуются, встроенные методы с использованием блока иногда подходят (например, для создания плагинов).

Обработчики со ссылками на методы работают путем указания защищенного или частного метода, доступного в объекте, как это:

class Topic < ActiveRecord::Base
  before_destroy :delete_parents

  private
    def delete_parents
      self.class.delete_by(parent_id: id)
    end
end

Объекты обработчиков имеют методы, названные по имени вызываемого обработчика с записью в качестве единственного параметра, например:

class BankAccount < ActiveRecord::Base
  before_save      EncryptionWrapper.new
  after_save       EncryptionWrapper.new
  after_initialize EncryptionWrapper.new
end

class EncryptionWrapper
  def before_save(record)
    record.credit_card_number = encrypt(record.credit_card_number)
  end

  def after_save(record)
    record.credit_card_number = decrypt(record.credit_card_number)
  end

  alias_method :after_initialize, :after_save

  private
    def encrypt(value)
      # Secrecy is committed
    end

    def decrypt(value)
      # Secrecy is unveiled
    end
end

Таким образом, вы указываете объект, которому вы хотите отправить сообщение при определённом обработчике. Когда запускается этот обработчик, у объекта есть метод с именем отправленного сообщения. Вы можете сделать эти обработчики более гибкими, передавая дополнительную начальную информацию, такую как имя атрибута, с которым нужно работать:

class BankAccount < ActiveRecord::Base
  before_save      EncryptionWrapper.new("credit_card_number")
  after_save       EncryptionWrapper.new("credit_card_number")
  after_initialize EncryptionWrapper.new("credit_card_number")
end

class EncryptionWrapper
  def initialize(attribute)
    @attribute = attribute
  end

  def before_save(record)
    record.send("#{@attribute}=", encrypt(record.send("#{@attribute}")))
  end

  def after_save(record)
    record.send("#{@attribute}=", decrypt(record.send("#{@attribute}")))
  end

  alias_method :after_initialize, :after_save

  private
    def encrypt(value)
      # Secrecy is committed
    end

    def decrypt(value)
      # Secrecy is unveiled
    end
end

`before_validation*` возвращающие утверждения

Если обработчик before_validation генерирует :abort, процесс будет прерван, и ActiveRecord::Base#save вернёт false. Если вызов ActiveRecord::Base#save!, будет генерироваться исключение ActiveRecord::RecordInvalid. Ничего не будет добавлено к объекту ошибок.

Отмена обработчиков

Если обработчик before_* генерирует :abort, все последующие обработчики и связанное действие отменяются. Обработчики обычно выполняются в порядке их определения, за исключением обработчиков, определенных как методы модели, которые вызываются последними.

Порядок обработки

Иногда в прикладном коде требуется, чтобы обработчики выполнялись в определённом порядке. Например, обработчик before_destroy (log_children в данном случае) должен выполняться до того, как записи в ассоциации children уничтожаются с помощью параметра dependent: :destroy.

Рассмотрим следующий код:

class Topic < ActiveRecord::Base
  has_many :children, dependent: :destroy

  before_destroy :log_children

  private
    def log_children
      # Child processing
    end
end

В этом случае проблема заключается в том, что когда выполняется обработчик before_destroy, записи в ассоциации children уже не существуют, потому что обработчик ActiveRecord::Base#destroy выполняется раньше. Для предотвращения этого можно использовать параметр prepend в обработчике before_destroy.

class Topic < ActiveRecord::Base
  has_many :children, dependent: :destroy

  before_destroy :log_children, prepend: true

  private
    def log_children
      # Child processing
    end
end

Таким образом, обработчик before_destroy выполняется до вызова dependent: :destroy, и данные по-прежнему доступны.

Также существуют случаи, когда необходимо, чтобы несколько обработчиков одного типа выполнялись в определенном порядке.

Например:

class Topic < ActiveRecord::Base
  has_many :children

  after_save :log_children
  after_save :do_something_else

  private
    def log_children
      # Child processing
    end

    def do_something_else
      # Something else
    end
end

В этом случае обработчик log_children выполняется до do_something_else. Это относится ко всем нетранзакционным обработчикам и к before_commit.

Для транзакционных обработчиков after_ (after_commit, after_rollback и т. д.) порядок можно установить с помощью конфигурации.

config.active_record.run_after_transaction_callbacks_in_order_defined = false

Если установлено значение true (по умолчанию с Rails 7.1), обработчики выполняются в порядке их определения, как в примере выше. Если установлено значение false, порядок обратный, то есть do_something_else выполняется до log_children.

Транзакции

Весь цепочку обработчиков для вызова #save, #save! или #destroy выполняется в рамках транзакции. Это включает в себя и after_* обработчики. Если всё пройдёт успешно, COMMIT выполняется после завершения цепочки.

Если обработчик before_* отменяет действие, выполняется ROLLBACK. Также можно вызвать ROLLBACK, сгенерировав исключение в любом обработчике, включая и after_* обработчики. Однако в этом случае клиент должен знать об этом, так как обычный вызов #save сгенерирует такое исключение вместо того, чтобы тихо вернуть false.

Отладка обработчиков

Цепочка обработчиков доступна через метод _*_callbacks объекта. Обработчики Active Model поддерживают :before, :after и :around в качестве значений для свойства kind. Свойство kind определяет, в какой части цепочки выполняется обработчик.

Для поиска всех обработчиков в цепочке обработчиков before_save:

Topic._save_callbacks.select { |cb| cb.kind.eql?(:before) }

Возвращает массив объектов обработчиков, которые образуют цепочку before_save.

Чтобы далее проверить, содержит ли цепочка `before_save` блок, определённый как rest_when_dead, используйте свойство filter объекта обработчика:

Topic._save_callbacks.select { |cb| cb.kind.eql?(:before) }.collect(&:filter).include?(:rest_when_dead)

Возвращает true или false в зависимости от того, содержится ли блок в цепочке обработчиков before_save модели Topic.

Константы

CALLBACKS