RedisAPI (Java SDK API Reference for AWS PaaS)

类型参数:

K -

V -

所有超级接口:

java.lang.AutoCloseable, java.io.Closeable
```
public interface RedisAPI<K,V>
extends java.io.Closeable
```
非byte[]类型通过serializer/keySerializer/valueSerializer/hashKeySerializer/hashValueSerializer，系统提供了StringSerializer/Jdkerializer和工具类SerializationUtils
支持的日志操作：restore, dump, execute, delete, expire, keys, hasKey, getExpire, rename, renameIfAbsent, sort, randomKey, persist, expireAt
支持的审计操作：put, delete, set, rename, persist, expireAt

方法概要

所有方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`void`	`close()` 关闭相关连接资源
`default long`	`delete(java.util.Collection<K> keys)` 已过时。
`default long`	`delete(K key)` 已过时。
`default void`	`discard()` 已过时。
`default byte[]`	`dump(K key)` Retrieve serialized version of the value stored at `key`.
`default <T> T`	`execute(<any> action)` 已过时。
`default java.lang.Boolean`	`expire(K key, long timeout, java.util.concurrent.TimeUnit unit)` 已过时。
`default java.lang.Boolean`	`expireAt(K key, java.util.Date date)` 已过时。
`default BaseRedisCommands`	`getBaseRedisCommands()` redisCommands
`default StatefulConnection`	`getConnect()`
`default java.lang.Long`	`getExpire(K key)` 已过时。
`default java.lang.Long`	`getExpire(K key, java.util.concurrent.TimeUnit timeUnit)` 已过时。
`default <any>`	`getHashKeySerializer()` 已过时。
`default <any>`	`getHashValueSerializer()` 已过时。
`default <any>`	`getKeySerializer()` 已过时。
`default <any>`	`getValueSerializer()` 已过时。
`default HashCommandOps`	`hashCommandOps()` hashCommandOps
`default java.lang.Boolean`	`hasKey(K key)` 已过时。
`default HyperLogLogCommandOps`	`hyperLogLogCommand()` hyperLogLogCommand
`default KeyCommandOps`	`keyCommand()` keyCommand
`default java.util.Set<K>`	`keys(K pattern)` 已过时。
`default ListCommandOps`	`listCommandOps()` listCommandOps
`default void`	`multi()` 已过时。
`default <HK,HV> <any>`	`opsForHash()` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.hashCommandOps() method on the connection
`default <any>`	`opsForList()` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.listCommandOps() method on the connection
`default <any>`	`opsForSet()` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.setCommands() method on the connection
`default <any>`	`opsForValue()` 已过时。
`default <any>`	`opsForZSet()` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.sortedSetCommands() method on the connection
`default <HK,HV> <any>`	`opsHash(K key)` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.hashCommandOps() method on the connection
`default <any>`	`opsList(K key)` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.listCommandOps() method on the connection
`default <any>`	`opsSet(K key)` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.setCommands() method on the connection
`default <any>`	`opsValue(K key)` 已过时。 use #replicas(Object) instead.
`default <any>`	`opsZSet(K key)` 已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.sortedSetCommands() method on the connection
`default java.lang.Boolean`	`persist(K key)` 已过时。
`default java.lang.String`	`ping()`
`default K`	`randomKey()` 已过时。
`default RedisAdvancedClusterCommands`	`redisAdvancedClusterCommands()` redisCommands
`default RedisCommands`	`redisCommands()` redisCommands
`default void`	`rename(K oldKey, K newKey)` 已过时。
`default java.lang.Boolean`	`renameIfAbsent(K oldKey, K newKey)` 已过时。
`default void`	`restore(K key, byte[] value, long timeToLive, java.util.concurrent.TimeUnit unit)` 已过时。
`default RedisAPI<K,V>`	`serializer(<any> defSerializer)` 已过时。
`default RedisAPI<K,V>`	`serializer(<any> keySerializer, <any> valueSerializer)` 已过时。
`default RedisAPI<K,V>`	`serializer(<any> keySerializer, <any> valueSerializer, <any> hashKeySerializer, <any> hashValueSerializer)` 设置key，value，hashKey，hashValue Serializer
`default SetCommandOps`	`setCommands()` setCommands
`default java.util.List<V>`	`sort(<any> query)` 已过时。
`default <T> java.util.List<T>`	`sort(<any> query, <any> resultSerializer)` 已过时。
`default <T> java.util.List<T>`	`sort(<any> query, <any> bulkMapper)` 已过时。
`default <T,S> java.util.List<T>`	`sort(<any> query, <any> bulkMapper, <any> resultSerializer)` 已过时。
`default java.lang.Long`	`sort(<any> query, K storeKey)` 已过时。
`default SortedSetCommandOps`	`sortedSetCommands()` sortedSetCommands
`default StringCommandOps`	`stringCommandOps()` stringCommandOps
`default void`	`unwatch()` 已过时。
`default void`	`watch(java.util.Collection<K> keys)` 已过时。
`default void`	`watch(K key)` 已过时。

