модуль 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, все последующие обработчики и связанное действие отменяются. Обработчики Callbacks, как правило, выполняются в порядке их определения, за исключением обработчиков, определённых как методы модели, которые вызываются последними.

Порядок выполнения обработчиков

Иногда код приложения требует, чтобы обработчики выполнялись в определённом порядке. Например, обработчик 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. То же самое относится ко всем не транзакционным обработчикам.

Как показано ниже, в случае нескольких транзакционных обработчиков порядок меняется.

Например:

class Topic < ActiveRecord::Base
  has_many :children

  after_commit :log_children
  after_commit :do_something_else

  private

  def log_children
    # Child processing
  end

  def do_something_else
    # Something else
  end
end

В данном случае обработчик 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