gredis adopts an interface-based design, offering strong flexibility and extensibility.

Interface Definition

https://pkg.go.dev/github.com/gogf/gf/v2/database/gredis#Adapter

  1. // SetAdapter sets custom adapter for current redis client.
  2. func (r *Redis) SetAdapter(adapter Adapter)
  4. // GetAdapter returns the adapter that is set in current redis client.
  5. func (r *Redis) GetAdapter() Adapter

Custom Redis Adapter

The framework community component provides a default implementation of the Redis Adapter. If developers need to implement a custom Redis Adapter or want to override certain methods, they can extend based on this implementation.

Let’s look at an example where we implement a custom Redis Adapter and override its underlying Do method. To simplify the example, we print a log in the custom Do method, and subsequent logic follows the community Redis Adapter implementation.

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  7.     "github.com/gogf/gf/contrib/nosql/redis/v2"
  9.     "github.com/gogf/gf/v2/container/gvar"
  10.     "github.com/gogf/gf/v2/database/gredis"
  11.     "github.com/gogf/gf/v2/frame/g"
  12.     "github.com/gogf/gf/v2/os/gctx"
  13. )
  15. var (
  16.     ctx    = gctx.New()
  17.     group  = "cache"
  18.     config = gredis.Config{
  19.         Address: "127.0.0.1:6379",
  20.         Db:      1,
  21.     }
  22. )
  24. // MyRedis description
  25. type MyRedis struct {
  26.     *redis.Redis
  27. }
  29. // Do implements and overwrites the underlying function Do from Adapter.
  30. func (r *MyRedis) Do(ctx context.Context, command string, args ...interface{}) (*gvar.Var, error) {
  31.     fmt.Println("MyRedis Do:", command, args)
  32.     return r.Redis.Do(ctx, command, args...)
  33. }
  35. func main() {
  36.     gredis.RegisterAdapterFunc(func(config *gredis.Config) gredis.Adapter {
  37.         r := &MyRedis{redis.New(config)}
  38.         r.AdapterOperation = r // This is necessary.
  39.         return r
  40.     })
  41.     gredis.SetConfig(&config, group)
  43.     _, err := g.Redis(group).Set(ctx, "key", "value")
  44.     if err != nil {
  45.         g.Log().Fatal(ctx, err)
  46.     }
  47.     value, err := g.Redis(group).Get(ctx, "key")
  48.     if err != nil {
  49.         g.Log().Fatal(ctx, err)
  50.     }
  51.     fmt.Println(value.String())
  52. }

After execution, the terminal outputs:

  1. MyRedis Do: Set [key value]
  2. MyRedis Do: Get [key]
  3. value