cn.omisheep.authz.core.cache

接口 Cache

所有已知实现类:

DefaultCache, L2Cache

public interface Cache

从以下版本开始:

1.0.0

作者:

zhouxinchen[1269670415@qq.com]

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	Cache.CacheExpiry 默认的cache缓存的过期删除策略
static class	Cache.CacheItem<E>

字段概要

字段

限定符和类型	字段和说明
static String	ALL
static String	EMPTY
static long	INFINITE
static long	INHERIT
static String	SEPARATOR

方法概要

限定符和类型	方法和说明
default @NonNull Map<String,Cache.CacheItem>	asMap()
void	del(@NonNull Set<String> keys)
default void	del(String... keys)
void	del(@NonNull String key)
@NonNull Map<String,Object>	get(Set<String> keys)
<T> @NonNull Map<String,T>	get(@NonNull Set<String> keys, @NonNull Class<T> requiredType)
@Nullable Object	get(String key) 得到对应key的值
default <T> T	get(@NonNull String key, @NonNull Class<T> requiredType) 得到对应key的值
default @NonNull Map<String,Object>	getByPattern(@NonNull String pattern)
default <T> @NonNull Map<String,T>	getByPattern(@NonNull String pattern, @NonNull Class<T> requiredType)
@NonNull Set<String>	keys(@NonNull String pattern)
default @NonNull Set<String>	keysAndLoad(String pattern) 返回匹配的key同时将对应的object加载进缓存
default List<Object>	listByPattern(@NonNull String pattern)
default <T> List<T>	listByPattern(@NonNull String pattern, @NonNull Class<T> requiredType)
boolean	notKey(@NonNull String key)
default void	receive(@NonNull CacheMessage message)
default void	reload()
default void	reload(Collection<String>... keys)
default void	reload(String... keys)
default <E> void	set(@NonNull String key, E element) 注意，在这里添加缓存时，如果原key存在过期时间，当再次添加同key的值时，不会清空之前的ttl
<E> void	set(@NonNull String key, E element, long ttl)
default <E> void	set(@NonNull String key, E element, long number, @NonNull TimeUnit unit)
default <E> void	set(@NonNull String key, E element, @NonNull String ttl)
default <E> void	setSneaky(@NonNull String key, E element, long ttl)
default <E> void	setSneaky(@NonNull String key, E element, long number, @NonNull TimeUnit unit)
long	ttl(@NonNull String key) 获取key的过期时间。

字段详细资料

ALL

static final String ALL

另请参阅:

常量字段值

EMPTY

static final String EMPTY

另请参阅:

常量字段值

SEPARATOR

static final String SEPARATOR

另请参阅:

常量字段值

INFINITE

static final long INFINITE

另请参阅:

常量字段值

INHERIT

static final long INHERIT

另请参阅:

常量字段值

方法详细资料

keys

@NonNull Set<String> keys(@NonNull String pattern)

参数:

pattern - redis 风格的匹配

返回:

匹配上的key

keysAndLoad

default @NonNull Set<String> keysAndLoad(String pattern)

返回匹配的key同时将对应的object加载进缓存

参数:

pattern - redis 风格的匹配

返回:

匹配上的key

notKey

boolean notKey(@NonNull String key)

参数:

key - key

返回:

如果没有这个key，返回true

ttl

long ttl(@NonNull String key)

获取key的过期时间。如果key存在过期时间，返回剩余生存时间(秒)；

如果key是永久的，返回-1；

如果key不存在或者已过期，返回-2。

参数:

key - key

返回:

ttl 秒

set

<E> void set(@NonNull String key,
             E element,
             long ttl)

类型参数:

E - 值的类型

参数:

key - 键

element - 值

ttl - 秒，为-1时将继承之前的key的ttl , INFINITE 为永久存在

setSneaky

default <E> void setSneaky(@NonNull String key,
                           E element,
                           long ttl)

类型参数:

E - 值的类型

参数:

key - 键

element - 值

ttl - 秒，为-1时将继承之前的key的ttl , INFINITE 为永久存在

set

default <E> void set(@NonNull String key,
                     E element)

注意，在这里添加缓存时，如果原key存在过期时间，当再次添加同key的值时，不会清空之前的ttl

类型参数:

E - Type

参数:

key - 键

element - 值

set

default <E> void set(@NonNull String key,
                     E element,
                     long number,
                     @NonNull TimeUnit unit)

类型参数:

E - 值的类型

参数:

key - 键

element - 值

number - 存活的时间数值

unit - 存活的时间单位

setSneaky

default <E> void setSneaky(@NonNull String key,
                           E element,
                           long number,
                           @NonNull TimeUnit unit)

类型参数:

E - 值的类型

参数:

key - 键

element - 值

number - 存活的时间数值

unit - 存活的时间单位

set

default <E> void set(@NonNull String key,
                     E element,
                     @NonNull String ttl)

类型参数:

E - 值的类型

参数:

key - 键

element - 值

ttl - 存活的时间 "字符串类型" example：1s、10s、1m、2d

get

@Nullable Object get(String key)

得到对应key的值

参数:

key - key

返回:

value

get

default <T> T get(@NonNull String key,
                  @NonNull Class<T> requiredType)

得到对应key的值

类型参数:

T - 需要转换的类型

参数:

key - key

requiredType - 需要转换的类型

返回:

value

getByPattern

default @NonNull Map<String,Object> getByPattern(@NonNull String pattern)

getByPattern

default <T> @NonNull Map<String,T> getByPattern(@NonNull String pattern,
                                                @NonNull Class<T> requiredType)

listByPattern

default List<Object> listByPattern(@NonNull String pattern)

listByPattern

default <T> List<T> listByPattern(@NonNull String pattern,
                                  @NonNull Class<T> requiredType)

get

@NonNull Map<String,Object> get(Set<String> keys)

参数:

keys - keys

返回:

返回keys的所有值

get

<T> @NonNull Map<String,T> get(@NonNull Set<String> keys,
                               @NonNull Class<T> requiredType)

类型参数:

T - 需要转换的类型

参数:

keys - keys

requiredType - 需要转换的类型

返回:

values

del

void del(@NonNull String key)

参数:

key - 需要删除的key

del

void del(@NonNull Set<String> keys)

参数:

keys - keys

del

default void del(String... keys)

asMap

default @NonNull Map<String,Cache.CacheItem> asMap()

receive

default void receive(@NonNull CacheMessage message)

reload

default void reload()

reload

default void reload(String... keys)

reload

default void reload(Collection<String>... keys)