Redis經常使用API-使用文檔

 

1、Redis Client介紹

1.一、簡介

Jedis Client是Redis官網推薦的一個面向java客戶端，庫文件實現了對各種API進行封裝調用。

Jedis源碼工程地址：https://github.com/xetorthio/jedis

1.二、使用

Redis Client最好選用與服務端對應的版本，本例中使用Redis 2.8.19客戶端使用jedis -2.6.3，Maven工程添加以下引用便可。

   <dependency>

         <groupId>redis.clients</groupId>

         <artifactId>jedis</artifactId>

         <version>2.6.3</version>

         <type>jar</type>

         <scope>compile</scope>

   </dependency>

1.三、注意事項

Redis Client擁有衆多對接版本，本項目目前使用Jedis爲官方推薦Java對接客戶端，是基於其對Redis良好的版本支持和API對接，另外編碼中儘可能避免使用廢棄接口。

Redis目前正在新版過渡期，3.0版本暫未穩定，可是因爲3.0版本提供了最新的集羣功能，可能在往後穩定版發佈之後升級到3.0，目前使用的Jedis支持3.0的目前版本API。

2、Redis Client經常使用API

2.一、環境要求

語言：Java

JDK：1.7

Redis : 2.8.19（穩定版）

2.二、系統使用

2.2.一、創建鏈接

• 普通鏈接

Jedis jedis = new Jedis("localhost");

       jedis.set("foo", "bar");

       String value = jedis.get("foo");

       System.out.println(value);

• 設置鏈接池配置

該方法用於獲得redis鏈接池鏈接使用的鏈接池配置，該鏈接池配置也能夠經過spring注入的方式來進行相對應的配置，鏈接池採用的是平時比較經常使用的org.apache.commons.pool2.impl.GenericObjectPoolConfig來進行的鏈接池管理

配置文件以下

#redis服務器ip #   

    redis.ip=172.30.5.117 

   

    #redis服務器端口號# 

    redis.port=6379 

     

    ###jedis##pool##config### 

    #jedis的最大分配對象# 

    jedis.pool.maxActive=1024 

   

    #jedis最大保存idel狀態對象數 # 

    jedis.pool.maxIdle=200 

   

    #jedis池沒有對象返回時，最大等待時間 # 

    jedis.pool.maxWait=1000 

   

    #jedis調用borrowObject方法時，是否進行有效檢查# 

    jedis.pool.testOnBorrow=true 

   

    #jedis調用returnObject方法時，是否進行有效檢查 # 

    jedis.pool.testOnReturn=true

鏈接池配置實例化代碼（也可經過spring注入進行配置）：

   /**

    * 獲取化鏈接池配置

    * @return JedisPoolConfig

    * */

   private JedisPoolConfig getPoolConfig(){

      if(config == null){

         config = new JedisPoolConfig();

         //最大鏈接數

config.setMaxTotal(Integer.valueOf(getResourceBundle().getString("redis.pool.maxTotal")));

         //最大空閒鏈接數

config.setMaxIdle(Integer.valueOf(getResourceBundle().getString("redis.pool.maxIdle")));

         //獲取鏈接時的最大等待毫秒數(若是設置爲阻塞時BlockWhenExhausted),若是超時就拋異常, 小於零:阻塞不肯定的時間,  默認-1

config.setMaxWaitMillis(Long.valueOf(getResourceBundle().getString("redis.pool.maxWaitMillis")));

         //在獲取鏈接的時候檢查有效性, 默認false

config.setTestOnBorrow(Boolean.valueOf(getResourceBundle().getString("redis.pool.testOnBorrow")));

         //在獲取返回結果的時候檢查有效性, 默認false

config.setTestOnReturn(Boolean.valueOf(getResourceBundle().getString("redis.pool.testOnReturn")));

      }

      return config;

   }

• 普通鏈接池鏈接

  這裏展現的是普通的鏈接池方式連接redis的方案，跟普通的數據庫鏈接池的操做方式相似；

