热重载错误处理与旧配置保留#

通过独立加载、严格解码和校验应用新配置，更新失败时保留旧配置。

本系列使用 Viper v1.21.0。每章都是独立实验，示例命令在项目目录中执行；开始新一章时，使用该章的完整程序和配置，不累积上一章的临时修改。

尚未准备练习项目时，先完成第 1 章的项目准备。

本章的目标是读取、解码和校验都成功后才应用新配置；失败时继续使用上次有效值。

初始示例#

初始配置 config/config.yaml：

1
app:
2
  name: viper-demo
3
  port: 8080
4
  debug: true
5
  timeout: 5s
6
  allowed_hosts:
7
    - localhost
8
    - example.com
9
  labels:
10
    environment: local
11
    owner: learner
12

13
servers:
14
  - name: primary
15
    address: "127.0.0.1:9001"
16
  - name: backup
17
    address: "127.0.0.1:9002"

初始完整 main.go：

1
package main
2

3
import (
4
  "fmt"
5
  "github.com/fsnotify/fsnotify"
6
  "github.com/spf13/viper"
7
  "log"
8
  "os"
9
  "os/signal"
10
  "time"
11
)
12

13
type AppConfig struct {
14
  Name         string            `mapstructure:"name"`
15
  Port         int               `mapstructure:"port"`
16
  Debug        bool              `mapstructure:"debug"`
17
  Timeout      time.Duration     `mapstructure:"timeout"`
18
  AllowedHosts []string          `mapstructure:"allowed_hosts"`
19
  Labels       map[string]string `mapstructure:"labels"`
20
}
21

22
type Server struct {
23
  Name    string `mapstructure:"name"`
24
  Address string `mapstructure:"address"`
25
}
26

27
type Config struct {
28
  App     AppConfig `mapstructure:"app"`
29
  Servers []Server  `mapstructure:"servers"`
30
}
31

32
func validateConfig(cfg Config) error {
33
  if cfg.App.Name == "" {
34
    return fmt.Errorf("app.name 不能为空")
35
  }
36
  if cfg.App.Port < 1 || cfg.App.Port > 65535 {
37
    return fmt.Errorf("app.port 必须在 1 到 65535 之间")
38
  }
39
  if cfg.App.Timeout <= 0 {
40
    return fmt.Errorf("app.timeout 必须大于 0")
41
  }
42
  return nil
43
}
44

45
func loadConfig(path string) (Config, error) {
46
  v := viper.New()
47
  v.SetConfigFile(path)
48
  v.SetDefault("app.port", 3000)
49
  v.SetDefault("app.timeout", "5s")
50

51
  if err := v.ReadInConfig(); err != nil {
52
    return Config{}, fmt.Errorf("读取配置失败: %w", err)
53
  }
54
  var cfg Config
55
  if err := v.UnmarshalExact(&cfg); err != nil {
56
    return Config{}, fmt.Errorf("解码配置失败: %w", err)
57
  }
58
  if err := validateConfig(cfg); err != nil {
59
    return Config{}, err
60
  }
61
  return cfg, nil
62
}
63

64
func main() {
65
  const path = "config/config.yaml"
66
  cfg, err := loadConfig(path)
67
  if err != nil {
68
    log.Fatal(err)
69
  }
70

71
  changed := make(chan struct{}, 1)
72
  watcher := viper.New()
73
  watcher.SetConfigFile(path)
74
  watcher.OnConfigChange(func(_ fsnotify.Event) {
75
    select {
76
    case changed <- struct{}{}:
77
    default:
78
    }
79
  })
80
  watcher.WatchConfig()
81

82
  stop := make(chan os.Signal, 1)
83
  signal.Notify(stop, os.Interrupt)
84
  defer signal.Stop(stop)
85
  ticker := time.NewTicker(2 * time.Second)
86
  defer ticker.Stop()
87
  fmt.Println("正在监听，按 Ctrl+C 退出")
88

89
  for {
90
    select {
91
    case <-changed:
92
      next, err := loadConfig(path)
93
      if err != nil {
94
        log.Println("拒绝更新，继续使用旧配置:", err)
95
        continue
96
      }
97
      cfg = next
98
      fmt.Println("配置已更新")
99
    case <-ticker.C:
100
      fmt.Printf("当前配置: name=%s port=%d debug=%t\n",
101
        cfg.App.Name, cfg.App.Port, cfg.App.Debug)
102
    case <-stop:
103
      return
104
    }
105
  }
106
}

执行：

1
go run -race main.go

程序每两秒打印当前配置。启动时读取失败就退出，因为还没有有效配置；运行期间更新失败只记录错误并继续运行。

