跳至内容 跳至搜索

请参阅 ActiveSupport::Cache::Store 的文档。

命名空间
方法
E
L

常量

DEFAULT_COMPRESS_LIMIT = 1.kilobyte
 
DeserializationError = Class.new(StandardError)
 

当缓存条目无法反序列化时,由 coder 引发。此错误被视为缓存未命中。

OPTION_ALIASES = { expires_in: [:expire_in, :expired_in] }.freeze
 

规范选项名到存储将识别的别名的映射。

UNIVERSAL_OPTIONS = [ :coder, :compress, :compress_threshold, :compressor, :expire_in, :expired_in, :expires_in, :namespace, :race_condition_ttl, :serializer, :skip_nil, :raw, :max_key_size, ]
 

这些选项对所有缓存实现都有意义。单个缓存实现可能支持其他选项。

Attributes

[RW] format_version

类公共方法

expand_cache_key(key, namespace = nil)

key 参数展开为可用于缓存存储的键。可选地接受一个命名空间,所有键都将被限制在该命名空间内。

如果提供的 key 参数是一个数组,或者响应 to_a,那么数组中的每个元素都将被转换为参数/键,并连接成一个单一的键。例如:

ActiveSupport::Cache.expand_cache_key([:foo, :bar])               # => "foo/bar"
ActiveSupport::Cache.expand_cache_key([:foo, :bar], "namespace")  # => "namespace/foo/bar"

key 参数还可以响应 cache_keyto_param

# File activesupport/lib/active_support/cache.rb, line 113
def expand_cache_key(key, namespace = nil)
  expanded_cache_key = namespace ? +"#{namespace}/" : +""

  if prefix = ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"]
    expanded_cache_key << "#{prefix}/"
  end

  expanded_cache_key << retrieve_cache_key(key)
  expanded_cache_key
end

lookup_store(store = nil, *parameters)

根据给定的选项创建一个新的 Store 对象。

如果此方法未传递任何参数,则将返回一个新的 ActiveSupport::Cache::MemoryStore 对象。

如果传递一个 Symbol 作为第一个参数,那么将在 ActiveSupport::Cache 命名空间下创建一个相应的缓存存储类。例如:

ActiveSupport::Cache.lookup_store(:memory_store)
# => returns a new ActiveSupport::Cache::MemoryStore object

ActiveSupport::Cache.lookup_store(:mem_cache_store)
# => returns a new ActiveSupport::Cache::MemCacheStore object

任何额外的参数都将传递给相应的缓存存储类的构造函数。

ActiveSupport::Cache.lookup_store(:file_store, '/tmp/cache')
# => same as: ActiveSupport::Cache::FileStore.new('/tmp/cache')

如果第一个参数不是 Symbol,则它将被原样返回。

ActiveSupport::Cache.lookup_store(MyOwnCacheStore.new)
# => returns MyOwnCacheStore.new
# File activesupport/lib/active_support/cache.rb, line 87
def lookup_store(store = nil, *parameters)
  case store
  when Symbol
    options = parameters.extract_options!
    retrieve_store_class(store).new(*parameters, **options)
  when Array
    lookup_store(*store)
  when nil
    ActiveSupport::Cache::MemoryStore.new
  else
    store
  end
end