/**

        * 初始化JedisPool

        * */

   private void initJedisPool(){

      if(pool == null){

         //獲取服務器IP地址

         String ipStr = getResourceBundle().getString("redis.ip");

         //獲取服務器端口

         int portStr = Integer.valueOf(getResourceBundle()

.getString("redis.port"));

         //初始化鏈接池

         pool = new JedisPool(getPoolConfig(), ipStr,portStr);

      }

   } 

• Sentinel鏈接池鏈接

該鏈接池用於應對Redis的Sentinel的主從切換機制，可以正確在服務器宕機致使服務器切換時獲得正確的服務器鏈接，當服務器採用該部署策略的時候推薦使用該鏈接池進行操做；

   private void initJedisSentinelPool(){

      if(sentinelpool == null){

         //監聽器列表

         Set<String> sentinels = new HashSet<String>();

         //監聽器1

         sentinels.add(new HostAndPort("192.168.50.236",

26379).toString());

         //監聽器2

         sentinels.add(new HostAndPort("192.168.50.237",

26379).toString());

//實際使用的時候在properties裏配置便可：redis.sentinel.hostandports

=192.168.50.236:26379,192.168.50.237:26379

getResourceBundle().getString("redis.sentinel.hostandports")

//mastername是服務器上的master的名字，在master服務器的sentinel.conf中配置:

                     //[sentinel monitor server-1M  192.168.50.236 6379 2]

                     //中間的server-1M即爲這裏的masterName

         String masterName = getResourceBundle()

.getString("redis.sentinel.masterName");

         //初始化鏈接池

         sentinelpool = new JedisSentinelPool(masterName,

sentinels, getPoolConfig());

      }

   }

• ShardedJedisPool鏈接池分片鏈接

   /**

        * 初始化ShardedJedisPool

        * Redis在容災處理方面能夠經過服務器端配置Master-Slave模式來實現。

        * 而在分佈式集羣方面目前只能經過客戶端工具來實現一致性哈希分佈存儲，即key分片存儲。

        * Redis可能會在3.0版本支持服務器端的分佈存儲

        * */

   private void initShardedJedisPool() {

      if (shardPool == null) {

         // 建立多個redis共享服務

         String redis1Ip = getResourceBundle().getString("redis1.ip");

         int redis1Port = Integer.valueOf(bundle.getString("redis.port"));

         JedisShardInfo jedisShardInfo1 = new JedisShardInfo(redis1Ip, redis1Port);

         String redis2Ip = getResourceBundle().getString("redis2.ip");

         int redis2Port = Integer.valueOf(bundle.getString("redis.port"));

         JedisShardInfo jedisShardInfo2 = new JedisShardInfo(redis2Ip, redis2Port);

 

         List<JedisShardInfo> serverlist = new LinkedList<JedisShardInfo>();

         serverlist.add(jedisShardInfo1);

         serverlist.add(jedisShardInfo2);

         // 初始化鏈接池

         shardPool = new ShardedJedisPool(getPoolConfig(),serverlist);

      }

   }

• 讀寫刪除操做

// 從池中獲取一個Jedis對象

      Jedis jedis = sentinelpool.getSentinelpoolResource();

      String keys = "name";

   // 刪除key-value對象，若是key不存在則忽略此操做

      jedis.del(keys);

   // 存數據

      jedis.set(keys, "snowolf");

// 判斷key是否存在，不存在返回false存在返回true

      jedis.exists(keys);

   // 取數據

      String value = jedis.get(keys);

   // 釋放對象池（3.0將拋棄該方法）

      sentinelpool.returnSentinelpoolResource(jedis);

3、示例代碼

1. 1.     String的簡單追加

// 從池中獲取一個Jedis對象

   JedisUtil.getInstance().STRINGS.append(key, value);

1. 2.     價格時間排序（前提是已經存儲了價格，時間的SortSet）

//執行2級排序操做（）

