扩展 Redis：增加 Redis 命令

关注

发布于: 2020 年 05 月 04 日

一、背景
Redis因高性能、轻量的优秀特性成了互联网公司缓存的标配，有的时候我们想增加一些自定义的命令，主要是重度使用Redis的场景，像抢购的场景，要保证多个Redis命令的事务性，如果没有很好的原子性保证，很容易出现数据不一致的问题，虽然官方给出事务的方案，但如果中间需要根据某个命令的返回值做判断才做下一步处理，则事务的方案就无法应对了。
﻿
今天我们以一个实际的案例讲述如何增加一个Redis命令，这个命令主要用于防刷的场景：
经常要将某个IP或某个用户封禁一段时间，如果不用这个命令的方案如下：
先incr下，然后判断是否为1，是1则设置过期时间。可以看到这样处理在高并发时如果第1个发起incr请求的客户端挂掉，则这个key不会过期。
今天要编写的这个命令用来保证这个事务性，在服务端保证如果key的值为1的时候设置过期时间。
﻿
命令用法如下：
incexpire key expireTime maxNum
﻿
key：要处理的key
expireTime：过期时间，单位为秒，如果写10，表示这个key到10秒之后过期；
maxNum：表示增加到多少为止不增加了，如果设为10，则返回的最大值就是11，返回11表示已经超出了；
﻿
二、编写命令
1、下载redis代码
本文所用Redis版本为3.2.11；
下载代码并切到3.2.11分支
git clone https://github.com/antirez/redis
git checkout 3.2.11
﻿
2、编写增加命令代码
1）在src/server.c中redisCommandTable结构体中增加新命令
﻿
struct redisCommand redisCommandTable[] = {
  ……
 {"incexpire",incrExpireCommand,4,"wm",0,NULL,1,1,1,0,0}
 };
﻿
redisCommandTable为一个数组，每个项表示一个redis命令，其中第一个表示命令的名字，第二个为实际处理的函数，第3个为参数的个数，其它的先不详细讨论。
﻿
2）在src/server.h增加函数声明：
void incrExpireCommand(client *c);
﻿
3）然后新增一个文件为ljh.c（名字自己定)，加入以下代码：
#include "server.h"
﻿
void incrExpireCommand(client *c) {
    incrDecrExpireCommand(c,1);
}
﻿
/**
incr expire command
incr key expireTime maxNum
*/
void incrDecrExpireCommand(client *c, long long incr) {
    long long value, oldValue, when;
    robj *o, *new, *rExpireTime, *rMaxNum, *key;
  char* str;
  int expireNum, maxNum;
  u_char isExpired=0;
﻿
  rExpireTime = c->argv[2];
  rMaxNum = c->argv[3];
﻿
//检查过期时间参数
 str = (char*)rExpireTime->ptr;
  expireNum = atoi(str);
  if (expireNum < 0){
    addReplyError(c,"increxpire command expireNum param must bigger or equal than 0");
        return;
  }
  //check maxNum
  str = (char*)rMaxNum->ptr;
  maxNum = atoi(str);
  if (maxNum < 0){
    addReplyError(c,"increxpire command maxNum param must bigger or equal than 0");
        return;
  }
﻿
  //查找key是否存在
    o = lookupKeyWrite(c->db,c->argv[1]);
    if (o != NULL && checkType(c,o,OBJ_STRING)) return;
    if (getLongLongFromObjectOrReply(c,o,&value,NULL) != C_OK) return;
﻿
    oldValue = value;
    if ((incr < 0 && oldValue < 0 && incr < (LLONG_MIN-oldValue)) ||
        (incr > 0 && oldValue > 0 && incr > (LLONG_MAX-oldValue))) {
        addReplyError(c,"increment or decrement will overflow");
        return;
    }
    
  if (0 == oldValue){
    //expired 
    isExpired = 1;
  }else if (value >= (maxNum+1)){
  //如果大于等于最大值，则直接返回
    addReply(c,shared.colon);
    addReply(c, o);
    addReply(c,shared.crlf);
    return;
  }
﻿
  //添加步长值
    value += incr;
    new = createStringObjectFromLongLong(value);
    if (o){
        dbOverwrite(c->db,c->argv[1],new);
    }else{
    dbAdd(c->db,c->argv[1],new);
    //第一次不存在，添加key之后还要设置过期时间
    key = c->argv[1];
    when = mstime();
    when += expireNum * 1000;
    setExpire(c->db, key, when);
        //signalModifiedKey(c->db,key);
        notifyKeyspaceEvent(NOTIFY_GENERIC,"expire", key, c->db->id);
    }
    
    //redis事件
    signalModifiedKey(c->db,c->argv[1]);
    notifyKeyspaceEvent(NOTIFY_STRING,"isxpired",c->argv[1],c->db->id);
    server.dirty++;
    
    //返回最新的值
    addReply(c,shared.colon);
    addReply(c,new);
    addReply(c,shared.crlf);
}
﻿
4）在src/Makefile中增加新文件 ljh.o
﻿
 REDIS_SERVER_OBJ=adlist.o quicklist.o ae.o anet.o dict.o server.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking    .o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.    o cluster.o crc16.o endianconv.o slowlog.o scripting.o bio.o rio.o rand.o memtest.o crc64.o bitops.o sentinel.o notify.o setproctitle.o blocked.o hyperlo    glog.o latency.o sparkline.o redis-check-rdb.o geo.o slots.o slots_async.o crc32.o oneplus.o cJSON.o ljh.o
﻿
执行效果如下
﻿
可以看到，key1增加到11之后不再增加，并且过了10秒之后，又变成1了。
﻿
三、写在最后
最后我们还是要问自己我们的场景中是否有增加Redis命令的必要，如果需要则要把握好各层之间的职责，不要让Redis最后变成处理业务去了；一般来说中间件层一般处理比较通用的功能，越到下面的层应该越稳定，越少改动才是正常的情况。
﻿
从一次线上故障来看redis删除机制
一次线上Mysql死锁分析
直播评论系统分析设计
RabbitMQ网络框架代码分析二：命令分发
RabbitMQ网络框架代码分析
﻿
﻿