RedisClient (framework-cache 2.0.2 API)

java.lang.Object
- com.github.fartherp.framework.cache.redis.RedisClient

所有已实现的接口:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
```
public class RedisClient
extends Object
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean
```
redis客户端 Author: CK Date: 2015/12/1

构造器概要

构造器
构造器和说明

RedisClient()

构造器
构造器和说明
`RedisClient()`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`add(String key, Object value)` add if not exists
`boolean`	`add(String key, Object value, Integer expiration)` add if not exists
`void`	`afterPropertiesSet()`
`boolean`	`delete(String key)` Remove the specified keys.
`protected Object`	`deserialize(byte[] in)` Get the object represented by the given serialized bytes.
`void`	`destroy()`
`boolean`	`exists(String key)` Test if the specified key exists.
`boolean`	`expire(String key, int seconds)` to add expire time in seconds
`boolean`	`flushall()` Delete all the keys of all the existing databases, not just the currently selected one.
`Object`	`get(String key)` get value return null if key did not exist
`String`	`getCacheName()`
`redis.clients.jedis.JedisPool`	`getJedisPool()`
`int`	`getPort()`
`protected org.apache.commons.pool.impl.GenericObjectPool`	`getRealPool()`
`protected org.apache.commons.pool.impl.GenericObjectPool`	`getRealPoolInstance()` 获取实际的对象池实例
`String`	`getRedisAuthKey()`
`String`	`getRedisServer()`
`byte`	`getWhenExhaustedAction()`
`boolean`	`hdel(String key, String field)` delete element from set
`boolean`	`hExists(String key, String field)` check key exist in set
`Object`	`hget(String key, String field)` get value by element key from set
`Map<String,Object>`	`hGetAll(String key)` get map value from set
`Set<String>`	`hKeys(String key)` get keys from set
`long`	`hLen(String key)` get size from set
`List<Object>`	`hmGet(String key, String... fields)` get keys from set
`void`	`hmSet(String key, Map<String,Serializable> values)` set map value to target set
`void`	`hput(String key, String field, Serializable fieldValue)` add value to set
`List<Object>`	`hValues(String key)` get values from set
`String`	`ping()` do ping action
`protected byte[]`	`serialize(Object o)` Get the bytes representing the given serialized object.
`boolean`	`set(String key, Object value)` set a value without expiration
`boolean`	`set(String key, Object value, Integer expiration)` value set The string can't be longer than 1073741824 bytes (1 GB).
`void`	`setCacheName(String cacheName)`
`protected void`	`setJedisPool(redis.clients.jedis.JedisPool jedisPool)`
`void`	`setPort(int port)`
`protected void`	`setRealPool(org.apache.commons.pool.impl.GenericObjectPool realPool)`
`void`	`setRedisAuthKey(String redisAuthKey)`
`void`	`setRedisServer(String redisServer)`
`void`	`setWhenExhaustedAction(byte whenExhaustedAction)`
`void`	`shutdown()` do destroy jedis pool

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RedisClient
```
public RedisClient()
```
- 方法详细资料
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    指定者:
    
    afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean
    
    抛出:
    
    Exception
  - getRealPoolInstance
```
protected org.apache.commons.pool.impl.GenericObjectPool getRealPoolInstance()
```
    获取实际的对象池实例
    
    返回:
    实际的对象池实例
  - get
```
public Object get(String key)
           throws Exception
```
    get value
    return null if key did not exist
    
    参数:
    key - cache key
    
    返回:
    cache value
    
    抛出:
    
    Exception - in case of access redis server exception
  - ping
```
public String ping()
            throws Exception
```
    do ping action
    
    返回:
    ping result
    
    抛出:
    
    Exception - in case of access redis server exception
  - set
```
public boolean set(String key,
          Object value,
          Integer expiration)
            throws Exception
```
    value set
    The string can't be longer than 1073741824 bytes (1 GB).
    
    参数:
    key - cache key
    value - value
    expiration - expiration time 超时时间
    
    返回:
    false if redis did not execute the option
    
    抛出:
    
    Exception - in case of access redis server exception
  - set
```
public boolean set(String key,
          Object value)
            throws Exception
```
    set a value without expiration
    
    参数:
    key - cache key
    value - cache value
    
    返回:
    false if redis did not execute the option
    
    抛出:
    
    Exception - in case of access redis server exception
  - add
```
public boolean add(String key,
          Object value,
          Integer expiration)
            throws Exception
```
    add if not exists
    
    参数:
    key - cache key
    value - cache value
    expiration - expiration time
    
    返回:
    false if redis did not execute the option
    
    抛出:
    
    Exception - in case of access redis server exception
  - add
```
public boolean add(String key,
          Object value)
            throws Exception
```
    add if not exists
    
    参数:
    key - cache eky
    value - cache value
    
    返回:
    false if redis did not execute the option
    
    抛出:
    
    Exception - in case of access redis server exception
  - exists
```
public boolean exists(String key)
               throws Exception
```
    Test if the specified key exists.
    
    参数:
    key - cache key
    
    返回:
    true if exist
    
    抛出:
    
    Exception - in case of access redis server exception
  - delete
