摘要:本文介绍了在使用阿里云 Redis 的开发规范,从键值设计、命令使用、客户端使用、相关工具等方面进行说明,通过本文的介绍可以减少使用 Redis 过程带来的问题。

本文转自https://yq.aliyun.com/articles/531067,对原文进行了适当的排版优化和补充完善。

一、键名设计(Key)

1. 【建议】可读性和可管理性

以业务名(或数据库名)为前缀(防止 key 冲突),用冒号分隔。
比如“业务名:表名:id”:ugc:video:1

2. 【建议】简洁性

保证语义的前提下,控制 key 的长度,当 key 较多时,内存占用也不容忽视。
比如user:{uid}:friends:messages:{mid}简化为u:{uid}:fr:m:{mid}

3. 【强制】不要包含特殊字符

反例:包含空格换行单双引号以及其他转义字符

详细解析参考Redis开发规范解析(一)--键名设计

二、键值设计(Value)

1. 【强制】拒绝 bigkey(防止网卡流量、慢查询)

string类型控制在10KB以内,hashlistsetzset元素个数不要超过5000。
反例:一个包含200万个元素的list

非字符串的 bigkey,不要使用del删除,使用hscansscanzscan方式渐进式删除,同时要注意防止 bigkey 过期时间自动删除问题。
例如:一个200万的zset设置1小时过期,会触发del操作,造成阻塞,而且该操作不会出现在慢查询中(latency 可查)。

详细解析参考Redis开发规范解析(二)--老生常谈bigkey

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的数量

例如hgetalllrangesmemberszrangesinter等并非不能使用,但是需要明确N的值。 有遍历的需求可以使用hscansscanzscan代替。

2. 【推荐】禁用命令

禁止线上使用keysflushallflushdb等,通过 Redis 的rename机制禁掉命令。如果需要实现keys功能,可以使用scan的方式渐进式处理。

3. 【推荐】合理使用select

Redis 的多数据库较弱,使用数字进行区分,很多客户端支持较差,同时多业务用多数据库实际还是单线程处理,会有干扰。

4. 【推荐】使用批量操作提高效率

原生命令:例如mgetmset。 非原生命令:可以使用pipeline提高效率。 但要注意控制一次批量操作的元素个数(例如500以内,实际也和元素字节数有关)。

注意两者不同:

  • 原生是原子操作,pipeline是非原子操作
  • pipeline可以打包不同的命令,原生做不到
  • pipeline需要客户端和服务端同时支持

5. 【建议】Redis事务功能较弱,不建议过多使用

Redis 的事务功能较弱(不支持回滚),而且集群版本(自研和官方)要求一次事务操作的 key 必须在一个 slot 上(可以使用 hashtag 功能解决同一个 slot 的问题)。

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 命令时不要长时间使用

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();
}

下面是 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 间数据同步可以使用 CodisLabs 的redis-port

2. 【推荐】big key搜索

使用redis-cli --bigkeysRedis大key搜索工具,内部使用SCAN来操作,不用担心阻塞问题。

3. 【推荐】热点key寻找

使用Facebook的redis-faina,其内部实现使用monitor实现,所以建议短时间使用。

阿里云 Redis 已经在内核层面解决热点 key 问题,欢迎使用。

六、附录:删除bigkey

以下列举几种删除 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);
}

本文来自《阿里云 Redis 开发规范》- 熊清亮的博客。

转载请注明原文链接:https://seealso.cn/spec/aliyun-redis-dev-spec