阿里云Redis开发规范

• (1)【建议】: 可读性和可管理性

以业务名(或数据库名)为前缀(防止key冲突)，用冒号分隔，比如业务名:表名:id

<span class="hljs-selector-tag">ugc<span class="hljs-selector-pseudo">:video<span class="hljs-selector-pseudo">:1</span></span></span>

• (2)【建议】：简洁性

保证语义的前提下，控制key的长度，当key较多时，内存占用也不容忽视，例如：

<span class="hljs-symbol">user:{uid}<span class="hljs-symbol">:friends<span class="hljs-symbol">:messages<span class="hljs-symbol">:{mid}&#x7B80;&#x5316;&#x4E3A;<span class="hljs-symbol">u:{uid}<span class="hljs-symbol">:fr<span class="hljs-symbol">:m<span class="hljs-symbol">:{mid}&#x3002;</span></span></span></span></span></span></span></span>

• (3)【强制】：不要包含特殊字符

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

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

string类型控制在10KB以内，hash、list、set、zset元素个数不要超过5000。

反例：一个包含200万个元素的list。

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

• (2)【推荐】：选择适合的数据类型。

例如：实体类型(要合理控制和使用数据结构内存编码优化配置,例如ziplist，但也要注意节省内存和性能之间的平衡)

反例：

<span class="hljs-keyword">set <span class="hljs-keyword">user:<span class="hljs-number">1:<span class="hljs-keyword">name tom
<span class="hljs-keyword">set <span class="hljs-keyword">user:<span class="hljs-number">1:age <span class="hljs-number">19
<span class="hljs-keyword">set <span class="hljs-keyword">user:<span class="hljs-number">1:favor football</span></span></span></span></span></span></span></span></span></span></span>

正例:

<span class="hljs-selector-tag">hmset <span class="hljs-selector-tag">user<span class="hljs-selector-pseudo">:1 <span class="hljs-selector-tag">name <span class="hljs-selector-tag">tom <span class="hljs-selector-tag">age 19 <span class="hljs-selector-tag">favor <span class="hljs-selector-tag">football</span></span></span></span></span></span></span></span>

建议使用expire设置过期时间(条件允许可以打散过期时间，防止集中过期)，不过期的数据重点关注idletime。

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

禁止线上使用keys、flushall、flushdb等，通过redis的rename机制禁掉命令，或者使用scan的方式渐进式处理。

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

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

但要注意控制一次批量操作的元素个数(例如500以内，实际也和元素字节数有关)。

注意两者不同：

<span class="hljs-bullet">1. &#x539F;&#x751F;&#x662F;&#x539F;&#x5B50;&#x64CD;&#x4F5C;&#xFF0C;pipeline&#x662F;&#x975E;&#x539F;&#x5B50;&#x64CD;&#x4F5C;&#x3002;
<span class="hljs-bullet">2. pipeline&#x53EF;&#x4EE5;&#x6253;&#x5305;&#x4E0D;&#x540C;&#x7684;&#x547D;&#x4EE4;&#xFF0C;&#x539F;&#x751F;&#x505A;&#x4E0D;&#x5230;
<span class="hljs-bullet">3. pipeline&#x9700;&#x8981;&#x5BA2;&#x6237;&#x7AEF;&#x548C;&#x670D;&#x52A1;&#x7AEF;&#x540C;&#x65F6;&#x652F;&#x6301;&#x3002;</span></span></span>

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

• 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”

避免多个应用使用一个Redis实例

正例：不相干的业务拆分，公共数据做服务化。

使用带有连接池的数据库，可以有效控制连接，同时提高效率，标准使用方式：

