Go语言的go-redis模块连接池参数配置

版权所有，请勿转载

2022-09-16 更新：版本6在MinIdleConns最小连接数的维持上存在一个BUG，需要升级到v7.0.0以上 

go-redis模块自带连接池，所有参数都是可选的，参数配置说明示例如下：

package main

import (
	"fmt"
	"github.com/go-redis/redis"
	"net/http"
	"net"
	"time"
)

var gClient *redis.Client

func handler(w http.ResponseWriter, r *http.Request) {
	gClient.Ping().Result()
	printRedisPool(gClient.PoolStats())
	fmt.Fprintf(w, "Hello")
}

func printRedisPool(stats *redis.PoolStats) {
	fmt.Printf("Hits=%d Misses=%d Timeouts=%d TotalConns=%d IdleConns=%d StaleConns=%d\n",
		stats.Hits, stats.Misses, stats.Timeouts, stats.TotalConns, stats.IdleConns, stats.StaleConns)
}

func printRedisOption(opt *redis.Options) {
	fmt.Printf("Network=%v\n", opt.Network)
	fmt.Printf("Addr=%v\n", opt.Addr)
	fmt.Printf("Password=%v\n", opt.Password)
	fmt.Printf("DB=%v\n", opt.DB)
	fmt.Printf("MaxRetries=%v\n", opt.MaxRetries)
	fmt.Printf("MinRetryBackoff=%v\n", opt.MinRetryBackoff)
	fmt.Printf("MaxRetryBackoff=%v\n", opt.MaxRetryBackoff)
	fmt.Printf("DialTimeout=%v\n", opt.DialTimeout)
	fmt.Printf("ReadTimeout=%v\n", opt.ReadTimeout)
	fmt.Printf("WriteTimeout=%v\n", opt.WriteTimeout)
	fmt.Printf("PoolSize=%v\n", opt.PoolSize)
	fmt.Printf("MinIdleConns=%v\n", opt.MinIdleConns)
	fmt.Printf("MaxConnAge=%v\n", opt.MaxConnAge)
	fmt.Printf("PoolTimeout=%v\n", opt.PoolTimeout)
	fmt.Printf("IdleTimeout=%v\n", opt.IdleTimeout)
	fmt.Printf("IdleCheckFrequency=%v\n", opt.IdleCheckFrequency)
	fmt.Printf("TLSConfig=%v\n", opt.TLSConfig)

}

func main() {
	gClient = redis.NewClient(&redis.Options{
		//连接信息
		Network:  "tcp",                  //网络类型，tcp or unix，默认tcp
		Addr:     "127.0.0.1:6379", //主机名+冒号+端口，默认localhost:6379
		Password: "",                     //密码
		DB:       0,                      // redis数据库index

		//连接池容量及闲置连接数量
		PoolSize:     15, // 连接池最大socket连接数，默认为4倍CPU数， 4 * runtime.NumCPU
		MinIdleConns: 10, //在启动阶段创建指定数量的Idle连接，并长期维持idle状态的连接数不少于指定数量；。

		//超时
		DialTimeout:  5 * time.Second, //连接建立超时时间，默认5秒。
		ReadTimeout:  3 * time.Second, //读超时，默认3秒， -1表示取消读超时
		WriteTimeout: 3 * time.Second, //写超时，默认等于读超时
		PoolTimeout:  4 * time.Second, //当所有连接都处在繁忙状态时，客户端等待可用连接的最大等待时长，默认为读超时+1秒。

		//闲置连接检查包括IdleTimeout，MaxConnAge
		IdleCheckFrequency: 60 * time.Second, //闲置连接检查的周期，默认为1分钟，-1表示不做周期性检查，只在客户端获取连接时对闲置连接进行处理。
		IdleTimeout:        5 * time.Minute,  //闲置超时，默认5分钟，-1表示取消闲置超时检查
		MaxConnAge:         0 * time.Second,  //连接存活时长，从创建开始计时，超过指定时长则关闭连接，默认为0，即不关闭存活时长较长的连接

		//命令执行失败时的重试策略
		MaxRetries:      0,                      // 命令执行失败时，最多重试多少次，默认为0即不重试
		MinRetryBackoff: 8 * time.Millisecond,   //每次计算重试间隔时间的下限，默认8毫秒，-1表示取消间隔
		MaxRetryBackoff: 512 * time.Millisecond, //每次计算重试间隔时间的上限，默认512毫秒，-1表示取消间隔

		//可自定义连接函数
		Dialer: func() (net.Conn, error) {
			netDialer := &net.Dialer{
				Timeout:   5 * time.Second,
				KeepAlive: 5 * time.Minute,
			}
			return netDialer.Dial("tcp", "127.0.0.1:6379")
		},

		//钩子函数
		OnConnect: func(conn *redis.Conn) error { //仅当客户端执行命令时需要从连接池获取连接时，如果连接池需要新建连接时则会调用此钩子函数
			fmt.Printf("conn=%v\n", conn)
			return nil
		},

	})
	defer gClient.Close()

	printRedisOption(gClient.Options())
	printRedisPool(gClient.PoolStats())

	http.HandleFunc("/", handler)

	http.ListenAndServe(":8080", nil)
}

除上述参数外，另外还有一个   TLSConfig *tls.Config 参数，用于支持Redis TLS连接的。Redis从版本6开始支持TLS连接。

和参数配置相关的报错：

参数名称	报错信息示例
DialTimeout	dial tcp 127.0.0.1:6379: i/o timeout
PoolTimeout	error:redis: connection pool timeout
ReadTimeout	read tcp 127.0.0.1:43267->127.0.0.1:6379: i/o timeout
WriteTimeout	write tcp 127.0.0.1:43290->127.0.0.1:6379: i/o timeout

版本6在MinIdleConns最小连接数的维持上存在一个BUG，idleConnsLen先加1，再执行addIdleConn,如果该函数创建连接报错也不做idleConnsLen减1，这样会导致idleConnsLen比实际可用的闲置连接数大，最后会导致MinIdleConns的检查失效。需要至少升级到v7.0.0以上。

func (p *ConnPool) checkMinIdleConns() {
        if p.opt.MinIdleConns == 0 {
                return
        }
        if p.poolSize < p.opt.PoolSize && p.idleConnsLen < p.opt.MinIdleConns {
                p.poolSize++
                p.idleConnsLen++
                go p.addIdleConn()
        }
}

func (p *ConnPool) addIdleConn() {
        cn, err := p.newConn(true)
        if err != nil {
                return
        }

        p.connsMu.Lock()
        p.conns = append(p.conns, cn)
        p.idleConns = append(p.idleConns, cn)
        p.connsMu.Unlock()
}

相关文章：

《Go语言采用go-redis模块对Redis进行批量操作(MULTI和EXEC) 的示例及性能》

《Go语言的go-redis模块如何在启动阶段检测连接是否可创建》