Redis 開(kāi)發(fā)規(guī)范
轉(zhuǎn)載說(shuō)明：文章轉(zhuǎn)載自云棲社區(qū)咖楣，為了方便自己查看吧雹，如有侵權(quán)請(qǐng)告知本人
阿里云Redis開(kāi)發(fā)規(guī)范
一糯而、鍵值設(shè)計(jì)
1. key名設(shè)計(jì)
- (1)【建議】: 可讀性和可管理性
以業(yè)務(wù)名(或數(shù)據(jù)庫(kù)名)為前綴(防止key沖突)，用冒號(hào)分隔克滴，比如業(yè)務(wù)名:表名:id
ugc:video:1
- (2)【建議】：簡(jiǎn)潔性
保證語(yǔ)義的前提下逼争，控制key的長(zhǎng)度，當(dāng)key較多時(shí)劝赔，內(nèi)存占用也不容忽視誓焦，例如：
user:{uid}:friends:messages:{mid}簡(jiǎn)化為u:{uid}:fr:m:{mid}。
- (3)【強(qiáng)制】：不要包含特殊字符
反例：包含空格、換行杂伟、單雙引號(hào)以及其他轉(zhuǎn)義字符
2. value設(shè)計(jì)
- (1)【強(qiáng)制】：拒絕bigkey(防止網(wǎng)卡流量移层、慢查詢)
string類型控制在10KB以內(nèi)，hash赫粥、list观话、set、zset元素個(gè)數(shù)不要超過(guò)5000越平。
反例：一個(gè)包含200萬(wàn)個(gè)元素的list频蛔。
非字符串的bigkey，不要使用del刪除秦叛，使用hscan晦溪、sscan、zscan方式漸進(jìn)式刪除挣跋，同時(shí)要注意防止bigkey過(guò)期時(shí)間自動(dòng)刪除問(wèn)題(例如一個(gè)200萬(wàn)的zset設(shè)置1小時(shí)過(guò)期三圆，會(huì)觸發(fā)del操作，造成阻塞避咆，而且該操作不會(huì)不出現(xiàn)在慢查詢中(latency可查))嫌术，查找方法和刪除方法
- (2)【推薦】：選擇適合的數(shù)據(jù)類型。
例如：實(shí)體類型(要合理控制和使用數(shù)據(jù)結(jié)構(gòu)內(nèi)存編碼優(yōu)化配置,例如ziplist牌借，但也要注意節(jié)省內(nèi)存和性能之間的平衡)
反例：
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設(shè)置過(guò)期時(shí)間(條件允許可以打散過(guò)期時(shí)間膨报，防止集中過(guò)期)，不過(guò)期的數(shù)據(jù)重點(diǎn)關(guān)注idletime适荣。
二现柠、命令使用
- 1.【推薦】 O(N)命令關(guān)注N的數(shù)量
例如hgetall、lrange弛矛、smembers够吩、zrange、sinter等并非不能使用丈氓，但是需要明確N的值周循。有遍歷的需求可以使用hscan、sscan万俗、zscan代替湾笛。
- 2.【推薦】：禁用命令
禁止線上使用keys、flushall闰歪、flushdb等嚎研，通過(guò)redis的rename機(jī)制禁掉命令，或者使用scan的方式漸進(jìn)式處理库倘。
- 3.【推薦】合理使用select
redis的多數(shù)據(jù)庫(kù)較弱临扮，使用數(shù)字進(jìn)行區(qū)分论矾，很多客戶端支持較差，同時(shí)多業(yè)務(wù)用多數(shù)據(jù)庫(kù)實(shí)際還是單線程處理杆勇，會(huì)有干擾贪壳。
- 4.【推薦】使用批量操作提高效率
原生命令：例如mget、mset靶橱。
非原生命令：可以使用pipeline提高效率寥袭。
但要注意控制一次批量操作的元素個(gè)數(shù)(例如500以內(nèi)，實(shí)際也和元素字節(jié)數(shù)有關(guān))关霸。
注意兩者不同：
1.原生是原子操作传黄，pipeline是非原子操作。
2.pipeline可以打包不同的命令队寇，原生做不到
3.pipeline需要客戶端和服務(wù)端同時(shí)支持膘掰。
- 5.【建議】Redis事務(wù)功能較弱，不建議過(guò)多使用
Redis的事務(wù)功能較弱(不支持回滾)佳遣，而且集群版本(自研和官方)要求一次事務(wù)操作的key必須在一個(gè)slot上(可以使用hashtag功能解決)
-
6.【建議】Redis集群版本在使用Lua上有特殊要求：
- 1.所有key都應(yīng)該由 KEYS 數(shù)組來(lái)傳遞识埋，redis.call/pcall 里面調(diào)用的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個(gè)slot上诵盼，否則直接返回error, "-ERR eval/evalsha command keys must in same slot"
7.【建議】必要情況下使用monitor命令時(shí)惠豺，要注意不要長(zhǎng)時(shí)間使用。
三风宁、客戶端使用
- 1.【推薦】
避免多個(gè)應(yīng)用使用一個(gè)Redis實(shí)例
正例：不相干的業(yè)務(wù)拆分洁墙，公共數(shù)據(jù)做服務(wù)化。
- 2.【推薦】
使用帶有連接池的數(shù)據(jù)庫(kù)戒财，可以有效控制連接热监，同時(shí)提高效率，標(biāo)準(zhǔn)使用方式：
執(zhí)行命令如下：
Jedis jedis = null;
try {
jedis = jedisPool.getResource();
//具體的命令
jedis.executeCommand()
} catch (Exception e) {
logger.error("op key {} error: " + e.getMessage(), key, e);
} finally {
//注意這里不是關(guān)閉連接饮寞，在JedisPool模式下孝扛，Jedis會(huì)被歸還給資源池。
if (jedis != null)
jedis.close();
}
下面是JedisPool優(yōu)化方法的文章:
Jedis常見(jiàn)異常匯總
JedisPool資源池優(yōu)化
- 3.【建議】
高并發(fā)下建議客戶端添加熔斷功能(例如netflix hystrix)
- 4.【推薦】
設(shè)置合理的密碼骂际，如有必要可以使用SSL加密訪問(wèn)（阿里云Redis支持）
- 5.【建議】
根據(jù)自身業(yè)務(wù)類型疗琉，選好maxmemory-policy(最大內(nèi)存淘汰策略)，設(shè)置好過(guò)期時(shí)間歉铝。
默認(rèn)策略是volatile-lru盈简，即超過(guò)最大內(nèi)存后，在過(guò)期鍵中使用lru算法進(jìn)行key的剔除，保證不過(guò)期數(shù)據(jù)不被刪除柠贤，但是可能會(huì)出現(xiàn)OOM問(wèn)題香浩。
其他策略如下：
`allkeys-lru`：根據(jù)LRU算法刪除鍵，不管數(shù)據(jù)有沒(méi)有設(shè)置超時(shí)屬性臼勉，直到騰出足夠空間為止邻吭。
`allkeys-random`：隨機(jī)刪除所有鍵，直到騰出足夠空間為止宴霸。
`volatile-random`:隨機(jī)刪除過(guò)期鍵囱晴，直到騰出足夠空間為止。
`volatile-ttl`：根據(jù)鍵值對(duì)象的ttl屬性瓢谢，刪除最近將要過(guò)期數(shù)據(jù)畸写。如果沒(méi)有，回退到noeviction策略氓扛。
`noeviction`：不會(huì)剔除任何數(shù)據(jù)枯芬，拒絕所有寫入操作并返回客戶端錯(cuò)誤信息"(error) OOM command not allowed when used memory"，此時(shí)Redis只響應(yīng)讀操作采郎。
四千所、相關(guān)工具
- 1.【推薦】：數(shù)據(jù)同步
redis間數(shù)據(jù)同步可以使用：redis-port
- 2.【推薦】：big key搜索
- 3.【推薦】：熱點(diǎn)key尋找(內(nèi)部實(shí)現(xiàn)使用monitor，所以建議短時(shí)間使用)
阿里云Redis已經(jīng)在內(nèi)核層面解決熱點(diǎn)key問(wèn)題蒜埋，歡迎使用淫痰。
五 附錄：刪除bigkey
1. 下面操作可以使用pipeline加速。
2. redis 4.0已經(jīng)支持key的異步刪除整份，歡迎使用黑界。
- 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);
}
- 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) {
//每次從左側(cè)截掉100個(gè)
jedis.ltrim(bigListKey, left, llen);
counter += left;
}
//最終刪除key
jedis.del(bigListKey);
}
- 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);
}
- 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);
}
