bee.cloud.cache

接口 Cache

public interface Cache

功能说明：缓存操作接口

1) String(字符串)操作

可以对单个字符串进行存、取、删除、设置过期日期操作。

2) Hash(哈希表)操作

作者:

chenxiang 2014-10-7

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	Cache.Key 系统缓存框架使用到的key
static interface	Cache.RMessageListener 消息监听器
static interface	Cache.RSet set集合无序不重复
static class	Cache.Scan<T>
static interface	Cache.Stack 列表队列

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	_DSNAME
static java.lang.String	_PKNAME
static java.lang.String	_TABLENAME
static java.lang.String	_TYPE
static java.lang.String	CACHE
static java.lang.String	KEY_LASTUPDATE
static java.lang.String	KEY_SPLIT KEY的分隔符，默认为英文冒号“:”
static java.lang.String	KEY_TABLE_CLASS
static java.lang.String	KEY_TABLE_OTHKEY
static java.lang.String	KEY_TABLEKEY
static java.lang.String	PUBLICCACHE 公共缓存分组（public），系统保留字段
static java.lang.String	USERCACHE 存放用户登陆信息的CACHE分组（user）

方法概要

限定符和类型	方法和说明
void	close() 用完后记得关闭通道
boolean	connected() 是否连接
int	count(java.lang.String pattern) 统计有多少KEY
void	del(java.util.Set<java.lang.String> keys) 删除给定的一个或多个 key，不存在的 key 会被忽略。
void	del(java.lang.String... keys) 删除给定的一个或多个 key，不存在的 key 会被忽略。
void	dels(java.lang.String pattern) 根据前缀删除对应的key
boolean	exists(java.lang.String key) 检查给定 key 是否存在。
void	expire(java.lang.String key, java.util.Date date) 为给定 key 设置生存时间，当 key 过期时(生存时间到了指定的日期后 )，它会被自动删除。
void	expire(java.lang.String key, long seconds) 为给定 key 设置生存时间，当 key 过期时(生存时间为 0 )，它会被自动删除。
void	flush() 刷新数据，并同将内存中的数据存盘
java.lang.String	get(java.lang.String key) 返回 key 所关联的字符串值。
<T> java.lang.String	getCacheKey(T t) 通过PK生成缓存KEY
<T> java.lang.String	getCacheKeyPrefix(java.lang.Class<T> clazz) 获取表的缓存KEY前缀
java.lang.String	getCacheKeyPrefix(java.lang.String datasource, java.lang.String tableName) 获取表的缓存KEY前缀
int	getIndex() 获取数据库索引，从0开始
Cache.RSet	getRSet(java.lang.String key) 获取一个set集合无序不重复
java.util.Map<java.lang.String,java.lang.String>	gets(java.util.Set<java.lang.String> keys) 返回 key 所关联的字符串值。
Cache.Stack	getStack() 获取一个堆栈，系统根据调用路径生成KEY
Cache.Stack	getStack(java.lang.String key) 获取一个堆栈
void	hdel(java.lang.String key, java.util.Set<java.lang.String> fields) 删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。
void	hdel(java.lang.String key, java.lang.String... fields) 删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。
boolean	hexists(java.lang.String key, java.lang.String field) 查看哈希表 key 中，给定域 field 是否存在。
java.lang.String	hget(java.lang.String key, java.lang.String field) 返回哈希表 key 中给定域 field 的值。
java.util.Map<java.lang.String,java.lang.String>	hgetAll(java.lang.String key) 返回哈希表 key 中，所有的域field和值。
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	hgets(java.util.Set<java.lang.String> key, java.util.Set<java.lang.String> field) 返回哈希表 key 中给定域 field 的值。
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	hgets(java.util.Set<java.lang.String> key, java.lang.String... field) 返回哈希表 key 中给定域 field 的值。
Cache.Scan<java.util.Map<java.lang.String,java.lang.String>>	hgets(java.lang.String key, long cursor, int count) 分批获取Hash列表
java.util.Map<java.lang.String,java.lang.String>	hgets(java.lang.String key, java.util.Set<java.lang.String> field) 返回哈希表 key 中给定域 field 的值。
java.util.Map<java.lang.String,java.lang.String>	hgets(java.lang.String key, java.lang.String... field) 返回哈希表 key 中给定域 field 的值。
<T> T	hgetTable(java.lang.String key) 返回哈希表 key 中，所有的域field和值。
<T> T	hgetTable(java.lang.String key, java.lang.Class<T> clazz) 返回哈希表 key 中，所有的域field和值。
long	hincrBy(java.lang.String key, java.lang.String field) 为哈希表 key 中的域 field 的值加1 。
long	hincrBy(java.lang.String key, java.lang.String field, long value) 为哈希表 key 中的域 field 的值加上增量 increment 。
java.util.Set<java.lang.String>	hkeys(java.lang.String key) 返回哈希表 key 中的所有域field。
long	hlen(java.lang.String key) 返回哈希表 key 中域的数量。
void	hset(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> values) 将哈希表 key 中的域 field 的值设为 value 。
void	hset(java.lang.String key, java.lang.String field, java.lang.String value) 将哈希表 key 中的域 field 的值设为 value 。
<T> void	hset(java.lang.String key, T table) 将哈希表 key 中的域 field 的值设为 table 。
<T> void	hset(T table) 通过tablename缓存Table表， 存储的KEY键为：<dsname:tablename:pkvalue, Table>
long	incr(java.lang.String key) 将 key 中储存的数字值增一。
long	incr(java.lang.String key, long increment) 将 key 所储存的值加上增量 increment 。
java.util.Set<java.lang.String>	keys(java.lang.String pattern) 查找所有符合给定模式 pattern 的 key 。
Cache.Scan<java.util.Set<java.lang.String>>	keys(java.lang.String pattern, long cursor, int count) * 查找所有符合给定模式 pattern 的 key 。
long	llen(java.lang.String key) 返回key类型为list的数量
java.lang.String	lpop(java.lang.String key) 从key中从左边pop一个值
long	lpush(java.lang.String key, java.util.List<java.lang.String> val) 从左边push值到指定的key中
long	lpush(java.lang.String key, java.lang.String... val) 从左边push值到指定的key中
void	persist(java.lang.String key) 为给定 key 撤消设置生存的时间
void	publish(bee.cloud.cache.MsgData message) Redis发送消息
java.lang.String	rpop(java.lang.String key) 从key中从右边pop一个值
long	rpush(java.lang.String key, java.util.List<java.lang.String> val) 从右边push值到指定的key中
long	rpush(java.lang.String key, java.lang.String... val) 从右边push值到指定的key中
void	set(java.lang.String key, java.lang.String value) 将字符串值 value 关联到 key 。
void	set(java.lang.String key, java.lang.String value, long seconds) 将值 value 关联到 key ，并将 key 的生存时间设为 seconds (以秒为单位)。
void	subscriber(Cache.RMessageListener listener, java.lang.String... channel) Redis接收消息
long	ttl(java.lang.String key) ttl key 查看还有多少秒过期，-1表示永不过期，-2表示已过期 （联合演示）
java.lang.String	type(java.lang.String key) 获取key对应的类型，String,List,Set,Zset,Hash

