config center

Go-zero will soon support the configuration center function in the new version (v1.7.1). This article introduces the simple use of the configuration center in advance, and introduces the use precautions and characters. code 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. // configuration structure definition
  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 address
  18.             Key:   "test1",    // Configuration key
  19.         })
  21.         // Create configurator
  22.         cc := configurator.MustNewConfigCenter[TestSt](configurator.Config{
  23.                 Type: "json", // Configuration value type: json, yaml, toml
  24.         }, ss)
  26.         // Get configuration
  27.         // Note: If the configuration changes, the result of the call will always get the latest configuration
  28.         v, err := cc.GetConfig() 
  29.         if err != nil {
  30.                 panic(err)
  31.         }
  32.         println(v.Name)
  34.         // If you want to listen for configuration changes, you can add listeners
  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. }

Note

  1. configurator Supported template types: struct, string。

  2. If you want to use more configuration types([]struct,map,[]map…)，You can use the string type to get the data and parse it yourself.

    1. func main() {
    2.         // Create etcd subscriber
    3.         ss := subscriber.MustNewEtcdSubscriber(subscriber.EtcdConf{
    4.             Hosts: []string{"localhost:2379"}, // ETCD address
    5.             Key:   "test1",    // Configuration key
    6.         })
    8.         // Create configurator
    9.         cc := configurator.MustNewConfigCenter[string](configurator.Config{
    10.                 Type: "json", // Configuration value type: json, yaml, toml
    11.         }, ss)
    13.         // Get configuration
    14.         // Note: If the configuration changes, the result of the call will always get the latest configuration
    15.         v, err := cc.GetConfig() 
    16.         if err != nil {
    17.                 panic(err)
    18.         }
    20.         // For cc. GetConfig () results, customize the parsing method
    21. }

  3. If it is a struct template type, the parser of the configurator is the same as the static configuration method, and the config will be checked. For detailed rules, please refer to: 参数规则

  1. // configuration structure definition
  2. type TestSt struct {
  3.         Name string `json:",optional"`
  4.         age  int    `json:",default=20"`
  5. }

Features

  1. Configurator built-in snapshot data, can provide high performance capabilities.

  2. Configurator supports custom subscribers, you can customize extensions according to your own technology stack, go-zero supports etcd by default.

  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. // Custom Subscriber
  14. type MySubscriber struct {
  15.         listeners []func()
  16.         lock      sync.Mutex
  17. }
  19. // Implement Custom AddListeners
  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. // Implement Custom Values
  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) // Inject Custom Subscribers
  38.         v, err := cc.GetConfig()
  39.         if err != nil {
  40.                 panic(err)
  41.         }
  42.         println(len(v.Name))
  43. }