String stPriceSet = 「stPriceSet」;//stPriceSet價格的sortset列表名

String stTimeSet = 「stTimeSet」; // stTimeSet時間的sortset列表名

   Set<Tuple> sumSet = JedisUtilEx.getInstance()

.getSortSetByPirceUpAndTimeDown(stPriceSet, stTimeSet);

//排序之後能夠重複獲取上次排序結果(緩存時間10分鐘)

Set<Tuple> sumSet = JedisUtilEx.getInstance()

getLastPirceUpAndTimeDownSet();

1. 3.  價格時間排序（前提是已經存儲了價格，時間的SortSet）

//執行2級排序操做

String stPriceSet = 「stPriceSet」;//stPriceSet價格的sortset列表名

String stTimeSet = 「stTimeSet」; // stTimeSet時間的sortset列表名

   Set<Tuple> sumSet = JedisUtilEx.getInstance()

. getSortSetByPirceDownAndTimeDown (stPriceSet, stTimeSet);

   //排序之後能夠重複獲取上次排序結果(緩存時間10分鐘)

Set<Tuple> sumSet = JedisUtilEx.getInstance()

getLastPirceDownAndTimeDownSet ();

1. 4.     保存JavaBean到hash表中

// bean繼承至RedisBean

JedisUtilEx.getInstance().setBeanToHash(bean);

1. 5.     從hash表中讀取JavaBean

//uuid爲業務制定的惟一標識符規則（至關於主鍵）

String uuid = 「1」; //該ID是咱們提早就知道的

//T繼承至RedisBean;

JedisUtilEx.getInstance().getBeanFromHash (uuid,Class<T> cls);

1. 6.     將JavaBean列表裝入hash中

//list中的bean繼承至RedisBean

List<T> beanList = …;

JedisUtilEx.getInstance().setBeanListToHash(beanList);

//異步版本的存儲列表到hash

JedisUtilEx.getInstance().setBeanListToHashSyn(beanList);

1. 7.     普通的操做流程示例

//獲取jedis引用

Jedis jedis = JedisUtil.getInstance().getJedis();

//執行業務以及調用jedis提供的接口功能

…

jedis.hset(…);

…

//執行完成之後務必釋放資源

JedisUtil.getInstance().returnJedis(jedis);

//若之後不會使用JEDIS，須要關閉全部連接池

   RedisConnetcion.destroyAllPools();

1. 8.     事務執行流程

//獲取鏈接資源

   Jedis jd = JedisUtil.getInstance().getJedis();

//開啓事務

Transaction ts = jd.multi();

//執行業務以及調用jedis提供的接口功能

…

jedis.hset(…);

…

//執行事務

   List<Object> list = ts.exec();

//釋放資源

JedisUtil.getInstance().returnJedis(jd);

1. 9.     異步執行

//獲取鏈接資源

   Jedis jedis = JedisUtil.getInstance().getJedis();

   //獲取管道

Pipeline pipeline = jedis.pipelined();

//執行業務以及調用jedis提供的接口功能

…

jedis.hset(…);

…

//提交併釋放管道

pipeline.syncAndReturnAll();

//釋放資源

JedisUtil.getInstance().returnJedis(jedis);

1. 10.  如何獲取Jedis命名規則的合成KEY

//獲取類的惟一鍵值key,例如：User:1(User爲class,1爲uuid)其中user繼承於Reidsbean

JedisUtilEx.getInstance().getBeanKey(user);

//另外一種獲取類的惟一鍵值key的方法

JedisUtilEx.getInstance().getBeanKey(String uuid,Class<T> cls);

//獲取bean對應的KEY(對應列的惟一鍵值key)

JedisUtilEx.getInstance().getBeanKey(String uuid,Class<T> cls,String... fileds);

//獲取bean對應的KEY(集羣key)

JedisUtilEx.getInstance().getBeanKey(Class<T> cls,String... fileds);

4、jedis操做命令：

