阿里雲Redis開發規範

一、鍵值設計

1. key 名設計

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

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

ugc:video:1

(2)【建議】：簡潔性

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

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，但也要注意節省記憶體和效能之間的平衡)

反例：

set user:1:name tom

set user:1:age 19

set user:1:favor football

正例:

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.【推薦】使用批次操作提高效率

原生命令：例如 mget、mset。

非原生命令：可以使用 pipeline 提高效率。

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

注意兩者不同：

原生是原子操作，pipeline 是非原子操作。

pipeline 可以打包不同的命令，原生做不到

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 array"

2. 所有 key，必須在 1 個 slot 上，否則直接返回 error, “-ERR eval/evalsha command keys must in same slot”

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

三、客戶端使用

1.【推薦】

避免多個應用使用一個 Redis 例項

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

2.【推薦】

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

三、客戶端使用

1.【推薦】

避免多個應用使用一個 Redis 例項

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

2.【推薦】

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

執行命令如下：

Jedis jedis = null;

try {

    jedis = jedisPool.getResource();

    // 具體的命令

    jedis.executeCommand()

} catch (Exception e) {

    logger.error("op key {} error: " + e.getMessage(), key, e);

} finally {

    // 注意這裡不是關閉連線，在 JedisPool 模式下，Jedis 會被歸還給資源池。

    if (jedis != null) 

        jedis.close();

}

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

五 附錄：刪除 bigkey

1. 下面操作可以使用 pipeline 加速。

2. redis 4.0 已經支援 key 的非同步刪除，歡迎使用。

1. Hash 刪除: hscan + hdel

public void delBigHash(String host, int port, String password, String bigHashKey) {

    Jedis jedis = new Jedis(host, port);

    if (password != null && !"".equals(password)) {

        jedis.auth(password);

    }

    ScanParams scanParams = new ScanParams().count(100);

    String cursor = "0";

    do {

        ScanResult<Entry<String, String>> scanResult = jedis.hscan(bigHashKey, cursor, scanParams);

        List<Entry<String, String>> entryList = scanResult.getResult();

        if (entryList != null && !entryList.isEmpty()) {

            for (Entry<String, String> entry : entryList) {

                jedis.hdel(bigHashKey, entry.getKey());

            }

        }

        cursor = scanResult.getStringCursor();

    } while (!"0".equals(cursor));

    

    // 刪除 bigkey

    jedis.del(bigHashKey);

}

2. List 刪除: ltrim

public void delBigList(String host, int port, String password, String bigListKey) {

    Jedis jedis = new Jedis(host, port);

    if (password != null && !"".equals(password)) {

        jedis.auth(password);

    }

    long llen = jedis.llen(bigListKey);

    int counter = 0;

    int left = 100;

    while (counter < llen) {

        // 每次從左側截掉 100 個

        jedis.ltrim(bigListKey, left, llen);

        counter += left;

    }

    // 最終刪除 key

    jedis.del(bigListKey);

}

3. Set 刪除: sscan + srem

public void delBigSet(String host, int port, String password, String bigSetKey) {

    Jedis jedis = new Jedis(host, port);

    if (password != null && !"".equals(password)) {

        jedis.auth(password);

    }

    ScanParams scanParams = new ScanParams().count(100);

    String cursor = "0";

    do {

        ScanResult<String> scanResult = jedis.sscan(bigSetKey, cursor, scanParams);

        List<String> memberList = scanResult.getResult();

        if (memberList != null && !memberList.isEmpty()) {

            for (String member : memberList) {

                jedis.srem(bigSetKey, member);

            }

        }

        cursor = scanResult.getStringCursor();

    } while (!"0".equals(cursor));

    

    // 刪除 bigkey

    jedis.del(bigSetKey);

}

4. SortedSet 刪除: zscan + zrem

public void delBigZset(String host, int port, String password, String bigZsetKey) {

    Jedis jedis = new Jedis(host, port);

    if (password != null && !"".equals(password)) {

        jedis.auth(password);

    }

    ScanParams scanParams = new ScanParams().count(100);

    String cursor = "0";

    do {

        ScanResult<Tuple> scanResult = jedis.zscan(bigZsetKey, cursor, scanParams);

        List<Tuple> tupleList = scanResult.getResult();

        if (tupleList != null && !tupleList.isEmpty()) {

            for (Tuple tuple : tupleList) {

                jedis.zrem(bigZsetKey, tuple.getElement());

            }

        }

        cursor = scanResult.getStringCursor();

    } while (!"0".equals(cursor));

    

    // 刪除 bigkey

    jedis.del(bigZsetKey);

}