- 方法详细资料
  - close
```
void close()
```
    关闭相关连接资源
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    指定者:
    
    close 在接口中 java.io.Closeable
  - dump
```
default byte[] dump(K key)
```
    Retrieve serialized version of the value stored at key.
    
    参数:
    
    key - must not be null.
    
    另请参阅:
    
    Redis Documentation: DUMP
  - restore
```
@Deprecated
default void restore(K key,
                                  byte[] value,
                                  long timeToLive,
                                  java.util.concurrent.TimeUnit unit)
```
    已过时。
    
    Create key using the serializedValue, previously obtained using dump(Object).
    
    参数:
    
    key - must not be null.
    
    value - must not be null.
    
    timeToLive -
    
    unit - must not be null.
    
    另请参阅:
    
    Redis Documentation: RESTORE
  - getKeySerializer
```
@Deprecated
default <any> getKeySerializer()
```
    已过时。
    
    返回:
    
    the key Serializer.
  - getValueSerializer
```
@Deprecated
default <any> getValueSerializer()
```
    已过时。
    
    返回:
    
    the value Serializer.
  - getHashKeySerializer
```
@Deprecated
default <any> getHashKeySerializer()
```
    已过时。
    
    返回:
    
    the hash key Serializer.
  - getHashValueSerializer
```
@Deprecated
default <any> getHashValueSerializer()
```
    已过时。
    
    返回:
    
    the hash value Serializer.
  - opsForValue
```
@Deprecated
default <any> opsForValue()
```
    已过时。
    
    Returns the operations performed on simple values (or Strings in Redis terminology).
    
    返回:
    
    value operations
  - opsForSet
```
@Deprecated
default <any> opsForSet()
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.setCommands() method on the connection
    
    Returns the operations performed on set values.
    
    返回:
    
    set operations
  - opsForZSet
```
@Deprecated
default <any> opsForZSet()
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.sortedSetCommands() method on the connection
    
    Returns the operations performed on zset values (also known as sorted sets).
    
    返回:
    
    zset operations
  - opsForList
```
@Deprecated
default <any> opsForList()
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.listCommandOps() method on the connection
    
    Returns the operations performed on list values.
    
    返回:
    
    list operations
  - opsForHash
```
@Deprecated
default <HK,HV> <any> opsForHash()
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.hashCommandOps() method on the connection
    
    Returns the operations performed on hash values.
    
    类型参数:
    
    HK - hash key (or field) type
    
    HV - hash value type
    
    返回:
    
    hash operations
  - opsHash
```
@Deprecated
default <HK,HV> <any> opsHash(K key)
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.hashCommandOps() method on the connection
    
    Returns the operations performed on hash values bound to the given key.
    
    类型参数:
    
    HK - hash key (or field) type
    
    HV - hash value type
    
    参数:
    
    key - Redis key
    
    返回:
    
    hash operations bound to the given key.
  - opsList
```
@Deprecated
default <any> opsList(K key)
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.listCommandOps() method on the connection
    
    Returns the operations performed on list values bound to the given key.
    
    参数:
    
    key - Redis key
    
    返回:
    
    list operations bound to the given key
  - opsSet
```
@Deprecated
default <any> opsSet(K key)
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.setCommands() method on the connection
    
    Returns the operations performed on set values bound to the given key.
    
    参数:
    
    key - Redis key
    
    返回:
    
    set operations bound to the given key
  - opsValue
```
@Deprecated
default <any> opsValue(K key)
```
    已过时。 use #replicas(Object) instead.
    
    Returns the operations performed on simple values (or Strings in Redis terminology) bound to the given key.
    
    参数:
    
    key - Redis key
    
    返回:
    
    value operations bound to the given key
  - opsZSet
```
@Deprecated
default <any> opsZSet(K key)
```
    已过时。 Use the corresponding @link com.actionsoft.sdk.local.api.cc.RedisAPI.sortedSetCommands() method on the connection
    
    Returns the operations performed on zset values (also known as sorted sets) bound to the given key.
    
    参数:
    
    key - Redis key
    
    返回:
    
    zset operations bound to the given key.
  - execute
```
@Deprecated
default <T> T execute(<any> action)
```
    已过时。
    
    执行含有RedisConnection对象的回调方法
  - delete
```
@Deprecated
default long delete(K key)
```
    已过时。
    
    Delete given key.
    
    参数:
    
    key - must not be null.
    
    返回:
    
    The number of keys that were removed.
    
    另请参阅:
    
    Redis Documentation: DEL
  - delete
```
@Deprecated
default long delete(java.util.Collection<K> keys)
```
    已过时。
    
    Delete given keys.
    
    参数:
    
    keys - must not be null.
    
    返回:
    
    The number of keys that were removed.
    
    另请参阅:
    
    Redis Documentation: DEL
  - expire
```
@Deprecated
default java.lang.Boolean expire(K key,
                                              long timeout,
                                              java.util.concurrent.TimeUnit unit)
