这周学习了一下Redis事务功能的实现原理,本来是想用一篇文章进行总结的,写完以后发现这块内容比较多,而且多个命令之间又互相依赖,放在一篇文章里一方面篇幅会比较大,另一方面文章组织结构会比较乱,不容易阅读。因此把事务这个模块整理成上下两篇文章进行总结。
这篇文章我们重点分析一下redis事务命令中的两个辅助命令:watch跟unwatch。
一、redis事务辅助命令简介
依然从server.c文件的命令表中找到相应的命令以及它们对应的处理函数。
//watch,unwatch两个命令我们把它们叫做redis事务辅助命令
{
"watch",watchCommand,
-2,
"sF",
0,
NULL,
1,
-1,
1,
0,
0},
{
"unwatch",unwatchCommand,
1,
"sF",
0,
NULL,
0,
0,
0,
0,
0},
watch,用于客户端关注某个key,当这个key的值被修改时,整个事务就会执行失败(注:该命令需要在事务开启前使用)。
unwatch,用于客户端取消已经watch的key。
用法举例如下:
clientA
127.0.
0.1:
6379> watch a
OK
127.0.
0.1:
6379> multi
OK
127.0.
0.1:
6379>
set b b
QUEUED
//在执行前插入clientB的操作如下,事务就会执行失败
127.0.
0.1:
6379> exec
(
nil)
127.0.
0.1:
6379>
clientB
127
.0.0.1:6379>
set a aa
OK
127
.0.0.1:6379>
二、redis事务辅助命令源码分析
在看具体执行函数之前首先了解几个数据结构:
//每个客户端对象中有一个watched_keys链表来保存已经watch的key
typedef struct client {
list *watched_keys;
}
//上述链表中每个节点的数据结构
typedef struct watchedKey {
//watch的key
robj *key;
//指向的DB,后面细说
redisDb *db;
} watchedKey;
关于事务的几个命令所对应的函数都放在了multi.c文件中。
一起看下watch命令对应处理函数的源码:
void watchCommand(client *c) {
int j;
//如果客户端处于事务状态,则返回错误信息
//由此可以看出,watch必须在事务开启前使用
if (c->flags & CLIENT_MULTI) {
addReplyError(c,
"WATCH inside MULTI is not allowed");
return;
}
//依次watch客户端的各个参数(这里说明watch命令可以一次watch多个key)
//注:0表示命令本身,所以参数从1开始
for (j =
1; j < c->argc; j++)
watchForKey(c,c->argv[j]);
//返回结果
addReply(c,shared.ok);
}
//具体的watch操作,代码较长,慢慢分析
void watchForKey(client *c, robj *key) {
list *clients =
NULL;
listIter li;
listNode *ln;
//上面已经提到了数据结构
watchedKey *wk;
//首先判断key是否已经被客户端watch
//listRewind这个函数在发布订阅那篇文章里也有,就是把客户端的watched_keys赋值给li
listRewind(c->watched_keys,&li);
while((ln = listNext(&li))) {
wk = listNodeValue(ln);
//这里一个wk节点中有db,key两个字段
if (wk->db == c->db && equalStringObjects(key,wk->key))
return;
}
//开始watch指定key
//整个watch操作保存了两套数据结构,一套是在db->watched_keys中的字典结构,如下:
clients = dictFetchValue(c->db->watched_keys,key);
//如果是key第一次出现,则进行初始化
if (!clients) {
clients = listCreate();
dictAdd(c->db->watched_keys,key,clients);
incrRefCount(key);
}
//把当前客户端加到该key的watch链表中
listAddNodeTail(clients,c);
//另一套是在c->watched_keys中的链表结构:如下
wk = zmalloc(sizeof(*wk));
//初始化各个字段
wk->key = key;
wk->db = c->db;
incrRefCount(key);
//加入到链表最后
listAddNodeTail(c->watched_keys,wk);
}
整个watch的数据结构比较复杂,我这里画了一张图方便理解:
简单解释一下上面的图,首先redis把每个客户端连接包装成了一个client对象,上图中db,watch_keys就是其中的两个字段(client对象里面还有很多其他字段,包括上篇文章中提到的pub/sub)。