字段详细资料

CACHE

static final java.lang.String CACHE

另请参阅:

常量字段值

USERCACHE

static final java.lang.String USERCACHE

存放用户登陆信息的CACHE分组（user）

另请参阅:

常量字段值

PUBLICCACHE

static final java.lang.String PUBLICCACHE

公共缓存分组（public），系统保留字段

另请参阅:

常量字段值

KEY_SPLIT

static final java.lang.String KEY_SPLIT

KEY的分隔符，默认为英文冒号“:”

另请参阅:

常量字段值

_TABLENAME

static final java.lang.String _TABLENAME

另请参阅:

常量字段值

_DSNAME

static final java.lang.String _DSNAME

另请参阅:

常量字段值

_TYPE

static final java.lang.String _TYPE

另请参阅:

常量字段值

_PKNAME

static final java.lang.String _PKNAME

另请参阅:

常量字段值

KEY_TABLEKEY

static final java.lang.String KEY_TABLEKEY

另请参阅:

常量字段值

KEY_TABLE_OTHKEY

static final java.lang.String KEY_TABLE_OTHKEY

另请参阅:

常量字段值

KEY_LASTUPDATE

static final java.lang.String KEY_LASTUPDATE

另请参阅:

常量字段值

KEY_TABLE_CLASS

static final java.lang.String KEY_TABLE_CLASS

另请参阅:

常量字段值

方法详细资料

connected

boolean connected()

是否连接

返回:

-true：已经连接，false：未连接

get

java.lang.String get(java.lang.String key)

返回 key 所关联的字符串值。 如果 key 不存在那么返回特殊值 null 。

参数:

key - -

返回:

当 key 不存在时，返回 null ，否则，返回 key 的值。

getIndex

int getIndex()

获取数据库索引，从0开始

返回:

int

gets