```
    已过时。
    
    Set time to live for given key..
    
    参数:
    
    key - must not be null.
    
    timeout - 超时时间值
    
    unit - must not be null.
  - expireAt
```
@Deprecated
default java.lang.Boolean expireAt(K key,
                                                java.util.Date date)
```
    已过时。
    
    Set the expiration for given key as a date timestamp.
    
    参数:
    
    key - must not be null.
    
    date - must not be null.
  - persist
```
@Deprecated
default java.lang.Boolean persist(K key)
```
    已过时。
    
    Remove the expiration from given key.
    
    参数:
    
    key - must not be null.
    
    另请参阅:
    
    Redis Documentation: PERSIST
  - getExpire
```
@Deprecated
default java.lang.Long getExpire(K key)
```
    已过时。
    
    Get the time to live for key in seconds.
    
    参数:
    
    key - must not be null.
    
    另请参阅:
    
    Redis Documentation: TTL
  - getExpire
```
@Deprecated
default java.lang.Long getExpire(K key,
                                              java.util.concurrent.TimeUnit timeUnit)
```
    已过时。
    
    Get the time to live for key in and convert it to the given TimeUnit.
    
    参数:
    
    key - must not be null.
    
    timeUnit - must not be null.
  - hasKey
```
@Deprecated
default java.lang.Boolean hasKey(K key)
```
    已过时。
    
    Determine if given key exists.
    
    参数:
    
    key - must not be null.
    
    另请参阅:
    
    Redis Documentation: EXISTS
  - keys
```
@Deprecated
default java.util.Set<K> keys(K pattern)
```
    已过时。
    
    Find all keys matching the given pattern.
    
    参数:
    
    pattern - must not be null.
    
    另请参阅:
    
    Redis Documentation: KEYS
  - randomKey
```
@Deprecated
default K randomKey()
```
    已过时。
    
    Return a random key from the keyspace.
    
    另请参阅:
    
    Redis Documentation: RANDOMKEY
  - rename
```
@Deprecated
default void rename(K oldKey,
                                 K newKey)
```
    已过时。
    
    Rename key oldKey to newKey.
    
    参数:
    
    oldKey - must not be null.
    
    newKey - must not be null.
    
    另请参阅:
    
    Redis Documentation: RENAME
  - renameIfAbsent
```
@Deprecated
default java.lang.Boolean renameIfAbsent(K oldKey,
                                                      K newKey)
```
    已过时。
    
    Rename key oleName to newKey only if newKey does not exist.
    
    参数:
    
    oldKey - must not be null.
    
    newKey - must not be null.
    
    另请参阅:
    
    Redis Documentation: RENAMENX
  - sort
```
@Deprecated
default java.util.List<V> sort(<any> query)
```
    已过时。
    
    Sort the elements for query.
    
    参数:
    
    query - must not be null.
    
    返回:
    
    the results of sort.
    
    另请参阅:
    
    Redis Documentation: SORT
  - sort
```
@Deprecated
default <T> java.util.List<T> sort(<any> query,
                                                <any> resultSerializer)
```
    已过时。
    
    Sort the elements for query applying Serializer.
    
    参数:
    
    query - must not be null.
    
    返回:
    
    the deserialized results of sort.
    
    另请参阅:
    
    Redis Documentation: SORT
  - sort
```
@Deprecated
default <T> java.util.List<T> sort(<any> query,
                                                <any> bulkMapper)
```
    已过时。
    
    Sort the elements for query applying BulkMapper.
    
    参数:
    
    query - must not be null.
    
    返回:
    
    the deserialized results of sort.
    
    另请参阅:
    
    Redis Documentation: SORT
  - sort
```
@Deprecated
default <T,S> java.util.List<T> sort(<any> query,
                                                  <any> bulkMapper,
                                                  <any> resultSerializer)
