自定义分片插件

我们默认提供了三种分片实现defaultHandler.go、 simpleHandler.go、shardinghandler.go，但是，如果我们有比较个性化的需求，那么在不对redisdao做任何改动的前提下，即可实现一种自定义分片

分片插件接口

  1. type XesRedisHandler interface {
  2.     //获取实例别名（与配置文件中的别名是一个概念）
  3.     GetInstance(xesRedis core.XesRedisBase) string
  4.     //获取真正的redis key(格式化之后)
  5.     GetKey(xesRedis core.XesRedisBase) string
  6. }
  7. //xesRedisBase提供方法
  8. type XesRedisBase interface {
  9.     GetCtx() context.Context
  10.     SetInstanceIP(string)
  11.     GetKeyName() string
  12.     GetKeyParams() []interface{}
  13.     GetKey() string
  14. }

实现接口

此处我们以simpleHandler 为例，简要说明自定义插件的编写方式

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/spf13/cast"
  6.     "github.com/tal-tech/redisdao"
  7. )
  9. var (
  10.     //redis集群
  11.     myRedisCluster = []string{"127.0.0.1:2379", "127.0.0.1:6379"}
  12. )
  14. type simpleHandler struct {
  15. }
  17. func (this *simpleHandler) GetKey(xesRedis core.XesRedisBase) (ret string) {
  18.     defer func() {
  19.         if xesRedis.GetCtx() == nil {
  20.             return
  21.         }
  22.         bench := xesRedis.GetCtx().Value("IS_BENCHMARK")
  23.         if cast.ToString(bench) == "1" {
  24.             ret = "benchmark_" + ret
  25.         }
  26.     }()
  27.     ret = fmt.Sprintf(xesRedis.GetKeyName(), (xesRedis.GetKeyParams())...)
  28.     return
  29. }
  31. func (this *simpleHandler) GetInstance(xesRedis core.XesRedisBase) (instance string) {
  33.     //-----sharding方案 ----
  34.     //仅做演示~
  35.     keyName := this.GetKey()
  36.     keyLen := len(keyName)
  37.     clusterLen := len(myRedisCluster)
  39.     instanceIndex := keyLen % clusterLen
  40.     instance = myRedisCluster[instanceIndex]
  41.      //-----sharding方案 ----
  44.     xesRedis.SetInstanceIP(this.instance)
  45.     return instance
  46. }
  49. //---------------------------------
  50. // 除了基本的接口实现以外，我们还需要一个生成插件实例的方法
  51. //---------------------------------
  53. func NewSimpleHandler() redisdao.XesRedisHandler{
  54.     return &simpleHandler{}
  55. }

注意：

  1. 返回的是 XesRedisHandler 接口类型
  2. 方法this.xesRedis.GetKeyParams() 的作用是，获取格式化key所用的参数，对应为redisdao/command.go 文件中所有命令的参数keyParams
  3. this.xesRedis.SetInstanceIP(this.instance) 必要操作，是把实例地址回传给redisdao，后续执行命令会用到！

在项目中使用

  1. package main
  3. import(
  4.     "context"
  5.     "github.com/tal-tech/redisdao"
  6. )
  8. var (
  9.     Redis_Key_For_Test = "releaseTestIds_%v"
  10. )
  12. func main(){
  13.     ctx := context.WithValue(context.Background(), "handler", NewSimpleHandler)
  14.     xredis := redisdao.NewXesRedisOfCtx(ctx)
  15.     if testIds, err := xredis.ZRangeWithScores(Redis_Key_For_Test , []interface{}{2224}, 0, -1); err != nil {
  16.         //...
  17.     } else {
  18.         //....
  19.     }
  20. }