执行命令如下：
Jedis jedis = <span class="hljs-keyword">null;
<span class="hljs-keyword">try {
    jedis = jedisPool.getResource();
    </span></span>

下面是JedisPool优化方法的文章:

高并发下建议客户端添加熔断功能(例如netflix hystrix)

设置合理的密码，如有必要可以使用SSL加密访问（阿里云Redis支持）

根据自身业务类型，选好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只响应读操作。

redis间数据同步可以使用：redis-port

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

五 附录：删除bigkey

<span class="hljs-bullet">1. &#x4E0B;&#x9762;&#x64CD;&#x4F5C;&#x53EF;&#x4EE5;&#x4F7F;&#x7528;pipeline&#x52A0;&#x901F;&#x3002;
<span class="hljs-bullet">2. redis 4.0&#x5DF2;&#x7ECF;&#x652F;&#x6301;key&#x7684;&#x5F02;&#x6B65;&#x5220;&#x9664;&#xFF0C;&#x6B22;&#x8FCE;&#x4F7F;&#x7528;&#x3002;</span></span>

public <span class="hljs-keyword">void delBigHash(<span class="hljs-built_in">String host, int port, <span class="hljs-built_in">String password, <span class="hljs-built_in">String bigHashKey) {
    Jedis jedis = <span class="hljs-keyword">new Jedis(host, port);
    <span class="hljs-keyword">if (password != <span class="hljs-literal">null && !<span class="hljs-string">"".equals(password)) {
        jedis.auth(password);
    }
    ScanParams scanParams = <span class="hljs-keyword">new ScanParams().count(<span class="hljs-number">100);
    <span class="hljs-built_in">String cursor = <span class="hljs-string">"0";
    <span class="hljs-keyword">do {
        ScanResult<entry<<span class="hljs-built_in">String, <span class="hljs-built_in">String>> scanResult = jedis.hscan(bigHashKey, cursor, scanParams);
        List<entry<<span class="hljs-built_in">String, <span class="hljs-built_in">String>> entryList = scanResult.getResult();
        <span class="hljs-keyword">if (entryList != <span class="hljs-literal">null && !entryList.isEmpty()) {
            <span class="hljs-keyword">for (Entry<<span class="hljs-built_in">String, <span class="hljs-built_in">String> entry : entryList) {
                jedis.hdel(bigHashKey, entry.getKey());
            }
        }
        cursor = scanResult.getStringCursor();
    } <span class="hljs-keyword">while (!<span class="hljs-string">"0".equals(cursor));

    </span></span></span></span></span></span></span></span></entry<<span></span></entry<<span></span></span></span></span></span></span></span></span></span></span></span></span></span>

<span class="hljs-function"><span class="hljs-keyword">public <span class="hljs-keyword">void <span class="hljs-title">delBigList(<span class="hljs-params">String host, <span class="hljs-keyword">int port, String password, String bigListKey) {
    Jedis jedis = <span class="hljs-keyword">new Jedis(host, port);
    <span class="hljs-keyword">if (password != <span class="hljs-literal">null && !<span class="hljs-string">"".equals(password)) {
        jedis.auth(password);
    }
    <span class="hljs-keyword">long llen = jedis.llen(bigListKey);
    <span class="hljs-keyword">int counter = <span class="hljs-number">0;
    <span class="hljs-keyword">int left = <span class="hljs-number">100;
    <span class="hljs-keyword">while (counter < llen) {
        </span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

public <span class="hljs-keyword">void delBigSet(<span class="hljs-built_in">String host, int port, <span class="hljs-built_in">String password, <span class="hljs-built_in">String bigSetKey) {
    Jedis jedis = <span class="hljs-keyword">new Jedis(host, port);
    <span class="hljs-keyword">if (password != <span class="hljs-literal">null && !<span class="hljs-string">"".equals(password)) {
        jedis.auth(password);
    }
    ScanParams scanParams = <span class="hljs-keyword">new ScanParams().count(<span class="hljs-number">100);
    <span class="hljs-built_in">String cursor = <span class="hljs-string">"0";
    <span class="hljs-keyword">do {
        ScanResult<<span class="hljs-built_in">String> scanResult = jedis.sscan(bigSetKey, cursor, scanParams);
        List<<span class="hljs-built_in">String> memberList = scanResult.getResult();
        <span class="hljs-keyword">if (memberList != <span class="hljs-literal">null && !memberList.isEmpty()) {
            <span class="hljs-keyword">for (<span class="hljs-built_in">String member : memberList) {
                jedis.srem(bigSetKey, member);
            }
        }
        cursor = scanResult.getStringCursor();
    } <span class="hljs-keyword">while (!<span class="hljs-string">"0".equals(cursor));

    </span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span></span>

public <span class="hljs-keyword">void delBigZset(<span class="hljs-built_in">String host, int port, <span class="hljs-built_in">String password, <span class="hljs-built_in">String bigZsetKey) {
    Jedis jedis = <span class="hljs-keyword">new Jedis(host, port);
    <span class="hljs-keyword">if (password != <span class="hljs-literal">null && !<span class="hljs-string">"".equals(password)) {
        jedis.auth(password);
    }
    ScanParams scanParams = <span class="hljs-keyword">new ScanParams().count(<span class="hljs-number">100);
    <span class="hljs-built_in">String cursor = <span class="hljs-string">"0";
    <span class="hljs-keyword">do {
        ScanResult<tuple> scanResult = jedis.zscan(bigZsetKey, cursor, scanParams);
        List<tuple> tupleList = scanResult.getResult();
        <span class="hljs-keyword">if (tupleList != <span class="hljs-literal">null && !tupleList.isEmpty()) {
            <span class="hljs-keyword">for (Tuple tuple : tupleList) {
                jedis.zrem(bigZsetKey, tuple.getElement());
            }
        }
        cursor = scanResult.getStringCursor();
    } <span class="hljs-keyword">while (!<span class="hljs-string">"0".equals(cursor));

    </span></span></span></span></span></tuple></tuple></span></span></span></span></span></span></span></span></span></span></span></span></span>

Original: https://www.cnblogs.com/Alight/p/9596982.html
Author: 一束光
Title: 阿里云Redis开发规范