Spec-Zone.ru › Ruby on Rails 5.0

модуль AbstractController::Caching::Fragments

Кэширование фрагментов используется для кэширования различных блоков внутри представлений без кэширования всего действия целиком. Это полезно, когда определенные элементы действия часто изменяются или зависят от сложного состояния, в то время как другие части редко изменяются или могут быть объединены для использования в нескольких местах. Кэширование выполняется с помощью помощника cache доступного в Action View. Смотрите ActionView::Helpers::CacheHelper для получения дополнительной информации.

Хотя настоятельно рекомендуется использовать кэширование с истечением срока действия на основе ключей (см. ссылки в CacheHelper для получения дополнительной информации), также можно вручную истекать кэши. Например:

expire_fragment('name_of_cache')

Открытые методы экземпляра

expire_fragment(key, options = nil) Показать исходный код
# File actionpack/lib/abstract_controller/caching/fragments.rb, line 124
def expire_fragment(key, options = nil)
  return unless cache_configured?
  key = fragment_cache_key(key) unless key.is_a?(Regexp)

  instrument_fragment_cache :expire_fragment, key do
    if key.is_a?(Regexp)
      cache_store.delete_matched(key, options)
    else
      cache_store.delete(key, options)
    end
  end
end

Удаляет фрагменты из кэша.

key может принимать одну из трех форм:

  • Строка - Обычно это путь, например pages/45/notes.

  • Хэш - Обрабатывается как неявный вызов url_for, например { controller: 'pages', action: 'notes', id: 45}

  • Регулярное выражение - Удалит любой фрагмент, который соответствует, поэтому %r{pages/\d*/notes} может удалить все заметки. Убедитесь, что вы не используете якоря в регулярном выражении (^ или $) поскольку фактическое имя файла, которому соответствует, выглядит как ./cache/filename/path.cache. Примечание: истечение срока действия регулярных выражений поддерживается только для кэшей, которые могут итерировать по всем ключам (в отличие от memcached).

options передаётся в метод delete хранилища кэша (или delete_matched, для ключей типа Regexp).

fragment_cache_key(key) Показать исходный код
# File actionpack/lib/abstract_controller/caching/fragments.rb, line 64
def fragment_cache_key(key)
  head = self.class.fragment_cache_keys.map { |k| instance_exec(&k) }
  tail = key.is_a?(Hash) ? url_for(key).split("://").last : key
  ActiveSupport::Cache.expand_cache_key([*head, *tail], :views)
end

Принимая ключ (как описано в expire_fragment), возвращает ключ, подходящий для чтения, записи или истечения срока действия кэшированного фрагмента. Все ключи начинаются с views/, затем идут любые значения префиксов ключей для всего контроллера, заканчиваясь указанным значением key. Ключ расширяется с помощью ActiveSupport::Cache.expand_cache_key.

fragment_exist?(key, options = nil) Показать исходный код
# File actionpack/lib/abstract_controller/caching/fragments.rb, line 97
def fragment_exist?(key, options = nil)
  return unless cache_configured?
  key = fragment_cache_key(key)

  instrument_fragment_cache :exist_fragment?, key do
    cache_store.exist?(key, options)
  end
end

Проверяет, существует ли кэшированный фрагмент из местоположения, обозначенного key (см. expire_fragment для допустимых форматов).

read_fragment(key, options = nil) Показать исходный код
# File actionpack/lib/abstract_controller/caching/fragments.rb, line 85
def read_fragment(key, options = nil)
  return unless cache_configured?

  key = fragment_cache_key(key)
  instrument_fragment_cache :read_fragment, key do
    result = cache_store.read(key, options)
    result.respond_to?(:html_safe) ? result.html_safe : result
  end
end

Читает кэшированный фрагмент из местоположения, обозначенного key (см. expire_fragment для допустимых форматов).

write_fragment(key, content, options = nil) Показать исходный код
# File actionpack/lib/abstract_controller/caching/fragments.rb, line 72
def write_fragment(key, content, options = nil)
  return content unless cache_configured?

  key = fragment_cache_key(key)
  instrument_fragment_cache :write_fragment, key do
    content = content.to_str
    cache_store.write(key, content, options)
  end
  content
end

Записывает content в местоположение, обозначенное key (см. expire_fragment для допустимых форматов).

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API