redigo源码解析

前言

redigo是用Go语言开发的Redis客户端,受到Redis官方的推荐

redigo的源码量比较少,也比较清晰易读。redigo主要做了以下事项

  • 与Redis server建立连接
  • 按照RESP协议组装指令
  • 向Redis server发用指令
  • 接收Redis server返回的数据
  • 将返回数据解析成Go的数据类型
  • 连接池(Pool),支持设置最大的活动连接数,最大的空闲连接数

源码概述

redigo主要使用了Go官方的net、io和bufio包,这些包是Go对网络连接,I/O,Buffered I/O的抽象实现。

在看Pool代码的过程中,对于如何控制最大连接数,笔者多花了一些时间才看明白。Pool使用buffered channel (可缓冲的管道,以下简称 buff chan) 来控制最大连接数。

首先看一下活动连接和空闲连接的定义

  • 活动连接:经Pool创建,未被关闭。这里的关闭是指关闭网络连接,也就是断开与Redis server的连接
  • 空闲连接:活动连接使用完之后,需交还给Pool,Pool会将连接放入空闲连接列表,列表中的连接数量就是空闲连接数

可以看出,活动连接是包含空闲连接的。

Pool原理解读

概述部分提到,Pool使用buff chan来控制最大连接数,这里也是源码中比较难以理解的地方,需要对Go的channel有较深的理解。

Go有两种channel,chan和 buff chan,它们的特性如下

  • chan,读写都是同步、阻塞操作。写操作阻塞,等待写入的数据被读取;读操作阻塞,等待数据写入。
  • buff chan,读操作和chan类似;写操作在缓冲区未满时非阻塞,否则阻塞等待缓冲区有空位。

Pool利用buff chan的缓冲区长度固定,及读操作的阻塞等待来控制最大连接数。

源码解析

redis/
| -- redis.go // 定义接口
| -- conn.go // 实现redis.go中定义的接口,用于与Redis server建立连接
| -- -- type conn struct // 链接结构体,实现了 redis.go中定义的Conn接口
| -- -- type dialOptions struct // 拨号选项,包括拨号器、拨号函数,超时配置,TLS配置等
| -- -- type DialOption struct // 拨号选项设置结构体,只包含函数f,用于修改拨号选项
| -- -- func Dial // 拨号函数,参数:网络协议,网络地址,拨号选项设置结构体,返回 conn
| -- -- func write* // 写命令函数,用于将命Redis指令写入buffer io
| -- reply.go // 将redis返回数据解析成go的数据类型

连接池如何用channel控制打开的连接数

redis/
| -- pool.go // Get()用于获取连接,Close()用于归还连接
| -- -- Pool.active // 活动连接数,每建立一个连接(Dial)active加1,每关闭(Close)一个连接,active减1
| -- -- Pool.ch chan struct{} // 用来控制最大的活动连接数
| -- -- Pool.lazyInit() // 将Pool.ch 初始化为buffered channel,长度为Pool.MaxActive,并将ch填满
| -- -- Pool.get() // 先从Pool.ch中取出一个元素,如果最终建立新连接(Dial)失败,再往ch写入一个元素
| -- -- Pool.put() // 往Pool.ch写入数据,所以get读取数据,put写入数据

IF Wait == 1 AND MaxActive > 0
AND MaxActive >= MaxIdle
AND MaxActive == 3 AND MaxIdle == 2

初始化:ch长度等于MaxActive, len(ch)=3
Pool.Get() 首先从ch读出数据, 如果新建连接失败,再向ch写入数据,len(ch)不变,否则len(ch)-1
GET#1-没有空闲连接,新建连接,len(ch)=2
GET#2-没有空闲连接,新建连接,len(ch)=1
GET#3-没有空闲连接,新建连接,len(ch)=0
GET#4-ch空了,所以ch读操作阻塞,直到有连接被归还,put()往ch中写入数据,ch读阻塞解除,继续往下获取空闲连接,否则只能等待。

这保证了最大活动连接数不会超过MaxActive。

部分源代码

func (p *Pool) Get() Conn {
    pc, err := p.get(nil)
    if err != nil {
        return errorConn{err}
    }
    return &activeConn{p: p, pc: pc}
}

func (p *Pool) get(ctx interface {
    Done() <-chan struct{}
    Err() error
}) (*poolConn, error) {

    // Handle limit for p.Wait == true.
    if p.Wait && p.MaxActive > 0 {
        p.lazyInit()        // 初始化ch 
        if ctx == nil {
            <-p.ch          // 从ch读数据,如果ch为空则阻塞等待
        } else {
            select {
            case <-p.ch:
            case <-ctx.Done():
                return nil, ctx.Err()
            }
        }
    }
    // ... ...
}

func (ac *activeConn) Close() error {
    // ... ...
    ac.p.put(pc, ac.state != 0 || pc.c.Err() != nil)
    return nil
}

func (p *Pool) put(pc *poolConn, forceClose bool) error {
    p.mu.Lock()
    
    // ... ...

    if p.ch != nil && !p.closed {
        p.ch <- struct{}{}    // 归还连接后往ch写入数据
    }
    p.mu.Unlock()
    return nil
}

参考链接

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容