loadConfig 每次创建独立的 Viper 和结构体，失败不会污染当前配置。监听实例只负责发通知，主循环重新读取文件得到明确的错误结果。

容量为 1 的通道保存一个待处理通知，default 跳过重复通知，避免阻塞回调。主循环读取最新文件，不必记录每个保存事件。

只有主循环读写 cfg。其他 goroutine 不访问它，所以这里不需要加锁；若接入并发 HTTP handler，则需要锁或不可变快照来发布配置。

第一次修改#

在程序运行期间，将端口改为：

1
  port: 9090

保存后应接受更新并打印 9090。

第二次修改#

将端口改为：

1
  port: 70000

保存后应拒绝更新，继续打印 9090。再将端口字段分别替换为下面两种内容，每次保存观察结果：

1
  port: abc

1
  prot: 8080

分别应出现类型转换或未知字段错误，并继续用旧值。

第三次修改#

临时将文件完整内容改成：

1
app: [

保存后应出现 YAML 读取错误，仍使用旧配置。监听实例自身也可能打印错误，与“拒绝更新”同时出现。

第四次修改#

将文件完整恢复成下面的合法配置：

1
app:
2
  name: viper-demo
3
  port: 6060
4
  debug: true
5
  timeout: 5s
6
  allowed_hosts:
7
    - localhost
8
    - example.com
9
  labels:
10
    environment: local
11
    owner: learner
12

13
servers:
14
  - name: primary
15
    address: "127.0.0.1:9001"
16
  - name: backup
17
    address: "127.0.0.1:9002"

保存后应恢复更新，开始打印 6060。

第五次修改#

删除恢复配置中的 port 这一行：

1
port: 6060

保存后应打印默认值 3000。每次创建新结构体可以避免缺失字段无意间保留上次解码结果。

第六次修改#

停止程序，创建 config/config.toml，完整内容为：

1
[app]
2
name = "viper-demo"
3
port = 8080
4
debug = true
5
timeout = "5s"
6
allowed_hosts = ["localhost", "example.com"]
7

8
[app.labels]
9
environment = "local"
10
owner = "learner"
11

12
[[servers]]
13
name = "primary"
14
address = "127.0.0.1:9001"
15

16
[[servers]]
17
name = "backup"
18
address = "127.0.0.1:9002"

将 main 中的路径常量替换为：

1
const path = "config/config.toml"

重新运行 go run -race main.go，将 TOML 的端口行替换为：

1
port = 9090

保存后预期接受更新。将超时行临时替换为：

1
timeout = "invalid"

保存后预期拒绝。再恢复为：

1
timeout = "5s"

保存后应恢复更新。

第七次修改#

停止程序，创建 config/config.json，完整内容为：

1
{
2
  "app": {
3
    "name": "viper-demo",
4
    "port": 8080,
5
    "debug": true,
6
    "timeout": "5s",
7
    "allowed_hosts": ["localhost", "example.com"],
8
    "labels": {
9
      "environment": "local",
10
      "owner": "learner"
11
    }
12
  },
13
  "servers": [
14
    {"name": "primary", "address": "127.0.0.1:9001"},
15
    {"name": "backup", "address": "127.0.0.1:9002"}
16
  ]
17
}

将路径常量替换为：

1
const path = "config/config.json"

重新运行，将 JSON 的端口字段替换为：

1
"port": 9090,

保存后应更新。将文件最后一个服务器对象临时替换为：

1
{"name": "backup", "address": "127.0.0.1:9002",}

这里故意留下末尾逗号，保存后应读取失败。再将该对象恢复为：

1
{"name": "backup", "address": "127.0.0.1:9002"}

保存后应恢复更新。

本章更新的是配置数据，没有启动真实网络服务。端口或数据库地址变化后，业务代码仍需负责切换监听器或连接。

-race 检测本次执行中触发的数据竞争，不等于证明所有并发场景都安全。本例针对普通本地文件保存；删除文件再创建、网络文件系统和容器挂载需要单独验证。v1.21.0 收到目标文件删除事件时可能停止监听，不应把修复语法错误后的恢复等同于支持所有文件生命周期变化。

HikariTish

热重载错误处理与旧配置保留#

初始示例#

第一次修改#

第二次修改#

第三次修改#

第四次修改#

第五次修改#

第六次修改#

第七次修改#

参考资料#

Viper 学习记录

继续阅读

换条路线

HikariTish

热重载错误处理与旧配置保留#

初始示例#

第一次修改#

第二次修改#

第三次修改#

第四次修改#

第五次修改#

第六次修改#

第七次修改#

参考资料#

分享文章

沿着主题读

换条路线