```
    已过时。
    
    Sort the elements for query applying BulkMapper and Serializer.
    
    参数:
    
    query - must not be null.
    
    返回:
    
    the deserialized results of sort.
    
    另请参阅:
    
    Redis Documentation: SORT
  - sort
```
@Deprecated
default java.lang.Long sort(<any> query,
                                         K storeKey)
```
    已过时。
    
    Sort the elements for query and store result in storeKey.
    
    参数:
    
    query - must not be null.
    
    storeKey - must not be null.
    
    返回:
    
    number of values.
    
    另请参阅:
    
    Redis Documentation: SORT
  - watch
```
@Deprecated
default void watch(K key)
```
    已过时。
    
    Watch given key for modifications during transaction started with multi().
    
    参数:
    
    key - must not be null.
    
    另请参阅:
    
    Redis Documentation: WATCH
  - watch
```
@Deprecated
default void watch(java.util.Collection<K> keys)
```
    已过时。
    
    Watch given keys for modifications during transaction started with multi().
    
    参数:
    
    keys - must not be null.
    
    另请参阅:
    
    Redis Documentation: WATCH
  - unwatch
```
@Deprecated
default void unwatch()
```
    已过时。
    
    Flushes all the previously watch(Object) keys.
    
    另请参阅:
    
    Redis Documentation: UNWATCH
  - multi
```
@Deprecated
default void multi()
```
    已过时。
    
    Mark the start of a transaction block.
    Commands will be queued and can then be executed by calling #exec() or rolled back using discard()
    
    另请参阅:
    
    Redis Documentation: MULTI
  - discard
```
@Deprecated
default void discard()
```
    已过时。
    
    Discard all commands issued after multi().
    
    另请参阅:
    
    Redis Documentation: DISCARD
  - serializer
```
@Deprecated
default RedisAPI<K,V> serializer(<any> defSerializer)
```
    已过时。
    
    设置默认Serializer
  - serializer
```
@Deprecated
default RedisAPI<K,V> serializer(<any> keySerializer,
                                              <any> valueSerializer)
```
    已过时。
    
    设置key,value Serializer
  - serializer
```
default RedisAPI<K,V> serializer(<any> keySerializer,
                                 <any> valueSerializer,
                                 <any> hashKeySerializer,
                                 <any> hashValueSerializer)
```
    设置key，value，hashKey，hashValue Serializer
  - stringCommandOps
```
default StringCommandOps stringCommandOps()
```
    stringCommandOps
    
    返回:
  - setCommands
```
default SetCommandOps setCommands()
```
    setCommands
    
    返回:
  - sortedSetCommands
```
default SortedSetCommandOps sortedSetCommands()
```
    sortedSetCommands
    
    返回:
  - keyCommand
```
default KeyCommandOps keyCommand()
```
    keyCommand
    
    返回:
  - hyperLogLogCommand
```
default HyperLogLogCommandOps hyperLogLogCommand()
```
    hyperLogLogCommand
    
    返回:
  - hashCommandOps
```
default HashCommandOps hashCommandOps()
```
    hashCommandOps
    
    返回:
  - listCommandOps
```
default ListCommandOps listCommandOps()
```
    listCommandOps
    
    返回:
  - getBaseRedisCommands
```
default BaseRedisCommands getBaseRedisCommands()
```
    redisCommands
    
    返回:
  - redisCommands
```
default RedisCommands redisCommands()
```
    redisCommands
    
    返回:
  - getConnect
```
default StatefulConnection getConnect()
```
  - redisAdvancedClusterCommands
```
default RedisAdvancedClusterCommands redisAdvancedClusterCommands()
```
    redisCommands
    
    返回:
  - ping
```
default java.lang.String ping()
```

接口 RedisAPI<K,V>

方法概要

方法详细资料

close

dump

restore

getKeySerializer

getValueSerializer

getHashKeySerializer

getHashValueSerializer

opsForValue

opsForSet

opsForZSet

opsForList

opsForHash

opsHash

opsList

opsSet

opsValue

opsZSet

execute

delete

delete

expire

expireAt

persist

getExpire

getExpire

hasKey

keys

randomKey

rename

renameIfAbsent

sort

sort

sort

sort

sort

watch

watch

unwatch

multi

discard

serializer

serializer

serializer

stringCommandOps

setCommands

sortedSetCommands

keyCommand

hyperLogLogCommand

hashCommandOps

listCommandOps

getBaseRedisCommands

redisCommands

getConnect

redisAdvancedClusterCommands

ping