1.對value操做的命令

     exists(key)：確認一個key是否存在

     del(key)：刪除一個key

     type(key)：返回值的類型

     keys(pattern)：返回知足給定pattern的全部key

     randomkey：隨機返回key空間的一個key

     rename(oldname, newname)：將key由oldname重命名爲newname，若newname存在則刪除newname表示的key

     dbsize：返回當前數據庫中key的數目

     expire：設定一個key的活動時間（s）

     ttl：得到一個key的活動時間

     select(index)：按索引查詢

     move(key, dbindex)：將當前數據庫中的key轉移到有dbindex索引的數據庫

     flushdb：刪除當前選擇數據庫中的全部key

     flushall：刪除全部數據庫中的全部key

2.對String操做的命令

     set(key, value)：給數據庫中名稱爲key的string賦予值value

     get(key)：返回數據庫中名稱爲key的string的value

     getset(key, value)：給名稱爲key的string賦予上一次的value

     mget(key1, key2,…, key N)：返回庫中多個string（它們的名稱爲key1，key2…）的value

     setnx(key, value)：若是不存在名稱爲key的string，則向庫中添加string，名稱爲key，值爲value

     setex(key, time, value)：向庫中添加string（名稱爲key，值爲value）同時，設定過時時間time

     mset(key1, value1, key2, value2,…key N, value N)：同時給多個string賦值，名稱爲key i的string賦值value i

     msetnx(key1, value1, key2, value2,…key N, value N)：若是全部名稱爲key i的string都不存在，則向庫中添加string，名稱key i賦值爲value i

     incr(key)：名稱爲key的string增1操做

     incrby(key, integer)：名稱爲key的string增長integer

     decr(key)：名稱爲key的string減1操做

     decrby(key, integer)：名稱爲key的string減小integer

     append(key, value)：名稱爲key的string的值附加value

     substr(key, start, end)：返回名稱爲key的string的value的子串

3.對List操做的命令

     rpush(key, value)：在名稱爲key的list尾添加一個值爲value的元素

     lpush(key, value)：在名稱爲key的list頭添加一個值爲value的 元素

     llen(key)：返回名稱爲key的list的長度

     lrange(key, start, end)：返回名稱爲key的list中start至end之間的元素（下標從0開始，下同）

     ltrim(key, start, end)：截取名稱爲key的list，保留start至end之間的元素

     lindex(key, index)：返回名稱爲key的list中index位置的元素

     lset(key, index, value)：給名稱爲key的list中index位置的元素賦值爲value

     lrem(key, count, value)：刪除count個名稱爲key的list中值爲value的元素。count爲0，刪除全部值爲value的元素，count>0      從頭到尾刪除count個值爲value的元素，count<0從尾到頭刪除|count|個值爲value的元素。

     lpop(key)：返回並刪除名稱爲key的list中的首元素

     rpop(key)：返回並刪除名稱爲key的list中的尾元素

     blpop(key1, key2,… key N, timeout)：lpop 命令的block版本。即當timeout爲0時，若遇到名稱爲key i的list不存在或該list爲空，則命令結束。若是 timeout>0，則遇到上述狀況時，等待timeout秒，若是問題沒有解決，則對key i+1開始的list執行pop操做。

     brpop(key1, key2,… key N, timeout)：rpop的block版本。參考上一命令。

     rpoplpush(srckey, dstkey)：返回並刪除名稱爲srckey的list的尾元素，並將該元素添加到名稱爲dstkey的list的頭部

