阿里巴巴官方最新Redis开发规范！

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
本文主要介绍在使用阿里云Redis的开发规范，从下面几个方面进行说明。
键值设计
命令使用
客户端使用
相关工具
通过本文的介绍可以减少使用Redis过程带来的问题。
一、键值设计1、key名设计可读性和可管理性
以业务名(或数据库名)为前缀(防止key冲突)，用冒号分隔，比如业务名:表名:id
ugc:video:1简洁性
保证语义的前提下，控制key的长度，当key较多时，内存占用也不容忽视，例如：
user:{uid}:friends:messages:{mid}简化为u:{uid}:fr:m:{mid}。不要包含特殊字符
反例：包含空格、换行、单双引号以及其他转义字符
2、value设计拒绝bigkey
防止网卡流量、慢查询，string类型控制在10KB以内，hash、list、set、zset元素个
数不要超过5000。
反例：一个包含200万个元素的list。
非字符串的bigkey，不要使用del删除，使用hscan、sscan、zscan方式渐进式删除，
同时要注意防止bigkey过期时间自动删除问题(例如一个200万的zset设置1小时过
期，会触发del操作，造成阻塞，而且该操作不会不出现在慢查询中(latency可查))
，查找方法和删除方法 选择适合的数据类型
例如：实体类型(要合理控制和使用数据结构内存编码优化配置,例如ziplist，但也
要注意节省内存和性能之间的平衡) 反例：
set user:1:name tomset user:1:age =19set user:1:favor football正例：
hmset user:1 name tom age =19 favor football控制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 arrayrn"2、所有key，必须在1个slot上，否则直接返回error, "-ERR eval/evalsha command
keys must in same slotrn"
7、monitor命令
必要情况下使用monitor命令时，要注意不要长时间使用。
三、客户端使用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 阿里云Redis已
经在内核层面解决热点key问题
五、删除bigkey下面操作可以使用pipeline加速。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);}