модуль 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 . Сравните это с ситуацией, когда переопределен метод before_destroy:

class Topic < ActiveRecord::Base
  def before_destroy() destroy_author end
end

class Reply < Topic
  def before_destroy() destroy_readers end
end

В этом случае Reply#destroy вызывался бы только destroy_readers и не destroy_author . Поэтому используйте макросы обработчиков, когда хотите гарантировать, что определенный обработчик вызывается для всей иерархии, и используйте обычные переопределяемые методы, когда хотите предоставить каждому потомку возможность самостоятельно решать, вызывать ли super и запускать унаследованные обработчики.

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

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

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

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

class Topic < ActiveRecord::Base
  before_destroy :delete_parents

  private
    def delete_parents
      self.class.delete_all "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 в данном случае) должен выполняться до удаления потомков опцией 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 потомки недоступны, потому что обработчик 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 , и данные все еще доступны.

Транзакции

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

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

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

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

Чтобы найти все обработчики в цепочке обработак перед сохранением:

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

Возвращает массив объектов обработчиков, составляющих цепочку перед сохранением.

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

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

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

Константы

CALLBACKS