mirror of
https://gitee.com/johng/gf.git
synced 2024-12-03 04:37:49 +08:00
102 lines
2.9 KiB
Go
102 lines
2.9 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package gredis
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/go-redis/redis/v8"
|
|
"github.com/gogf/gf/v2/errors/gerror"
|
|
|
|
"github.com/gogf/gf/v2/text/gstr"
|
|
)
|
|
|
|
// AdapterGoRedis is an implement of Adapter using go-redis.
|
|
type AdapterGoRedis struct {
|
|
client redis.UniversalClient
|
|
config *Config
|
|
}
|
|
|
|
const (
|
|
defaultPoolMaxIdle = 10
|
|
defaultPoolMaxActive = 100
|
|
defaultPoolIdleTimeout = 10 * time.Second
|
|
defaultPoolWaitTimeout = 10 * time.Second
|
|
defaultPoolMaxLifeTime = 30 * time.Second
|
|
defaultMaxRetries = -1
|
|
)
|
|
|
|
// NewAdapterGoRedis creates and returns a redis adapter using go-redis.
|
|
func NewAdapterGoRedis(config *Config) *AdapterGoRedis {
|
|
fillWithDefaultConfiguration(config)
|
|
client := redis.NewUniversalClient(&redis.UniversalOptions{
|
|
Addrs: gstr.SplitAndTrim(config.Address, ","),
|
|
Password: config.Pass,
|
|
DB: config.Db,
|
|
MaxRetries: defaultMaxRetries,
|
|
MinIdleConns: config.MinIdle,
|
|
MaxConnAge: config.MaxConnLifetime,
|
|
IdleTimeout: config.IdleTimeout,
|
|
PoolTimeout: config.WaitTimeout,
|
|
DialTimeout: config.DialTimeout,
|
|
ReadTimeout: config.ReadTimeout,
|
|
WriteTimeout: config.WriteTimeout,
|
|
MasterName: config.MasterName,
|
|
TLSConfig: config.TLSConfig,
|
|
})
|
|
return &AdapterGoRedis{
|
|
client: client,
|
|
config: config,
|
|
}
|
|
}
|
|
|
|
// Close closes the redis connection pool, which will release all connections reserved by this pool.
|
|
// It is commonly not necessary to call Close manually.
|
|
func (r *AdapterGoRedis) Close(ctx context.Context) (err error) {
|
|
if err = r.client.Close(); err != nil {
|
|
err = gerror.Wrap(err, `Redis Client Close failed`)
|
|
}
|
|
return
|
|
}
|
|
|
|
// Conn retrieves and returns a connection object for continuous operations.
|
|
// Note that you should call Close function manually if you do not use this connection any further.
|
|
func (r *AdapterGoRedis) Conn(ctx context.Context) (Conn, error) {
|
|
return &localAdapterGoRedisConn{
|
|
redis: r,
|
|
}, nil
|
|
}
|
|
|
|
func fillWithDefaultConfiguration(config *Config) {
|
|
// The MaxIdle is the most important attribute of the connection pool.
|
|
// Only if this attribute is set, the created connections from client
|
|
// can not exceed the limit of the server.
|
|
if config.MaxIdle == 0 {
|
|
config.MaxIdle = defaultPoolMaxIdle
|
|
}
|
|
// This value SHOULD NOT exceed the connection limit of redis server.
|
|
if config.MaxActive == 0 {
|
|
config.MaxActive = defaultPoolMaxActive
|
|
}
|
|
if config.IdleTimeout == 0 {
|
|
config.IdleTimeout = defaultPoolIdleTimeout
|
|
}
|
|
if config.WaitTimeout == 0 {
|
|
config.WaitTimeout = defaultPoolWaitTimeout
|
|
}
|
|
if config.MaxConnLifetime == 0 {
|
|
config.MaxConnLifetime = defaultPoolMaxLifeTime
|
|
}
|
|
if config.WriteTimeout == 0 {
|
|
config.WriteTimeout = -1
|
|
}
|
|
if config.ReadTimeout == 0 {
|
|
config.ReadTimeout = -1
|
|
}
|
|
}
|