阿裡雲Redis開發規範

本文作者：carlosfu

原文連結：https://yq.aliyun.com/articles/531067

---

摘要： 本文介紹了在使用阿裡雲Redis的開發規範，從鍵值設計、命令使用、客戶端使用、相關工具等方面進行說明，透過本文的介紹可以減少使用Redis過程帶來的問題。

一、鍵值設計

1. key名設計

• (1)【建議】: 可讀性和可管理性

以業務名(或資料庫名)為字首(防止key衝突)，用冒號分隔，比如業務名:表名:id

1. 1.  ugc:video:1

• (2)【建議】：簡潔性

保證語意的前提下，控制key的長度，當key較多時，記憶體佔用也不容忽視，例如：

1. user:{uid}:friends:messages:{mid}簡化為u:{uid}:fr:m:{mid}。

• (3)【強制】：不要包含特殊字元

反例：包含空格、換行、單雙引號以及其他跳脫字元

2. value設計

• (1)【強制】：拒絕bigkey(防止網絡卡流量、慢查詢)

string型別控制在10KB以內，hash、list、set、zset元素個數不要超過5000。

反例：一個包含200萬個元素的list。

非字串的bigkey，不要使用del刪除，使用hscan、sscan、zscan方式漸進式刪除，同時要註意防止bigkey過期時間自動刪除問題(例如一個200萬的zset設定1小時過期，會觸發del操作，造成阻塞，而且該操作不會不出現在慢查詢中(latency可查))，查詢方法和刪除方法

• (2)【推薦】：選擇適合的資料型別。

例如：物體型別(要合理控制和使用資料結構記憶體編碼最佳化配置,例如ziplist，但也要註意節省記憶體和效能之間的平衡)

反例：

1. 1.  set user:1:name tom
2. 2.  set user:1:age 19
3. 3.  set user:1:favor football

正例:

1. 1.  hmset user:1 name tom age 19 favor football

3.【推薦】：控制key的生命週期，redis不是垃圾桶。

建議使用expire設定過期時間(條件允許可以打散過期時間，防止集中過期)，不過期的資料重點關註idletime。

二、命令使用

1.【推薦】 O(N)命令關註N的數量

例如hgetall、lrange、smembers、zrange、sinter等並非不能使用，但是需要明確N的值。有遍歷的需求可以使用hscan、sscan、zscan代替。

2.【推薦】：禁用命令

禁止線上使用keys、flushall、flushdb等，透過redis的rename機制禁掉命令，或者使用scan的方式漸進式處理。

3.【推薦】合理使用select

redis的多資料庫較弱，使用數字進行區分，很多客戶端支援較差，同時多業務用多資料庫實際還是單執行緒處理，會有幹擾。

4.【推薦】使用批次操作提高效率

1. 原生命令：例如mget、mset。
2. 非原生命令：可以使用pipeline提高效率。

但要註意控制一次批次操作的元素個數(例如500以內，實際也和元素位元組數有關)。

註意兩者不同：

1.  
   1. 原生是原子操作，pipeline是非原子操作。
2.  
   1. pipeline可以打包不同的命令，原生做不到
3.  
   1. pipeline需要客戶端和服務端同時支援。

5.【建議】Redis事務功能較弱，不建議過多使用

Redis的事務功能較弱(不支援回滾)，而且叢集版本(自研和官方)要求一次事務操作的key必須在一個slot上(可以使用hashtag功能解決)

6.【建議】Redis叢集版本在使用Lua上有特殊要求：

• 1.所有key都應該由 KEYS 陣列來傳遞，redis.call/pcall 裡面呼叫的redis命令，key的位置，必須是KEYS array, 否則直接傳回error，”-ERR bad lua script for redis cluster, all the keys that the script uses should be passed using the KEYS arrayrn”
• 2.所有key，必須在1個slot上，否則直接傳回error, “-ERR eval/evalsha command keys must in same slotrn”

7.【建議】必要情況下使用monitor命令時，要註意不要長時間使用。

三、客戶端使用

1.【推薦】

避免多個應用使用一個Redis實體

正例：不相干的業務拆分，公共資料做服務化。

2.【推薦】

使用帶有連線池的資料庫，可以有效控制連線，同時提高效率，標準使用方式：

1. 1.  執行命令如下：
2. 2.  Jedis jedis = null;
3. 3.  try {
4. 4.  jedis = jedisPool.getResource();
5. 5.     //具體的命令
6. 6.     jedis.executeCommand()
7. 7.  } catch (Exception e) {
8. 8.     logger.error("op key {} error: " + e.getMessage(), key, e);
9. 9.  } finally {
10. 10.     //註意這裡不是關閉連線，在JedisPool樣式下，Jedis會被歸還給資源池。
11. 11.     if (jedis != null)
12. 12.         jedis.close();
13. 13.  }

下麵是JedisPool最佳化方法的文章:

• Jedis常見異常彙總
• JedisPool資源池最佳化

3.【建議】

高併發下建議客戶端新增熔斷功能(例如netflix hystrix)

4.【推薦】

設定合理的密碼，如有必要可以使用SSL加密訪問（阿裡雲Redis支援）

5.【建議】

根據自身業務型別，選好maxmemory-policy(最大記憶體淘汰策略)，設定好過期時間。