java.util.Map<java.lang.String,java.lang.String> gets(java.util.Set<java.lang.String> keys)

返回 key 所关联的字符串值。 如果 key 不存在那么返回特殊值 null 。

参数:

keys - -

返回:

当 key 不存在时，返回 null ，否则，返回 key 的值。

keys

java.util.Set<java.lang.String> keys(java.lang.String pattern)

查找所有符合给定模式 pattern 的 key 。
KEYS * 匹配数据库中所有 key 。
KEYS h?llo 匹配 hello ， hallo 和 hxllo 等。
KEYS h*llo 匹配 hllo 和 heeeeello 等。
KEYS h[ae]llo 匹配 hello 和 hallo ，但不匹配 hillo 。
特殊符号用 \ 隔开
注意 KEYS 的速度非常快，但在一个大的数据库中使用它仍然可能造成性能问题。 建议分批查询，使用方法，keys(String pattern,int start,int count);

参数:

pattern - -

返回:

符合给定模式的 key 列表。

keys

Cache.Scan<java.util.Set<java.lang.String>> keys(java.lang.String pattern,
                                                 long cursor,
                                                 int count)

* 查找所有符合给定模式 pattern 的 key 。
KEYS * 匹配数据库中所有 key 。
KEYS h?llo 匹配 hello ， hallo 和 hxllo 等。
KEYS h*llo 匹配 hllo 和 heeeeello 等。
KEYS h[ae]llo 匹配 hello 和 hallo ，但不匹配 hillo 。
特殊符号用 \ 隔开

参数:

pattern - -key的表达式

cursor - -开始位置，也称游标，默认为0表示首次获取，首次获取会返回下一次的游标，

count - -每页取多少数量，默认取1000条

返回:

-

hgets

Cache.Scan<java.util.Map<java.lang.String,java.lang.String>> hgets(java.lang.String key,
                                                                   long cursor,
                                                                   int count)

分批获取Hash列表

参数:

key - -

cursor - 开始位置，也称游标，默认为0表示首次获取，首次获取会返回下一次的游标，

count - 每页取多少数量，默认取1000条

返回:

-

type

java.lang.String type(java.lang.String key)

获取key对应的类型，String,List,Set,Zset,Hash

参数:

key - -

返回:

-

ttl

long ttl(java.lang.String key)

ttl key 查看还有多少秒过期，-1表示永不过期，-2表示已过期 （联合演示）

参数:

key - -

返回:

-

count

int count(java.lang.String pattern)

统计有多少KEY

参数:

pattern - -

返回:

-

set

void set(java.lang.String key,
         java.lang.String value)

将字符串值 value 关联到 key 。
如果 key 已经持有其他值， SET 就覆写旧值，无视类型。

参数:

key - -

value - -

set

void set(java.lang.String key,
         java.lang.String value,
         long seconds)

将值 value 关联到 key ，并将 key 的生存时间设为 seconds (以秒为单位)。
如果 key 已经存在， 将覆写旧值。

参数:

key - -

value - -

seconds - -生存时间，单位（秒）

del

void del(java.lang.String... keys)

删除给定的一个或多个 key，不存在的 key 会被忽略。

时间复杂度：

O(N)， N 为被删除的 key 的数量。
删除单个字符串类型的 key ，时间复杂度为O(1)。
删除单个列表、集合、有序集合或哈希表类型的 key ，时间复杂度为O(M)， M 为以上数据结构内的元素数量。

参数:

keys - -

del

void del(java.util.Set<java.lang.String> keys)

删除给定的一个或多个 key，不存在的 key 会被忽略。

时间复杂度：

O(N)， N 为被删除的 key 的数量。
删除单个字符串类型的 key ，时间复杂度为O(1)。
删除单个列表、集合、有序集合或哈希表类型的 key ，时间复杂度为O(M)， M 为以上数据结构内的元素数量。

参数:

keys - -

dels

void dels(java.lang.String pattern)

根据前缀删除对应的key

参数:

pattern - -

exists

boolean exists(java.lang.String key)

检查给定 key 是否存在。

参数:

key - - -

返回:

若 key 存在，返回 true ，否则返回 false 。

expire

void expire(java.lang.String key,
            long seconds)

为给定 key 设置生存时间，当 key 过期时(生存时间为 0 )，它会被自动删除。

参数:

key - -

seconds - - -生存时间，单位（秒）

expire

void expire(java.lang.String key,
            java.util.Date date)

为给定 key 设置生存时间，当 key 过期时(生存时间到了指定的日期后 )，它会被自动删除。

