класс ActiveSupport::Cache::RedisCacheStore

Родитель:: ActiveSupport::Cache::Store

Хранилище кэша Redis.

Примечание по развертыванию: используйте *отдельное хранилище кэша Redis*, а не указывайте на ваш существующий сервер Redis. Оно не справится со смешанными шаблонами использования, и оно по умолчанию не будет удалять кэшированные записи.

Руководство по настройке сервера Redis: redis.io/topics/lru-cache

Поддерживает обычный Redis, hiredis и Redis::Distributed.
Поддерживает фрагментацию, подобную Memcached, по Redises с Redis::Distributed.
Устойчивое к сбоям. Если сервер Redis недоступен, не генерируются исключения. Получение из кэша Cache — все промахи, а записи отбрасываются.
Локальный кэш. Быстрый первичный кэш в оперативной памяти в пределах блока/средства.
read_multi и write_multi поддержка для Redis mget/mset. Используйте Redis::Distributed 4.0.1+ для поддержки распределённого mget.
delete_matched поддержка для Redis KEYS-глобов.

Константы

DEFAULT_ERROR_HANDLER
DEFAULT_REDIS_OPTIONS
MAX_KEY_BYTESIZE: Ключи усекаются с собственным SHA2-дайджестом, если их длина превышает 1 КБ

Атрибуты

max_key_bytesize[R]

redis_options[R]

Открытые методы класса

new(namespace: nil, compress: true, compress_threshold: 1.kilobyte, expires_in: nil, race_condition_ttl: nil, error_handler: DEFAULT_ERROR_HANDLER, **redis_options) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 174
def initialize(namespace: nil, compress: true, compress_threshold: 1.kilobyte, expires_in: nil, race_condition_ttl: nil, error_handler: DEFAULT_ERROR_HANDLER, **redis_options)
  @redis_options = redis_options

  @max_key_bytesize = MAX_KEY_BYTESIZE
  @error_handler = error_handler

  super namespace: namespace,
    compress: compress, compress_threshold: compress_threshold,
    expires_in: expires_in, race_condition_ttl: race_condition_ttl
end

Создаёт новое хранилище кэша Redis.

Обрабатывает три варианта: блок, предоставленный для инициализации, предоставленный URL и предоставленные несколько URL.

:redis Proc   -> options[:redis].call
:url   String -> Redis.new(url: …)
:url   Array  -> Redis::Distributed.new([{ url: … }, { url: … }, …])

Пространство имён по умолчанию не установлено. Укажите его, если сервер Redis используется совместно с другими приложениями: <tt>namespace: 'myapp-cache'<tt>.

Сжатие включено по умолчанию с порогом 1 КБ, поэтому кэшированные значения, превышающие 1 КБ, автоматически сжимаются. Отключите, передав compress: false, или измените порог, передав compress_threshold: 4.kilobytes.

По умолчанию срок действия кэшированных записей не задан. Ожидается, что Redis настроен с политикой удаления, которая автоматически удаляет ключи с наименьшим или наименее частым использованием, когда достигается максимальный объём памяти. См. redis.io/topics/lru-cache для настройки сервера кэша.

Значение TTL для гонок по умолчанию не задано. Это можно использовать для предотвращения «толпы» записей в кэш, когда кэшированные записи с высоким уровнем спроса истекают. См. ActiveSupport::Cache::Store#fetch для получения дополнительной информации.

Вызывает метод суперкласса ActiveSupport::Cache::Store.new

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

cleanup(options = nil) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 287
def cleanup(options = nil)
  super
end

Реализация API Cache Store.

Удаляет истекшие записи. Обрабатывается непосредственно политикой Redis для истечения кэша с наименьшим или наименее частым использованием, поэтому ручная очистка не поддерживается.

Вызывает метод суперкласса ActiveSupport::Cache::Store#cleanup

clear(options = nil) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 295
def clear(options = nil)
  failsafe :clear do
    if namespace = merged_options(options)[:namespace]
      delete_matched "*", namespace: namespace
    else
      redis.with { |c| c.flushdb }
    end
  end
end

Очищает весь кэш на всех серверах Redis. Безопасно использовать на общих серверах, если кэш имеет пространство имён.

Защита от сбоев: Вызывает ошибки.

decrement(name, amount = 1, options = nil) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 275
def decrement(name, amount = 1, options = nil)
  instrument :decrement, name, amount: amount do
    failsafe :decrement do
      redis.with { |c| c.decrby normalize_key(name, options), amount }
    end
  end
end

Реализация API Cache Store.

Уменьшает кэшированное значение. Этот метод использует атомарный оператор Redis decr и может быть использован только для значений, записанных с опцией :raw. Вызов его для значения, не сохранённого с :raw, инициализирует это значение нулём.

Защита от сбоев: Вызывает ошибки.

delete_matched(matcher, options = nil) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 234
def delete_matched(matcher, options = nil)
  instrument :delete_matched, matcher do
    unless String === matcher
      raise ArgumentError, "Only Redis glob strings are supported: #{matcher.inspect}"
    end
    redis.with do |c|
      pattern = namespace_key(matcher, options)
      cursor = "0"
      # Fetch keys in batches using SCAN to avoid blocking the Redis server.
      begin
        cursor, keys = c.scan(cursor, match: pattern, count: SCAN_BATCH_SIZE)
        c.del(*keys) unless keys.empty?
      end until cursor == "0"
    end
  end
end

Реализация API Cache Store.

Поддерживает шаблоны glob Redis KEYS:

h?llo matches hello, hallo and hxllo
h*llo matches hllo and heeeello
h[ae]llo matches hello and hallo, but not hillo
h[^e]llo matches hallo, hbllo, ... but not hello
h[a-b]llo matches hallo and hbllo

Используйте \ для экранирования специальных символов, если вы хотите их сопоставить буквально.

См. redis.io/commands/KEYS для получения дополнительной информации.

Защита от сбоев: Вызывает ошибки.

increment(name, amount = 1, options = nil) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 259
def increment(name, amount = 1, options = nil)
  instrument :increment, name, amount: amount do
    failsafe :increment do
      redis.with { |c| c.incrby normalize_key(name, options), amount }
    end
  end
end

Реализация API Cache Store.

Увеличивает кэшированное значение. Этот метод использует атомарный оператор Redis incr и может быть использован только для значений, записанных с опцией :raw. Вызов его для значения, не сохранённого с :raw, инициализирует это значение нулём.

Защита от сбоев: Вызывает ошибки.

inspect() Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 198
def inspect
  instance = @redis || @redis_options
  "<##{self.class} options=#{options.inspect} redis=#{instance.inspect}>"
end

read_multi(*names) Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 207
def read_multi(*names)
  if mget_capable?
    instrument(:read_multi, names, options) do |payload|
      read_multi_mget(*names).tap do |results|
        payload[:hits] = results.keys
      end
    end
  else
    super
  end
end

Реализация API Cache Store.

Чтение нескольких значений одновременно. Возвращает хеш запрошенных ключей -> полученных значений.

Вызывает метод суперкласса ActiveSupport::Cache::Store#read_multi

redis() Показать исходный код

# File activesupport/lib/active_support/cache/redis_cache_store.rb, line 185
def redis
  @redis ||= begin
    pool_options = self.class.send(:retrieve_pool_options, redis_options)

    if pool_options.any?
      self.class.send(:ensure_connection_pool_added!)
      ::ConnectionPool.new(pool_options) { self.class.build_redis(**redis_options) }
    else
      self.class.build_redis(**redis_options)
    end
  end
end