Compare commits
No commits in common. "main" and "v1.3.1" have entirely different histories.
@ -1,13 +1,5 @@
|
||||
# CHANGELOG - redis
|
||||
|
||||
## v1.5.1 (2026-06-08)
|
||||
- **新增**: `SetConfig(name, setting string)` 方法，支持动态配置 Redis 连接（不依赖配置文件），方便通过别名获取连接。
|
||||
- **优化**: 重构配置加载逻辑，确保动态配置与配置文件配置的共存与优先级。
|
||||
|
||||
## v1.3.3 (2026-05-30)
|
||||
- **新增**: 注册到 `jsmod`。
|
||||
- **安全性**: 引入基于 Context 的细粒度权限控制。在 `SafeMode` 下，仅允许读取操作（GET/EXISTS/ZRANGE等），所有写操作（SET/DEL/EXPIRE/DO等）将被拦截并返回错误。
|
||||
|
||||
## v1.0.8 (2026-05-10)
|
||||
- **API 对齐**:
|
||||
- `NewIDMaker` 返回值从 `*IDMaker` 修改为 `*id.IDMaker`，保持全局接口统一。
|
||||
|
||||
@ -11,8 +11,7 @@
|
||||
## API 指南
|
||||
|
||||
### 基础连接
|
||||
- `SetConfig(name, setting string)`: 动态设置 Redis 配置（不依赖配置文件），可通过别名获取连接。
|
||||
- `GetRedis(name string, logger *log.Logger) *Redis`: 获取或创建一个 Redis 实例（支持 DSN、别名或配置文件名）。
|
||||
- `GetRedis(name string, logger *log.Logger) *Redis`: 获取或创建一个 Redis 实例（支持 DSN 或配置文件名）。
|
||||
- `NewRedis(conf *Config, logger *log.Logger) *Redis`: 使用指定配置创建 Redis 实例。
|
||||
|
||||
### 核心操作
|
||||
|
||||
14
config.go
14
config.go
@ -8,7 +8,6 @@ import (
|
||||
"time"
|
||||
|
||||
"apigo.cc/go/cast"
|
||||
"apigo.cc/go/config"
|
||||
"apigo.cc/go/crypto"
|
||||
"apigo.cc/go/log"
|
||||
"apigo.cc/go/safe"
|
||||
@ -31,19 +30,6 @@ type Config struct {
|
||||
|
||||
var redisConfigs = make(map[string]*Config)
|
||||
var redisConfigsLock = sync.RWMutex{}
|
||||
var redisConfigsOnce sync.Once
|
||||
|
||||
func SetConfig(name, setting string) {
|
||||
redisConfigsOnce.Do(func() {
|
||||
_ = config.Load(&redisConfigs, "redis")
|
||||
})
|
||||
|
||||
conf := new(Config)
|
||||
conf.ConfigureBy(setting)
|
||||
redisConfigsLock.Lock()
|
||||
redisConfigs[name] = conf
|
||||
redisConfigsLock.Unlock()
|
||||
}
|
||||
|
||||
var confAES *crypto.Symmetric
|
||||
|
||||
|
||||
25
go.mod
25
go.mod
@ -3,22 +3,21 @@ module apigo.cc/go/redis
|
||||
go 1.25.0
|
||||
|
||||
require (
|
||||
apigo.cc/go/cast v1.5.0
|
||||
apigo.cc/go/config v1.5.0
|
||||
apigo.cc/go/crypto v1.5.0
|
||||
apigo.cc/go/encoding v1.5.0
|
||||
apigo.cc/go/id v1.5.0
|
||||
apigo.cc/go/jsmod v1.5.0
|
||||
apigo.cc/go/log v1.5.0
|
||||
apigo.cc/go/safe v1.5.0
|
||||
apigo.cc/go/cast v1.3.2
|
||||
apigo.cc/go/config v1.3.0
|
||||
apigo.cc/go/crypto v1.3.0
|
||||
apigo.cc/go/encoding v1.3.0
|
||||
apigo.cc/go/id v1.3.0
|
||||
apigo.cc/go/log v1.3.2
|
||||
apigo.cc/go/safe v1.3.0
|
||||
github.com/gomodule/redigo v2.0.0+incompatible
|
||||
)
|
||||
|
||||
require (
|
||||
apigo.cc/go/file v1.5.0 // indirect
|
||||
apigo.cc/go/rand v1.5.0 // indirect
|
||||
apigo.cc/go/shell v1.5.0 // indirect
|
||||
golang.org/x/crypto v0.52.0 // indirect
|
||||
golang.org/x/sys v0.45.0 // indirect
|
||||
apigo.cc/go/file v1.3.1 // indirect
|
||||
apigo.cc/go/rand v1.3.0 // indirect
|
||||
apigo.cc/go/shell v1.3.0 // indirect
|
||||
golang.org/x/crypto v0.51.0 // indirect
|
||||
golang.org/x/sys v0.44.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
48
go.sum
48
go.sum
@ -1,25 +1,23 @@
|
||||
apigo.cc/go/cast v1.5.0 h1:UBGJtFQ8eJPMQXs37cUgqd7YQo1zI9opuSDBDmn2/pE=
|
||||
apigo.cc/go/cast v1.5.0/go.mod h1:z2GW5p5WCZGEqVVIJUdhl232vRbLf2Qu4EDlEakX/D8=
|
||||
apigo.cc/go/config v1.5.0 h1:Yuz9QEb11XXG4XkhDi/ueT2M1T3Q9PElE5tiakvjehs=
|
||||
apigo.cc/go/config v1.5.0/go.mod h1:jdMiDLPa9gzB8/FFZvm9jOopUqdxb7XSX+0OeWcZZUM=
|
||||
apigo.cc/go/crypto v1.5.0 h1:Nxz7a6VKCdvaF258IU0NkjQyureOLxfR308Sy2iftUI=
|
||||
apigo.cc/go/crypto v1.5.0/go.mod h1:F9M6nXv+5328r1ZwbTvI6fcr8VdgqHVzALOcsdv6ntE=
|
||||
apigo.cc/go/encoding v1.5.0 h1:EJNdRVDOMoI2DAvZwQNQTbYuqB/6zsEzvg7lS5pQI+I=
|
||||
apigo.cc/go/encoding v1.5.0/go.mod h1:8++NfZj3hWig0qh2g7GQRw/4LpSvCYMWUZ+8J+x58cA=
|
||||
apigo.cc/go/file v1.5.0 h1:Fh1NSDBqaxjuXYJ71yPHPXVJ8BFEv/AGS3l+jkLi5uw=
|
||||
apigo.cc/go/file v1.5.0/go.mod h1:4YhOGgBINTpmmmgws3H8LAyXQQBGzBp44hYUoCS+kr0=
|
||||
apigo.cc/go/id v1.5.0 h1:MjNWPhBhDsoXaLeJDv/0wfJmVMU9EvOs8pWYfsTQ6e8=
|
||||
apigo.cc/go/id v1.5.0/go.mod h1:qhu4a1/KLc/XcBpcsRu+mXZt7U7Wvd9zMcPs4VspuPA=
|
||||
apigo.cc/go/jsmod v1.5.0 h1:JgQtJNiJWy1NOP9AzE8NX5VXJkpO/x3GqLsCCSny5Ec=
|
||||
apigo.cc/go/jsmod v1.5.0/go.mod h1:bmyeZtOAP/j5am+YRnaiM89smysK24K7ebk0koFtsSw=
|
||||
apigo.cc/go/log v1.5.0 h1:kQuLLtbt33mEuc/xJVcy8NODXkso/QKSZWNclKrSpsI=
|
||||
apigo.cc/go/log v1.5.0/go.mod h1:Djy+I5aLhGB/EjwRz4KHqkVEz584IAD55FAFiIfInuo=
|
||||
apigo.cc/go/rand v1.5.0 h1:1o8hh8fhdBuk1/h02IvugvamuT3dkWbVJrqEJVQKB2E=
|
||||
apigo.cc/go/rand v1.5.0/go.mod h1:Lh98S2dm9UY0X+M+kNQQEKyXHG5pcCKSFPyXN0QCGdk=
|
||||
apigo.cc/go/safe v1.5.0 h1:W1NblmcU8cex1f9Y5z8mNLUJOzZTE1s6fszb3FbhGnk=
|
||||
apigo.cc/go/safe v1.5.0/go.mod h1:OfQ5d6COePSGEuPvMeOk6KagX2sezw7nvKh7exj9SeM=
|
||||
apigo.cc/go/shell v1.5.0 h1:WLDMMqUU0INeaBDmQsTPr0h/NfB2RknAtiJ5NL467+Q=
|
||||
apigo.cc/go/shell v1.5.0/go.mod h1:rYHA77d5hEsQHcJrbAWf1pHy0sxayeJ0gU55LA/JWQk=
|
||||
apigo.cc/go/cast v1.3.2 h1:hh9MWDSwh3T/kQdCHjFpjDwHrh2A05Q4wt1AAWs8NBI=
|
||||
apigo.cc/go/cast v1.3.2/go.mod h1:lGlwImiOvHxG7buyMWhFzcdvQzmSaoKbmr7bcDfUpHk=
|
||||
apigo.cc/go/config v1.3.0 h1:TwI3bv3D+BJrAnFx+o62HQo3FarY2Ge3SCGsKchFYGg=
|
||||
apigo.cc/go/config v1.3.0/go.mod h1:88lqKEBXlIExFKt1geLONVLYyM+QhRVpBe0ok3OEvjI=
|
||||
apigo.cc/go/crypto v1.3.0 h1:rGRrrb5O+4M50X5hVUmJQbXx3l87zzlcgzGtUvZrZL8=
|
||||
apigo.cc/go/crypto v1.3.0/go.mod h1:uSCcmbcFoiltUPMQTSuqmU9nfKEH/lRs7nQ7aa3Z4Mc=
|
||||
apigo.cc/go/encoding v1.3.0 h1:8jqNHoZBR8vOU/BGsLFebfp1Txa1UxDRpd7YwzIFLJs=
|
||||
apigo.cc/go/encoding v1.3.0/go.mod h1:kT/uUJiuAOkZ4LzUWrUtk/I0iL1D8aatvD+59bDnHBo=
|
||||
apigo.cc/go/file v1.3.1 h1:qHgiJsn1K9DazWRrPoHVnXtp6hDGGsUpAE/4G1bFXqY=
|
||||
apigo.cc/go/file v1.3.1/go.mod h1:pYHBlB/XwsrnWpEh7GIFpbiqobrExfiB+rEN8V2d2kY=
|
||||
apigo.cc/go/id v1.3.0 h1:Tr2Yj0Rl19lfwW5wBTJ407o/zgo2oVRLE20WWEgJzdE=
|
||||
apigo.cc/go/id v1.3.0/go.mod h1:AFH3kMFwENfXNyijnAFWEhSF1o3y++UBPem1IUlrcxA=
|
||||
apigo.cc/go/log v1.3.2 h1:/m3V4MnlYnCG4XPHpWDsa4cw5suMaDVY1SgaVyjnBSo=
|
||||
apigo.cc/go/log v1.3.2/go.mod h1:dz4bSz9BnOgutkUJJZfX3uDDwsMpUxt7WF50mLK9hgE=
|
||||
apigo.cc/go/rand v1.3.0 h1:k+UFAhMySwXf+dq8Om9TniZV6fm6gAE0evbrqMEdwQU=
|
||||
apigo.cc/go/rand v1.3.0/go.mod h1:mZ/4Soa3bk+XvDaqPWJuUe1bfEi4eThBj1XmEAuYxsk=
|
||||
apigo.cc/go/safe v1.3.0 h1:uctdAUsphT9p60Tk4oS5xPCe0NoIdOHfsYv4PNS0Rok=
|
||||
apigo.cc/go/safe v1.3.0/go.mod h1:tC9X14V+qh0BqIrVg4UkXbl+2pEN+lj2ZNI8IjDB6Fs=
|
||||
apigo.cc/go/shell v1.3.0 h1:hdxuYPN/7T2BuM/Ja8AjVUhbRqU/wpi8OjcJVziJ0nw=
|
||||
apigo.cc/go/shell v1.3.0/go.mod h1:aNJiRWibxlA485yX3t+07IVAbrALKmxzv4oGEUC+hK4=
|
||||
github.com/gomodule/redigo v2.0.0+incompatible h1:K/R+8tc58AaqLkqG2Ol3Qk+DR/TlNuhuh457pBFPtt0=
|
||||
github.com/gomodule/redigo v2.0.0+incompatible/go.mod h1:B4C85qUVwatsJoIUNIfCRsp7qO0iAmpGFZ4EELWSbC4=
|
||||
github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
|
||||
@ -28,8 +26,10 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
||||
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
||||
golang.org/x/crypto v0.52.0 h1:RMs7fP2rXdep0CftQlK8Uf+kibLm7qkCcradZWYz988=
|
||||
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
|
||||
golang.org/x/crypto v0.51.0 h1:IBPXwPfKxY7cWQZ38ZCIRPI50YLeevDLlLnyC5wRGTI=
|
||||
golang.org/x/crypto v0.51.0/go.mod h1:8AdwkbraGNABw2kOX6YFPs3WM22XqI4EXEd8g+x7Oc8=
|
||||
golang.org/x/sys v0.44.0 h1:ildZl3J4uzeKP07r2F++Op7E9B29JRUy+a27EibtBTQ=
|
||||
golang.org/x/sys v0.44.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
|
||||
|
||||
135
js_export.go
135
js_export.go
@ -1,135 +0,0 @@
|
||||
package redis
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"strings"
|
||||
|
||||
"apigo.cc/go/id"
|
||||
"apigo.cc/go/jsmod"
|
||||
)
|
||||
|
||||
func init() {
|
||||
jsmod.Register("redis", map[string]any{
|
||||
// 入口：支持别名获取，不传则默认 "default"
|
||||
"Get": func(ctx context.Context, name *string) (*jsRedis, error) {
|
||||
target := "default"
|
||||
if name != nil {
|
||||
target = *name
|
||||
}
|
||||
rd := GetRedis(target, nil)
|
||||
if rd.Error != nil {
|
||||
return nil, rd.Error
|
||||
}
|
||||
return &jsRedis{rd: rd, ctx: ctx}, nil
|
||||
},
|
||||
|
||||
// 默认快捷调用 (面向 "default" 实例)
|
||||
"Do": func(ctx context.Context, cmd string, args ...any) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
if jr.rd.Error != nil {
|
||||
return nil, jr.rd.Error
|
||||
}
|
||||
res := jr.Do(cmd, args...)
|
||||
return res, res.Error
|
||||
},
|
||||
|
||||
// 常用命令平铺 (面向 "default" 实例)
|
||||
"SET": func(ctx context.Context, key string, val any) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("SET", key, val)
|
||||
return res, res.Error
|
||||
},
|
||||
"GET": func(ctx context.Context, key string) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("GET", key)
|
||||
return res, res.Error
|
||||
},
|
||||
"DEL": func(ctx context.Context, key string) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("DEL", key)
|
||||
return res, res.Error
|
||||
},
|
||||
"EXISTS": func(ctx context.Context, key string) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("EXISTS", key)
|
||||
return res, res.Error
|
||||
},
|
||||
"EXPIRE": func(ctx context.Context, key string, seconds int) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("EXPIRE", key, seconds)
|
||||
return res, res.Error
|
||||
},
|
||||
"PUBLISH": func(ctx context.Context, channel, data string) (*Result, error) {
|
||||
jr := &jsRedis{rd: GetRedis("default", nil), ctx: ctx}
|
||||
res := jr.Do("PUBLISH", channel, data)
|
||||
return res, res.Error
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
type jsRedis struct {
|
||||
rd *Redis
|
||||
ctx context.Context
|
||||
idMaker *id.IDMaker
|
||||
}
|
||||
|
||||
var errSafeMode = errors.New("redis operation is restricted in safe mode")
|
||||
|
||||
// 核心写操作指令集
|
||||
var writeCommands = map[string]bool{
|
||||
"SET": true, "SETEX": true, "SETNX": true, "MSET": true, "MSETNX": true,
|
||||
"DEL": true, "EXPIRE": true, "EXPIREAT": true, "PEXPIRE": true, "PEXPIREAT": true,
|
||||
"HSET": true, "HSETNX": true, "HDEL": true, "HMSET": true,
|
||||
"LPUSH": true, "RPUSH": true, "LPOP": true, "RPOP": true, "LREM": true, "LTRIM": true,
|
||||
"SADD": true, "SREM": true, "SPOP": true, "SMOVE": true,
|
||||
"ZADD": true, "ZREM": true, "ZREMRANGEBYRANK": true, "ZREMRANGEBYSCORE": true,
|
||||
"PUBLISH": true, "FLUSHDB": true, "FLUSHALL": true,
|
||||
}
|
||||
|
||||
func (jr *jsRedis) checkSafe(cmd string) error {
|
||||
if jsmod.IsSafeMode(jr.ctx) {
|
||||
cmd = strings.ToUpper(cmd)
|
||||
if writeCommands[cmd] || !strings.Contains(" GET EXISTS ZRANGE HGET HGETALL SMEMBERS SISMEMBER LINDEX LLEN ", " "+cmd+" ") {
|
||||
// 严格模式：不在白名单内的或在黑名单内的都禁止
|
||||
return errSafeMode
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (jr *jsRedis) Do(cmd string, args ...any) *Result {
|
||||
if err := jr.checkSafe(cmd); err != nil {
|
||||
return &Result{Error: err}
|
||||
}
|
||||
return jr.rd.Do(cmd, args...)
|
||||
}
|
||||
|
||||
// 实例方法 PascalCase 对齐
|
||||
func (jr *jsRedis) SET(key string, val any) *Result { return jr.Do("SET", key, val) }
|
||||
func (jr *jsRedis) GET(key string) *Result { return jr.Do("GET", key) }
|
||||
func (jr *jsRedis) DEL(key string) *Result { return jr.Do("DEL", key) }
|
||||
func (jr *jsRedis) EXISTS(key string) *Result { return jr.Do("EXISTS", key) }
|
||||
func (jr *jsRedis) EXPIRE(key string, s int) *Result { return jr.Do("EXPIRE", key, s) }
|
||||
func (jr *jsRedis) HSET(key, field string, v any) *Result { return jr.Do("HSET", key, field, v) }
|
||||
func (jr *jsRedis) HGET(key, field string) *Result { return jr.Do("HGET", key, field) }
|
||||
func (jr *jsRedis) PUBLISH(ch, data string) *Result { return jr.Do("PUBLISH", ch, data) }
|
||||
|
||||
// ID Generation
|
||||
func (jr *jsRedis) MakeID(size int, forDB *string) string {
|
||||
if jr.idMaker == nil {
|
||||
jr.idMaker = NewIDMaker(jr.rd)
|
||||
}
|
||||
dbType := ""
|
||||
if forDB != nil {
|
||||
dbType = strings.ToLower(*forDB)
|
||||
}
|
||||
switch dbType {
|
||||
case "mysql":
|
||||
return jr.idMaker.GetForMysql(size)
|
||||
case "postgres", "pg", "pgsql":
|
||||
return jr.idMaker.GetForPostgreSQL(size)
|
||||
default:
|
||||
return jr.idMaker.Get(size)
|
||||
}
|
||||
}
|
||||
10
redis.go
10
redis.go
@ -57,9 +57,13 @@ func GetRedis(name string, logger *log.Logger) *Redis {
|
||||
return oldConn.CopyByLogger(logger)
|
||||
}
|
||||
|
||||
redisConfigsOnce.Do(func() {
|
||||
redisConfigsLock.RLock()
|
||||
configsLen := len(redisConfigs)
|
||||
redisConfigsLock.RUnlock()
|
||||
|
||||
if configsLen == 0 {
|
||||
_ = config.Load(&redisConfigs, "redis")
|
||||
})
|
||||
}
|
||||
|
||||
fullName := name
|
||||
|
||||
@ -72,7 +76,7 @@ func GetRedis(name string, logger *log.Logger) *Redis {
|
||||
conf = parseByName(name)
|
||||
}
|
||||
|
||||
if pwd, err := confAES.Decrypt(cast.As(encoding.UnURLBase64(conf.Password))); err == nil {
|
||||
if pwd, err := confAES.Decrypt(cast.As(encoding.UnUrlBase64FromString(conf.Password))); err == nil {
|
||||
conf.pwd = pwd
|
||||
} else {
|
||||
conf.pwd = safe.NewSafeBuf([]byte(conf.Password))
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user