参数:

key - -

date - -生成到期日期

persist

void persist(java.lang.String key)

为给定 key 撤消设置生存的时间

参数:

key - -

incr

long incr(java.lang.String key)

将 key 中储存的数字值增一。
如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 INCR 操作。
如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误。
本操作的值限制在 64 位(bit)有符号数字表示之内。

参数:

key - -

返回:

执行 INCR 命令之后 key 的值。

incr

long incr(java.lang.String key,
          long increment)

将 key 所储存的值加上增量 increment 。
如果 key 不存在，那么 key 的值会先被初始化为 0 ，然后再执行 INCRBY 命令。
如果值包含错误的类型，或字符串类型的值不能表示为数字，那么返回一个错误。
本操作的值限制在 64 位(bit)有符号数字表示之内。

参数:

key - -

increment - -

返回:

加上 increment 之后， key 的值。

hkeys

java.util.Set<java.lang.String> hkeys(java.lang.String key)

返回哈希表 key 中的所有域field。

参数:

key - -

返回:

一个包含哈希表中所有域field的表。
当 key 不存在时，返回一个空表。

hexists

boolean hexists(java.lang.String key,
                java.lang.String field)

查看哈希表 key 中，给定域 field 是否存在。

参数:

key - -

field - -

返回:

如果哈希表含有给定域，返回 true 。
如果哈希表不含有给定域，或 key 不存在，返回 false 。

hgetAll

java.util.Map<java.lang.String,java.lang.String> hgetAll(java.lang.String key)

返回哈希表 key 中，所有的域field和值。

参数:

key - -

返回:

以列表形式返回哈希表的域和域的值。
若 key 不存在，返回空Map。

hgetTable

<T> T hgetTable(java.lang.String key)

返回哈希表 key 中，所有的域field和值。

类型参数:

T - -

参数:

key - -

返回:

以列表形式返回哈希表的域和域的值。
若 key 不存在，返回空null。

hgetTable

<T> T hgetTable(java.lang.String key,
                java.lang.Class<T> clazz)

返回哈希表 key 中，所有的域field和值。

类型参数:

T - -

参数:

key - -

clazz - -转为指定的类型

返回:

以列表形式返回哈希表的域和域的值。
若 key 不存在，返回空null。

hget

java.lang.String hget(java.lang.String key,
                      java.lang.String field)

返回哈希表 key 中给定域 field 的值。

参数:

key - -

field - -

返回:

给定域的值。 当给定域不存在或是给定 key 不存在时，返回 nil 。

hgets

java.util.Map<java.lang.String,java.lang.String> hgets(java.lang.String key,
                                                       java.lang.String... field)

返回哈希表 key 中给定域 field 的值。

参数:

key - -

field - -

返回:

给定域的值集Map。 当给定域不存在或是给定 key 不存在时，返回 nil 。

hgets

java.util.Map<java.lang.String,java.lang.String> hgets(java.lang.String key,
                                                       java.util.Set<java.lang.String> field)

返回哈希表 key 中给定域 field 的值。

参数:

key - -

field - -

返回:

给定域的值集Map。 当给定域不存在或是给定 key 不存在时，返回 nil 。

hgets

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> hgets(java.util.Set<java.lang.String> key,
                                                                                       java.lang.String... field)

返回哈希表 key 中给定域 field 的值。

参数:

key - -

field - -

返回:

给定域的值集Map。 当给定域不存在或是给定 key 不存在时，返回 nil 。

hgets

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> hgets(java.util.Set<java.lang.String> key,
                                                                                       java.util.Set<java.lang.String> field)

返回哈希表 key 中给定域 field 的值。

参数:

key - -

field - -

返回:

给定域的值集Map。 当给定域不存在或是给定 key 不存在时，返回 nil 。

hset

void hset(java.lang.String key,
          java.util.Map<java.lang.String,java.lang.String> values)

将哈希表 key 中的域 field 的值设为 value 。
如果 key 不存在，一个新的哈希表被创建并进行 HSET 操作。
如果域 field 已经存在于哈希表中，旧值将被覆盖。

参数:

key - -

values - -

hset

<T> void hset(java.lang.String key,
              T table)

将哈希表 key 中的域 field 的值设为 table 。
如果 key 不存在，一个新的哈希表被创建并进行 HSET 操作。
如果域 field 已经存在于哈希表中，旧值将被覆盖。

类型参数:

T - -

参数:

key - -

table - -

hset

<T> void hset(T table)

通过tablename缓存Table表， 存储的KEY键为：<dsname:tablename:pkvalue, Table>