預設策略是volatile-lru，即超過最大記憶體後，在過期鍵中使用lru演演算法進行key的剔除，保證不過期資料不被刪除，但是可能會出現OOM問題。

其他策略如下：

• allkeys-lru：根據LRU演演算法刪除鍵，不管資料有沒有設定超時屬性，直到騰出足夠空間為止。
• allkeys-random：隨機刪除所有鍵，直到騰出足夠空間為止。
• volatile-random:隨機刪除過期鍵，直到騰出足夠空間為止。
• volatile-ttl：根據鍵值物件的ttl屬性，刪除最近將要過期資料。如果沒有，回退到noeviction策略。
• noeviction：不會剔除任何資料，拒絕所有寫入操作並傳回客戶端錯誤資訊”(error) OOM command not allowed when used memory”，此時Redis只響應讀操作。

四、相關工具

1.【推薦】：資料同步

redis間資料同步可以使用：redis-port

2.【推薦】：big key搜尋

redis大key搜尋工具

3.【推薦】：熱點key尋找(內部實現使用monitor，所以建議短時間使用)

facebook的redis-faina

1. 阿裡雲Redis已經在核心層面解決熱點key問題，歡迎使用。

五 附錄：刪除bigkey

 

1. 1. 下麵操作可以使用pipeline加速。
   2. redis 4.0已經支援key的非同步刪除，歡迎使用。

1. Hash刪除: hscan + hdel

1. 1.  public void delBigHash(String host, int port, String password, String bigHashKey) {
2. 2.     Jedis jedis = new Jedis(host, port);
3. 3.     if (password != null && !"".equals(password)) {
4. 4.         jedis.auth(password);
5. 5.     }
6. 6.     ScanParams scanParams = new ScanParams().count(100);
7. 7.     String cursor = "0";
8. 8.     do {
9. 9.         ScanResult<Entry<String, String>> scanResult = jedis.hscan(bigHashKey, cursor, scanParams);
10. 10.         List<Entry<String, String>> entryList = scanResult.getResult();
11. 11.         if (entryList != null && !entryList.isEmpty()) {
12. 12.             for (Entry<String, String> entry : entryList) {
13. 13.                 jedis.hdel(bigHashKey, entry.getKey());
14. 14.             }
15. 15.         }
16. 16.  cursor = scanResult.getStringCursor();
17. 17.     } while (!"0".equals(cursor));
18. 19.     //刪除bigkey
19. 20.     jedis.del(bigHashKey);
20. 21.  }

2. List刪除: ltrim

1. 1.  public void delBigList(String host, int port, String password, String bigListKey) {
2. 2.     Jedis jedis = new Jedis(host, port);
3. 3.     if (password != null && !"".equals(password)) {
4. 4.         jedis.auth(password);
5. 5.     }
6. 6.     long llen = jedis.llen(bigListKey);
7. 7.     int counter = 0;
8. 8.     int left = 100;
9. 9.     while (counter < llen) {
10. 10.         //每次從左側截掉100個
11. 11.         jedis.ltrim(bigListKey, left, llen);
12. 12.  counter += left;
13. 13.     }
14. 14.     //最終刪除key
15. 15.     jedis.del(bigListKey);
16. 16.  }

3. Set刪除: sscan + srem

1. 1.  public void delBigSet(String host, int port, String password, String bigSetKey) {
2. 2.     Jedis jedis = new Jedis(host, port);
3. 3.     if (password != null && !"".equals(password)) {
4. 4.         jedis.auth(password);
5. 5.     }
6. 6.     ScanParams scanParams = new ScanParams().count(100);
7. 7.     String cursor = "0";
8. 8.     do {
9. 9.         ScanResult<String> scanResult = jedis.sscan(bigSetKey, cursor, scanParams);
10. 10.         List<String> memberList = scanResult.getResult();
11. 11.         if (memberList != null && !memberList.isEmpty()) {
12. 12.             for (String member : memberList) {
13. 13.                 jedis.srem(bigSetKey, member);
14. 14.             }
15. 15.         }
16. 16.  cursor = scanResult.getStringCursor();
17. 17.     } while (!"0".equals(cursor));
18. 19.     //刪除bigkey
19. 20.     jedis.del(bigSetKey);
20. 21.  }

4. SortedSet刪除: zscan + zrem

1. 1.  public void delBigZset(String host, int port, String password, String bigZsetKey) {
2. 2.     Jedis jedis = new Jedis(host, port);
3. 3.     if (password != null && !"".equals(password)) {
4. 4.         jedis.auth(password);
5. 5.     }
6. 6.     ScanParams scanParams = new ScanParams().count(100);
7. 7.     String cursor = "0";
8. 8.     do {
9. 9.         ScanResult<Tuple> scanResult = jedis.zscan(bigZsetKey, cursor, scanParams);
10. 10.         List<Tuple> tupleList = scanResult.getResult();
11. 11.         if (tupleList != null && !tupleList.isEmpty()) {
12. 12.             for (Tuple tuple : tupleList) {
13. 13.                 jedis.zrem(bigZsetKey, tuple.getElement());
14. 14.             }
15. 15.         }
16. 16.  cursor = scanResult.getStringCursor();
17. 17.     } while (!"0".equals(cursor));
18. 19.     //刪除bigkey
19. 20.     jedis.del(bigZsetKey);
20. 21.  }