配置中心

go-zero 即将在新版本(v1.7.1)中支持配置中心功能, 本文提前介绍下配置中心的简单使用，使用注意事项和特点介绍。代码 https://github.com/zeromicro/go-zero/pull/3035.

使用demo

  1. package main
  3. import (
  4.         "github.com/zeromicro/go-zero/core/configcenter"
  5.         "github.com/zeromicro/go-zero/core/configcenter/subscriber"
  6.         "github.com/zeromicro/go-zero/core/discov"
  7. )
  9. // 配置结构定义
  10. type TestSt struct {
  11.         Name string `json:"name"`
  12. }
  14. func main() {
  15.         // 创建 etcd subscriber
  16.         ss := subscriber.MustNewEtcdSubscriber(subscriber.EtcdConf{
  17.             Hosts: []string{"localhost:2379"}, // etcd 地址
  18.             Key:   "test1",    // 配置key
  19.        })
  21.         // 创建 configurator
  22.         cc := configurator.MustNewConfigCenter[TestSt](configurator.Config{
  23.                 Type: "json", // 配置值类型：json,yaml,toml
  24.         }, ss)
  26.         // 获取配置
  27.         // 注意: 配置如果发生变更，调用的结果永远获取到最新的配置
  28.         v, err := cc.GetConfig() 
  29.         if err != nil {
  30.                 panic(err)
  31.         }
  32.         println(v.Name)
  34.         // 如果想监听配置变化，可以添加 listener
  35.         cc.AddListener(func() {
  36.                 v, err := cc.GetConfig()
  37.                 if err != nil {
  38.                         panic(err)
  39.                 }
  40.                 println(v.Name)
  41.         })
  43.         select {}
  44. }

使用注意事项

  1. configurator 支持的模板类型: struct, string。

  2. 如果想使用更多配置类型([]struct,map,[]map…)，可以使用 string 类型，获取到数据后，自行进行解析。

    1. func main() {
    2.         // 创建 etcd subscriber
    3.         ss := subscriber.MustNewEtcdSubscriber(subscriber.EtcdConf{
    4.             Hosts: []string{"localhost:2379"}, // etcd 地址
    5.             Key:   "test1",    // 配置key
    6.         })
    8.         // 创建 configurator
    9.         cc := configurator.MustNewConfigCenter[string](configurator.Config{
    10.                 Type: "json", // 配置值类型：json,yaml,toml
    11.         }, ss)
    13.         // 获取配置
    14.         // 注意: 配置如果发生变更，调用的结果永远获取到最新的配置
    15.         v, err := cc.GetConfig() 
    16.         if err != nil {
    17.                 panic(err)
    18.         }
    20.         // 对 cc.GetConfig() 结果 自定义解析方式
    21. }

  3. 如果是 struct 模板类型，configurator 的解析器和静态配置方式是一样的，都会进行 config 的校验。详细规则请参考: 参数规则

  1. // 配置结构定义
  2. type TestSt struct {
  3.         Name string `json:",optional"`
  4.         age  int    `json:",default=20"`
  5. }

特点介绍

  1. configurator 内置快照数据，可以高性能提供能力。

  2. configurator 支持自定义 subscriber，可以根据自己的技术栈自定义扩展，go-zero 默认支持 etcd。

  1. package main
  3. import (
  4.         "sync"
  6.         "github.com/zeromicro/go-zero/core/configcenter"
  7. )
  9. type TestSt struct {
  10.         Name string `json:"name"`
  11. }
  13. // 自定义 Subscriber
  14. type MySubscriber struct {
  15.         listeners []func()
  16.         lock      sync.Mutex
  17. }
  19. // 实现自定义 AddListener 
  20. func (m *MySubscriber) AddListener(listener func()) error {
  21.         m.lock.Lock()
  22.         m.listeners = append(m.listeners, listener)
  23.         m.lock.Unlock()
  24.         return nil
  25. }
  27. // 实现自定义 Value
  28. func (m *MySubscriber) Value() (string, error) {
  29.         return "", nil
  30. }
  32. func main() {
  33.         mySubscriber := &MySubscriber{}
  35.         cc := configurator.MustNewConfigCenter[TestSt](configurator.Config{
  36.                 Type: "json",
  37.         }, mySubscriber) // 注入自定义 Subscriber
  39.         v, err := cc.GetConfig()
  40.         if err != nil {
  41.                 panic(err)
  42.         }
  43.         println(len(v.Name))
  44. }