类型参数:

T - -

参数:

table - -

getCacheKey

<T> java.lang.String getCacheKey(T t)

通过PK生成缓存KEY

类型参数:

T - -

参数:

t - -

返回:

-

getCacheKeyPrefix

<T> java.lang.String getCacheKeyPrefix(java.lang.Class<T> clazz)

获取表的缓存KEY前缀

类型参数:

T - -

参数:

clazz - -

返回:

datasource:tableName:*

getCacheKeyPrefix

java.lang.String getCacheKeyPrefix(java.lang.String datasource,
                                   java.lang.String tableName)

获取表的缓存KEY前缀

参数:

datasource - 数据源名称

tableName - 数据库表名称

返回:

datasource:tableName:*

hset

void hset(java.lang.String key,
          java.lang.String field,
          java.lang.String value)

将哈希表 key 中的域 field 的值设为 value 。
如果 key 不存在，一个新的哈希表被创建并进行 HSET 操作。
如果域 field 已经存在于哈希表中，旧值将被覆盖。

参数:

key - -

field - -

value - -

hdel

void hdel(java.lang.String key,
          java.lang.String... fields)

删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。

参数:

key - -

fields - -

hdel

void hdel(java.lang.String key,
          java.util.Set<java.lang.String> fields)

删除哈希表 key 中的一个或多个指定域，不存在的域将被忽略。

参数:

key - -

fields - -

hincrBy

long hincrBy(java.lang.String key,
             java.lang.String field,
             long value)

为哈希表 key 中的域 field 的值加上增量 increment 。
增量也可以为负数，相当于对给定域进行减法操作。
如果 key 不存在，一个新的哈希表被创建并执行 HINCRBY 命令。
如果域 field 不存在，那么在执行命令前，域的值被初始化为 0 。
对一个储存字符串值的域 field 执行 HINCRBY 命令将造成一个错误。
本操作的值被限制在 64 位(bit)有符号数字表示之内。

参数:

key - -

field - -

value - -

返回:

执行 HINCRBY 命令之后，哈希表 key 中域 field 的值。

hincrBy

long hincrBy(java.lang.String key,
             java.lang.String field)

为哈希表 key 中的域 field 的值加1 。
如果 key 不存在，一个新的哈希表被创建并执行 HINCRBY 命令。
如果域 field 不存在，那么在执行命令前，域的值被初始化为 0 。
对一个储存字符串值的域 field 执行 HINCRBY 命令将造成一个错误。

参数:

key - -

field - -

返回:

执行 HINCRBY 命令之后，哈希表 key 中域 field 的值。

hlen

long hlen(java.lang.String key)

返回哈希表 key 中域的数量。

参数:

key - -

返回:

哈希表中域的数量。
当 key 不存在时，返回 0 。

getStack

Cache.Stack getStack()

获取一个堆栈，系统根据调用路径生成KEY

返回:

Stack

getStack

Cache.Stack getStack(java.lang.String key)

获取一个堆栈

参数:

key - -

返回:

Stack

getRSet

Cache.RSet getRSet(java.lang.String key)

获取一个set集合无序不重复

参数:

key - -

返回:

-

llen

long llen(java.lang.String key)

返回key类型为list的数量

参数:

key - -

返回:

list中的数量

lpop

java.lang.String lpop(java.lang.String key)

从key中从左边pop一个值

参数:

key - -

返回:

-

lpush

long lpush(java.lang.String key,
           java.lang.String... val)

从左边push值到指定的key中

参数:

key - -

val - -

返回:

-

lpush

long lpush(java.lang.String key,
           java.util.List<java.lang.String> val)

从左边push值到指定的key中

参数:

key - -

val - -

返回:

-

rpop

java.lang.String rpop(java.lang.String key)

从key中从右边pop一个值

参数:

key - -

返回:

-

rpush

long rpush(java.lang.String key,
           java.lang.String... val)

从右边push值到指定的key中

参数:

key - -

val - -

返回:

-

rpush

long rpush(java.lang.String key,
           java.util.List<java.lang.String> val)

从右边push值到指定的key中

参数:

key - -

val - -

返回:

-

close

void close()

用完后记得关闭通道

flush

void flush()

刷新数据，并同将内存中的数据存盘

publish

void publish(bee.cloud.cache.MsgData message)

Redis发送消息

参数:

message - -消息内容

subscriber

void subscriber(Cache.RMessageListener listener,
                java.lang.String... channel)

Redis接收消息

参数:

listener - -消息监听器

channel - -通道名称