модуль ActiveRecord::Store
Store предоставляет тонкий обертка над serialize для хранения хэшей в одном столбце. Это как простая система хранения ключ/значение, встроенная в вашу запись, когда вам не нужно запрашивать это хранилище вне контекста одной записи.
Затем вы можете объявить аксессоры для этого хранилища, которые доступны так же, как и другие атрибуты модели. Это очень полезно для удобного отображения ключей хранилища в форме или в другом месте, которое уже построено вокруг доступа к атрибутам модели.
Каждый аксессор поставляется с методами отслеживания изменений (key_changed?, key_was и key_change) и методами доступа к изменениям, внесённым во время последней сохранения (saved_change_to_key?, saved_change_to_key и key_before_last_save).
ПРИМЕЧАНИЕ: Метода key_will_change! для аксессоров нет, используйте store_will_change! вместо него.
Убедитесь, что столбец базы данных, используемый для сериализованного хранилища, объявлен как текстовый, чтобы было достаточно места.
Вы можете задать пользовательский кодер для кодирования/декодирования ваших сериализованных атрибутов в/из различных форматов. JSON, YAML, Marshal поддерживаются по умолчанию. В общем случае это может быть любой обертка, которая предоставляет load и dump.
ПРИМЕЧАНИЕ: Если вы используете структурированные типы данных базы данных (например, PostgreSQL hstore/json, или MySQL 5.7+ json) нет необходимости в сериализации, предоставляемой .store. Просто используйте .store_accessor вместо этого для генерации методов аксессоров. Имейте в виду, что эти столбцы используют хэш с ключами-строками и не допускают доступа с использованием символов.
ПРИМЕЧАНИЕ: По умолчанию валидации, за исключением uniqueness, будут работать. Например, если вы хотите проверить uniqueness с помощью hstore, вам нужно будет использовать пользовательскую валидацию для её обработки.
Примеры:
class User < ActiveRecord::Base store :settings, accessors: [ :color, :homepage ], coder: JSON store :parent, accessors: [ :name ], coder: JSON, prefix: true store :spouse, accessors: [ :name ], coder: JSON, prefix: :partner store :settings, accessors: [ :two_factor_auth ], suffix: true store :settings, accessors: [ :login_retry ], suffix: :config end u = User.new(color: 'black', homepage: '37signals.com', parent_name: 'Mary', partner_name: 'Lily') u.color # Accessor stored attribute u.parent_name # Accessor stored attribute with prefix u.partner_name # Accessor stored attribute with custom prefix u.two_factor_auth_settings # Accessor stored attribute with suffix u.login_retry_config # Accessor stored attribute with custom suffix u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor # There is no difference between strings and symbols for accessing custom attributes u.settings[:country] # => 'Denmark' u.settings['country'] # => 'Denmark' # Dirty tracking u.color = 'green' u.color_changed? # => true u.color_was # => 'black' u.color_change # => ['black', 'red'] # Add additional accessors to an existing store through store_accessor class SuperUser < User store_accessor :settings, :privileges, :servants store_accessor :parent, :birthday, prefix: true store_accessor :settings, :secret_question, suffix: :config end
Имена хранимых атрибутов можно получить с помощью .stored_attributes.
User.stored_attributes[:settings] # [:color, :homepage, :two_factor_auth, :login_retry]
Переопределение аксессоров по умолчанию
Все сохраненные значения автоматически доступны через аксессоры объекта Active Record, но иногда вы хотите специализировать это поведение. Это можно сделать, переопределив аксессоры по умолчанию (используя то же имя, что и атрибут) и вызвав super для фактического изменения.
class Song < ActiveRecord::Base
# Uses a stored integer to hold the volume adjustment of the song
store :settings, accessors: [:volume_adjustment]
def volume_adjustment=(decibels)
super(decibels.to_i)
end
def volume_adjustment
super.to_i
end
end
Атрибуты
Приватные методы экземпляра
# File activerecord/lib/active_record/store.rb, line 206 def read_store_attribute(store_attribute, key) # :doc: accessor = store_accessor_for(store_attribute) accessor.read(self, store_attribute, key) end
# File activerecord/lib/active_record/store.rb, line 211 def write_store_attribute(store_attribute, key, value) # :doc: accessor = store_accessor_for(store_attribute) accessor.write(self, store_attribute, key, value) end
© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.