準備工作

這篇文章不會告訴你啥是redis，如果不瞭解請自行搜尋學習。

我的操作環境是cent OS 6.5系統，vim編輯器。

我打算下載一個比較穩定的redis原始碼包進行修改測試。

$ wget http://download.redis.io/redis-stable.tar.gz

$ tar -zxvf redis-stable.tar.gz

$ cd redis-stable

進入redis-stable目錄可以看到src目錄，裡面是redis的實現原始碼，我下面的工作基本就是修改這裡面的內容。

我打算增加一條自定義的命令，並希望由此學習redis究竟是如何處理一條命令的。在此之前先看看redis自帶的命令是怎麼玩的。

[[email protected] bin]# redis-server /etc/redis/redis.conf 
[[email protected] bin]# redis-cli 
127.0.0.1:6379> set "pony" "大帥哥"
OK
127.0.0.1:6379> get "pony"
"大帥哥"
127.0.0.1:6379> 

正式開始

我打算加入的命令叫STRUPPER，這條命令後面跟一個引數，也是key，返回key所對應的value的字母大寫轉換後的結果。比如key的值是”test”,那麼strupper key就返回”TEST”。

看起來似乎是一條沒有任何意義的命令(事實也是這樣，哈哈), 但是請明白我在意的不是命令本身，而是redis的命令處理機制。

在src/server.c中定義了redis的命令表，

struct redisCommand redisCommandTable[] = {
    {"get",getCommand,2,"rF",0,NULL,1,1,1,0,0},
    {"set",setCommand,-3,"wm",0,NULL,1,1,1,0,0},
    {"setnx",setnxCommand,3,"wmF",0,NULL,1,1,1,0,0},
    {"setex",setexCommand,4
 
,"wm",0,NULL,1,1,1,0,0},

    ...

從程式碼中的註釋，我瞭解到如果要增加一條命令，應該首先在這個表中增加一行定義。並且我還了解到結構體的每個欄位的意義。

拿第一行舉例，”get”是命令的名字，getCommand是一個函式指標，型別是:

typedef void redisCommandProc(client *c);

2表示引數的數量，比如get命令的用法是get後面跟key，第一個引數是get本身，第二個引數是key。

“rF”是標識命令的屬性，r表示只讀，也就是這條命令不能修改key對應的value值。F表示這是條”快命令”,就是時間複雜度是O(1)或者O(log(N))。

緊接著的0暫時不用管，總是設定為0就行。

接下來的NULL域，大部分時候這個域都應該是NULL。少數時候可以放一個函式指標，用在命令後面引數比較多的時候，分不清哪個是key。

接下來的三個數字，對於get命令，第一個引數（key）在位置1上，最後一個引數（也是key）在位置1上，從第一個引數到最後一個引數的增量也是1。

最後兩個域總是初始化為0。

基於以上分析，我加了命令表底部加了一條命令:

{"strupper",strupperCommand,2,"w",0,NULL,1,1,1,0,0}

然後我需要在server.h中宣告下命令處理函式，

void strupperCommand(client *c);

函式的實現應該放在哪裡？ redis是根據命令的型別來分類存放的，比如像getCommand和setCommand這樣的字串操作函式都是放在t_string.c檔案中實現的，strupper也算是字串處理函式，所以自然也是定義到這裡，我先定義一個空函式。

void strupperCommand(client *c)
{
}

到這裡，我先編譯下看看效果。

[[email protected] redis-stable]# make
[[email protected] redis-stable]# make install

[[email protected] bin]# redis-server /etc/redis/redis.conf
[[email protected] bin]# redis-cli
127.0.0.1:6379> 
127.0.0.1:6379> set pony "test"
OK
127.0.0.1:6379> strupper
(error) ERR wrong number of arguments for 'strupper' command
127.0.0.1:6379> strupper pony

可以看出，當我執行strupper pony時卡住了，是因為函式是空的還沒實現。實現也是非常簡單，

void strupperCommand(client *c)
{
    robj *o;

    if ((o = lookupKeyReadOrReply(c,c->argv[1],shared.nullbulk)) == NULL)
        return;

    if (o->type != OBJ_STRING) {
        addReply(c,shared.wrongtypeerr);
        return;
    } else {

        if (sdsEncodedObject(o)) 
        {
            sdstoupper(o->ptr);
        }
        addReplyBulk(c,o);
        return;
    }
}

大部分程式碼都是參考了get命令(因為這兩個命令實在是太像了)，我只需把get取出來的value值轉換成大寫就行了，當然一些基本的檢查也是必須的。

lookupKeyReadOrReply函式根據傳入的key(c->argv[1])查詢，如果找到了會返回一個redis object物件,我們要的value就在這個物件裡。

addReply負責響應結果到客戶端。

sdsEncodedObject確保只對OBJ_ENCODING_RAW和OBJ_ENCODING_EMBSTR編碼的string物件進行操作，這樣才能用sdsXXX這樣的函式操作。

sdstoupper可以對字串整體進行大寫轉換。

重新編譯下，測試。

127.0.0.1:6379> set pony "test"
OK
127.0.0.1:6379> 
127.0.0.1:6379> get pony
"test"
127.0.0.1:6379> strupper pony
"TEST"

結果跟預想的一樣。是個好的開始，後面再慢慢深入研究redis。

參考