```
public boolean delete(String key)
```
    Remove the specified keys.
    
    参数:
    key - cache key
    
    返回:
    false if redis did not execute the option
  - expire
```
public boolean expire(String key,
             int seconds)
```
    to add expire time in seconds
    
    参数:
    key - cache key
    seconds - expiration in seconds
    
    返回:
    false if redis did not execute the option
  - flushall
```
public boolean flushall()
```
    Delete all the keys of all the existing databases, not just the currently selected one.
    
    返回:
    false if redis did not execute the option
  - shutdown
```
public void shutdown()
```
    do destroy jedis pool
    
    另请参阅:
    jedisPool
  - serialize
```
protected byte[] serialize(Object o)
```
    Get the bytes representing the given serialized object.
    
    参数:
    o - target value
    
    返回:
    byte array
  - deserialize
```
protected Object deserialize(byte[] in)
```
    Get the object represented by the given serialized bytes.
    
    参数:
    in - byte array
    
    返回:
    result after deserialized
  - hput
```
public void hput(String key,
        String field,
        Serializable fieldValue)
          throws Exception
```
    add value to set
    
    参数:
    key - cache key of set
    field - element key
    fieldValue - value
    
    抛出:
    
    Exception - in case of access redis server exception
  - hget
```
public Object hget(String key,
          String field)
```
    get value by element key from set
    
    参数:
    key - cache key of set
    field - element key
    
    返回:
    value
  - hdel
```
public boolean hdel(String key,
           String field)
             throws Exception
```
    delete element from set
    
    参数:
    key - cache key of set
    field - element key
    
    返回:
    true if success
    
    抛出:
    
    Exception - in case of access redis server exception
  - hKeys
```
public Set<String> hKeys(String key)
                  throws Exception
```
    get keys from set
    
    参数:
    key - cache key
    
    返回:
    keys from set
    
    抛出:
    
    Exception - in case of access redis server exception
  - hValues
```
public List<Object> hValues(String key)
                     throws Exception
```
    get values from set
    
    参数:
    key - cache key
    
    返回:
    value list
    
    抛出:
    
    Exception - in case of access redis server exception
  - hExists
```
public boolean hExists(String key,
              String field)
                throws Exception
```
    check key exist in set
    
    参数:
    key - cache key of set
    field - element key
    
    返回:
    true if exist
    
    抛出:
    
    Exception - in case of access redis server exception
  - hLen
```
public long hLen(String key)
          throws Exception
```
    get size from set
    
    参数:
    key - cache key
    
    返回:
    set size
    
    抛出:
    
    Exception - in case of access redis server exception
  - hGetAll
```
public Map<String,Object> hGetAll(String key)
                           throws Exception
```
    get map value from set
    
    参数:
    key - cache key
    
    返回:
    map value
    
    抛出:
    
    Exception - in case of access redis server exception
  - hmSet
```
public void hmSet(String key,
         Map<String,Serializable> values)
           throws Exception
```
    set map value to target set
    
    参数:
    key - cache key
    values - map value
    
    抛出:
    
    Exception - in case of access redis server exception
  - hmGet
```
public List<Object> hmGet(String key,
                 String... fields)
                   throws Exception
```
    get keys from set
    
    参数:
    key - key name
    fields - key names
    
    返回:
    cache value list
    
    抛出:
    
    Exception - in case of access redis server exception
  - destroy
```
public void destroy()
             throws Exception
```
    指定者:
    
    destroy 在接口中 org.springframework.beans.factory.DisposableBean
    
    抛出:
    
    Exception
  - getJedisPool
```
public redis.clients.jedis.JedisPool getJedisPool()
```
  - setJedisPool
```
protected void setJedisPool(redis.clients.jedis.JedisPool jedisPool)
```
  - setRealPool
```
protected void setRealPool(org.apache.commons.pool.impl.GenericObjectPool realPool)
```
  - getRealPool
```
protected org.apache.commons.pool.impl.GenericObjectPool getRealPool()
```
  - getRedisServer
```
public String getRedisServer()
```
  - setRedisServer
```
public void setRedisServer(String redisServer)
```
  - getCacheName
```
public String getCacheName()
```
  - setCacheName
```
public void setCacheName(String cacheName)
```
  - getRedisAuthKey
```
public String getRedisAuthKey()
```
  - setRedisAuthKey
```
public void setRedisAuthKey(String redisAuthKey)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
  - getWhenExhaustedAction
```
public byte getWhenExhaustedAction()
```
  - setWhenExhaustedAction
```
public void setWhenExhaustedAction(byte whenExhaustedAction)
```

类 RedisClient

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

RedisClient

方法详细资料

afterPropertiesSet

getRealPoolInstance

get

ping

set

set

add

add

exists

delete

expire

flushall

shutdown

serialize

deserialize

hput

hget

hdel

hKeys

hValues

hExists

hLen

hGetAll

hmSet

hmGet

destroy

getJedisPool

setJedisPool

setRealPool

getRealPool

getRedisServer

setRedisServer

getCacheName

setCacheName

getRedisAuthKey

setRedisAuthKey

getPort

setPort

getWhenExhaustedAction

setWhenExhaustedAction