4.對Set操做的命令

     sadd(key, member)：向名稱爲key的set中添加元素member

     srem(key, member) ：刪除名稱爲key的set中的元素member

     spop(key) ：隨機返回並刪除名稱爲key的set中一個元素

     smove(srckey, dstkey, member) ：將member元素從名稱爲srckey的集合移到名稱爲dstkey的集合

     scard(key) ：返回名稱爲key的set的基數

     sismember(key, member) ：測試member是不是名稱爲key的set的元素

     sinter(key1, key2,…key N) ：求交集

     sinterstore(dstkey, key1, key2,…key N) ：求交集並將交集保存到dstkey的集合

     sunion(key1, key2,…key N) ：求並集

     sunionstore(dstkey, key1, key2,…key N) ：求並集並將並集保存到dstkey的集合

     sdiff(key1, key2,…key N) ：求差集

     sdiffstore(dstkey, key1, key2,…key N) ：求差集並將差集保存到dstkey的集合

     smembers(key) ：返回名稱爲key的set的全部元素

     srandmember(key) ：隨機返回名稱爲key的set的一個元素

5.對zset（sorted set）操做的命令

     zadd(key, score, member)：向名稱爲key的zset中添加元素member，score用於排序。若是該元素已經存在，則根據score更新該元素的順序。

     zrem(key, member) ：刪除名稱爲key的zset中的元素member

     zincrby(key, increment, member) ：若是在名稱爲key的zset中已經存在元素member，則該元素的score增長increment；不然向集合中添加該元素，其score的值爲increment

     zrank(key, member) ：返回名稱爲key的zset（元素已按score從小到大排序）中member元素的rank（即index，從0開始），若沒有member元素，返回「nil」

     zrevrank(key, member) ：返回名稱爲key的zset（元素已按score從大到小排序）中member元素的rank（即index，從0開始），若沒有member元素，返回「nil」

     zrange(key, start, end)：返回名稱爲key的zset（元素已按score從小到大排序）中的index從start到end的全部元素

     zrevrange(key, start, end)：返回名稱爲key的zset（元素已按score從大到小排序）中的index從start到end的全部元素

     zrangebyscore(key, min, max)：返回名稱爲key的zset中score >= min且score <= max的全部元素

     zcard(key)：返回名稱爲key的zset的基數

     zscore(key, element)：返回名稱爲key的zset中元素element的score

     zremrangebyrank(key, min, max)：刪除名稱爲key的zset中rank >= min且rank <= max的全部元素

     zremrangebyscore(key, min, max) ：刪除名稱爲key的zset中score >= min且score <= max的全部元素

     zunionstore / zinterstore(dstkeyN, key1,…,keyN, WEIGHTS w1,…wN, AGGREGATE SUM|MIN|MAX)：對N個zset求並集和交集，並將最後的集合保存在dstkeyN中。對於集合中每個元素的score，在進行AGGREGATE運算前，都要乘以對於的WEIGHT參數。若是沒有提供WEIGHT，默認爲1。默認的AGGREGATE是SUM，即結果集合中元素的score是全部集合對應元素進行 SUM運算的值，而MIN和MAX是指，結果集合中元素的score是全部集合對應元素中最小值和最大值。

6.對Hash操做的命令

     hset(key, field, value)：向名稱爲key的hash中添加元素field<—>value

     hget(key, field)：返回名稱爲key的hash中field對應的value

     hmget(key, field1, …,field N)：返回名稱爲key的hash中field i對應的value

     hmset(key, field1, value1,…,field N, value N)：向名稱爲key的hash中添加元素field i<—>value i

     hincrby(key, field, integer)：將名稱爲key的hash中field的value增長integer

     hexists(key, field)：名稱爲key的hash中是否存在鍵爲field的域

     hdel(key, field)：刪除名稱爲key的hash中鍵爲field的域

     hlen(key)：返回名稱爲key的hash中元素個數

     hkeys(key)：返回名稱爲key的hash中全部鍵

     hvals(key)：返回名稱爲key的hash中全部鍵對應的value

     hgetall(key)：返回名稱爲key的hash中全部的鍵（field）及其對應的value

5、Redis命名規則

因爲Redis全部數據爲鍵值對，即全部數據均只能經過鍵值（Key）來進行管理，故需

要規範命名規則，jedis客戶端包裝了有專門的命名規則生產函數，調用便可！代碼參考實例代碼：

 

6、參考資料

官方API：http://redisdoc.com

更多功能能夠參考該文檔去調用