save code

client.go

@@ -18,10 +18,15 @@ import (
 	wrapperOperate "git.zhangdeman.cn/zhangdeman/wrapper"
 	redisClient "github.com/go-redis/redis/v8"
 	"github.com/pkg/errors"
+	redisClientV9 "github.com/redis/go-redis/v9"
 	"go.uber.org/zap"
 )
 
-var Client abstract.IRedisClient
+var (
+	Client        abstract.IRedisClient
+	ClientV9      abstract.IRedisClient
+	ClientVersion = define.ClientVersionV8
+)
 
 func init() {
 	Client = &OwnClient{
@@ -29,6 +34,11 @@ func init() {
 		instanceTable:     make(map[string]*redisClient.ClusterClient),
 		whiteCommandTable: make(map[string]bool),
 	}
+	ClientV9 = &OwnClientV9{
+		lock:              &sync.RWMutex{},
+		instanceTable:     make(map[string]*redisClientV9.ClusterClient),
+		whiteCommandTable: make(map[string]bool),
+	}
 }
 
 type OwnClient struct {
@@ -143,8 +153,8 @@ func (o *OwnClient) GetRealClientWithError(instanceFlag string) (*redisClient.Cl
 
 func (o *OwnClient) AddClient(instanceFlag string, instanceConfig *define.ClusterOptions) error {
 	instance := redisClient.NewClusterClient(&redisClient.ClusterOptions{
-		Addrs:          instanceConfig.Addrs,
+		Addrs: instanceConfig.Addrs,
-		ClientName:     instanceConfig.ClientName,
+		// ClientName:     instanceConfig.ClientName,
 		NewClient:      nil,
 		MaxRedirects:   instanceConfig.MaxRedirects,
 		ReadOnly:       instanceConfig.ReadOnly,
@@ -155,29 +165,29 @@ func (o *OwnClient) AddClient(instanceFlag string, instanceConfig *define.Cluste
 		OnConnect: func(ctx context.Context, cn *redisClient.Conn) error {
 			return nil
 		},
-		Protocol:                   0,
+		// Protocol:                   0,
-		Username:                   instanceConfig.Username,
+		Username: instanceConfig.Username,
-		Password:                   instanceConfig.Password,
+		Password: instanceConfig.Password,
-		CredentialsProvider:        nil,
+		// CredentialsProvider:        nil,
-		CredentialsProviderContext: nil,
+		// CredentialsProviderContext: nil,
-		MaxRetries:                 instanceConfig.MaxRetries,
+		MaxRetries:      instanceConfig.MaxRetries,
-		MinRetryBackoff:            time.Duration(instanceConfig.MinRetryBackoff) * time.Millisecond,
+		MinRetryBackoff: time.Duration(instanceConfig.MinRetryBackoff) * time.Millisecond,
-		MaxRetryBackoff:            time.Duration(instanceConfig.MaxRetryBackoff) * time.Millisecond,
+		MaxRetryBackoff: time.Duration(instanceConfig.MaxRetryBackoff) * time.Millisecond,
-		DialTimeout:                time.Duration(instanceConfig.DialTimeout) * time.Millisecond,
+		DialTimeout:     time.Duration(instanceConfig.DialTimeout) * time.Millisecond,
-		ReadTimeout:                time.Duration(instanceConfig.ReadTimeout) * time.Millisecond,
+		ReadTimeout:     time.Duration(instanceConfig.ReadTimeout) * time.Millisecond,
-		WriteTimeout:               time.Duration(instanceConfig.WriteTimeout) * time.Millisecond,
+		WriteTimeout:    time.Duration(instanceConfig.WriteTimeout) * time.Millisecond,
-		ContextTimeoutEnabled:      instanceConfig.ContextTimeoutEnabled,
+		// ContextTimeoutEnabled:      instanceConfig.ContextTimeoutEnabled,
-		PoolFIFO:                   instanceConfig.PoolFIFO,
+		PoolFIFO:     instanceConfig.PoolFIFO,
-		PoolSize:                   instanceConfig.PoolSize,
+		PoolSize:     instanceConfig.PoolSize,
-		PoolTimeout:                time.Duration(instanceConfig.PoolTimeout) * time.Millisecond,
+		PoolTimeout:  time.Duration(instanceConfig.PoolTimeout) * time.Millisecond,
-		MinIdleConns:               instanceConfig.MinIdleConn,
+		MinIdleConns: instanceConfig.MinIdleConn,
-		MaxIdleConns:               instanceConfig.MaxIdleConn,
+		// MaxIdleConns:               instanceConfig.MaxIdleConn,
-		MaxActiveConns:             instanceConfig.MaxActiveConn,
+		// MaxActiveConns:             instanceConfig.MaxActiveConn,
-		ConnMaxIdleTime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
+		// ConnMaxIdleTime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
-		ConnMaxLifetime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
+		// ConnMaxLifetime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
-		TLSConfig:                  nil,
+		TLSConfig: nil,
-		DisableIndentity:           instanceConfig.DisableIdentity,
+		// DisableIndentity:           instanceConfig.DisableIdentity,
-		IdentitySuffix:             instanceConfig.IdentitySuffix,
+		// IdentitySuffix:             instanceConfig.IdentitySuffix,
 	})
 	o.lock.Lock()
 	defer o.lock.Unlock()

client_v9.go

@@ -0,0 +1,185 @@
+// Package redis ...
+//
+// Description : redis 客户端
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 2021-02-27 4:49 下午
+package redis
+
+import (
+	"context"
+	"strings"
+	"sync"
+	"time"
+
+	"git.zhangdeman.cn/zhangdeman/redis/define"
+	wrapperOperate "git.zhangdeman.cn/zhangdeman/wrapper"
+	"github.com/pkg/errors"
+	redisClient "github.com/redis/go-redis/v9"
+	"go.uber.org/zap"
+)
+
+type OwnClientV9 struct {
+	lock              *sync.RWMutex
+	instanceTable     map[string]*redisClient.ClusterClient
+	whiteCommandTable map[string]bool
+	logger            *zap.Logger
+}
+
+func (o *OwnClientV9) isAllowCommand(command string) bool {
+	if len(o.whiteCommandTable) == 0 {
+		// 未配置, 视为全部允许执行
+		return true
+	}
+	if o.whiteCommandTable["*"] {
+		// 配置了 * 视为全部允许执行
+		return true
+	}
+	command = strings.ToLower(strings.TrimSpace(command))
+	o.lock.RLock()
+	defer o.lock.RUnlock()
+	return o.whiteCommandTable[command]
+}
+
+// Exec 执行命令
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 11:05 2024/6/19
+func (o *OwnClientV9) Exec(ctx context.Context, instanceFlag string, command string, args ...any) *define.RedisResult {
+	var (
+		instance *redisClient.ClusterClient
+	)
+
+	cmdParamList := []any{
+		command,
+	}
+	argStrList := make([]string, 0)
+	for _, itemArg := range args {
+		argStrList = append(argStrList, wrapperOperate.AnyDataType(itemArg).ToString().Value())
+		cmdParamList = append(cmdParamList, itemArg)
+	}
+	res := &define.RedisResult{
+		StartTime:  time.Now().UnixMilli(),
+		FinishTime: 0,
+		UsedTime:   0,
+		Result:     "",
+		Command:    command,
+		ArgList:    argStrList,
+		Err:        nil,
+	}
+	defer func() {
+		res.FinishTime = time.Now().UnixMilli()
+		res.UsedTime = res.FinishTime - res.StartTime
+		if nil == o.logger {
+			// 未注入日志实例
+			return
+		}
+		o.logger.Info(
+			"Redis命令执行记录",
+			zap.Int64("start_time", res.StartTime),
+			zap.Int64("finish_time", res.FinishTime),
+			zap.Int64("used_time", res.UsedTime),
+			zap.String("command", res.Command),
+			zap.String("arg_list", strings.Join(res.ArgList, " ")),
+			zap.String("execute_result", res.Result),
+			zap.Error(res.Err),
+		)
+	}()
+	if instance, res.Err = o.GetRealClientWithError(instanceFlag); nil != res.Err {
+		return res
+	}
+	if nil == ctx {
+		ctx = context.Background()
+	}
+	cmdRes := instance.Do(ctx, cmdParamList...)
+	if res.Err = cmdRes.Err(); nil != res.Err {
+		return res
+	}
+	res.Result = cmdRes.String()
+	return res
+}
+
+// SetCommandWhiteList 设置命令白名单, 空 或者 包含 * 则认为所有命令均允许执行
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 11:02 2024/6/19
+func (o *OwnClientV9) SetCommandWhiteList(commandList []string) {
+	o.lock.Lock()
+	defer o.lock.Unlock()
+	for _, itemCommand := range commandList {
+		o.whiteCommandTable[strings.ToLower(strings.TrimSpace(itemCommand))] = true
+	}
+}
+
+func (o *OwnClientV9) GetRealClient(instanceFlag string) *redisClient.ClusterClient {
+	o.lock.RLock()
+	defer o.lock.RUnlock()
+	return o.instanceTable[instanceFlag]
+}
+
+func (o *OwnClientV9) GetRealClientWithError(instanceFlag string) (*redisClient.ClusterClient, error) {
+	o.lock.RLock()
+	defer o.lock.RUnlock()
+	instance, exist := o.instanceTable[instanceFlag]
+	if !exist {
+		return nil, errors.New(instanceFlag + " : redis instance is not found")
+	}
+	return instance, nil
+}
+
+func (o *OwnClientV9) AddClient(instanceFlag string, instanceConfig *define.ClusterOptions) error {
+	instance := redisClient.NewClusterClient(&redisClient.ClusterOptions{
+		Addrs: instanceConfig.Addrs,
+		// ClientName:     instanceConfig.ClientName,
+		NewClient:      nil,
+		MaxRedirects:   instanceConfig.MaxRedirects,
+		ReadOnly:       instanceConfig.ReadOnly,
+		RouteByLatency: instanceConfig.RouteByLatency,
+		RouteRandomly:  instanceConfig.RouteRandomly,
+		ClusterSlots:   nil,
+		Dialer:         nil,
+		OnConnect: func(ctx context.Context, cn *redisClient.Conn) error {
+			return nil
+		},
+		// Protocol:                   0,
+		Username: instanceConfig.Username,
+		Password: instanceConfig.Password,
+		// CredentialsProvider:        nil,
+		// CredentialsProviderContext: nil,
+		MaxRetries:      instanceConfig.MaxRetries,
+		MinRetryBackoff: time.Duration(instanceConfig.MinRetryBackoff) * time.Millisecond,
+		MaxRetryBackoff: time.Duration(instanceConfig.MaxRetryBackoff) * time.Millisecond,
+		DialTimeout:     time.Duration(instanceConfig.DialTimeout) * time.Millisecond,
+		ReadTimeout:     time.Duration(instanceConfig.ReadTimeout) * time.Millisecond,
+		WriteTimeout:    time.Duration(instanceConfig.WriteTimeout) * time.Millisecond,
+		// ContextTimeoutEnabled:      instanceConfig.ContextTimeoutEnabled,
+		PoolFIFO:     instanceConfig.PoolFIFO,
+		PoolSize:     instanceConfig.PoolSize,
+		PoolTimeout:  time.Duration(instanceConfig.PoolTimeout) * time.Millisecond,
+		MinIdleConns: instanceConfig.MinIdleConn,
+		// MaxIdleConns:               instanceConfig.MaxIdleConn,
+		// MaxActiveConns:             instanceConfig.MaxActiveConn,
+		// ConnMaxIdleTime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
+		// ConnMaxLifetime:            time.Duration(instanceConfig.ConnMaxIdleTime) * time.Second,
+		TLSConfig: nil,
+		// DisableIndentity:           instanceConfig.DisableIdentity,
+		// IdentitySuffix:             instanceConfig.IdentitySuffix,
+	})
+	o.lock.Lock()
+	defer o.lock.Unlock()
+	o.instanceTable[instanceFlag] = instance
+	return nil
+}
+
+func (o *OwnClientV9) RemoveClient(instanceFlag string) {
+	o.lock.Lock()
+	defer o.lock.Unlock()
+	delete(o.instanceTable, instanceFlag)
+}
+
+func (o *OwnClientV9) SetLogger(loggerInstance *zap.Logger) {
+	o.logger = loggerInstance
+}

define/version.go

@@ -0,0 +1,13 @@
+// Package define ...
+//
+// Description : define ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 2024-06-19 21:58
+package define
+
+const (
+	ClientVersionV8 = "v8"
+	ClientVersionV9 = "v9"
+)