go语言中使用viper库读取配置时,为何需要传递可寻址指针?
本文探讨Go语言中使用Viper库读取配置时,为何readsection函数需要传递可寻址指针作为参数。
问题描述:
在Go程序中,使用Viper库读取配置文件到结构体时,如果直接传递结构体指针,可能会出现result must be addressable (a pointer)错误。
代码示例:
立即学习“go语言免费学习笔记(深入)”;
假设有如下代码结构:
-
setting模块: 负责创建Viper实例并读取配置文件。
package setting
import (
"github.com/spf13/viper"
"time"
)
type Setting struct {
vp *viper.Viper
}
func NewSetting() (*Setting, error) {
vp := viper.New()
vp.SetConfigName("config")
vp.AddConfigPath("configs/")
vp.SetConfigType("yaml")
err := vp.ReadInConfig()
if err != nil {
return nil, err
}
return &Setting{vp: vp}, nil
}
func (s *Setting) ReadSection(k string, v interface{}) error {
err := s.vp.UnmarshalKey(k, v) // 注意这里使用UnmarshalKey
if err != nil {
return err
}
return nil
}
-
global模块: 定义全局变量存储配置信息。
package global
import "github.com/your-project/setting" // 替换成你的setting包路径
type ServerSettings struct {
RunMode string `mapstructure:"runmode"`
HTTPPort string `mapstructure:"httpport"`
ReadTimeout time.Duration `mapstructure:"readtimeout"`
WriteTimeout time.Duration `mapstructure:"writetimeout"`
}
var ServerSetting *ServerSettings
-
main模块: 初始化和使用Viper。
package main
import (
"fmt"
"github.com/your-project/global" // 替换成你的global包路径
"github.com/your-project/setting" // 替换成你的setting包路径
)
func main() {
setting, err := setting.NewSetting()
if err != nil {
fmt.Println("Error:", err)
return
}
err = setting.ReadSection("server", &global.ServerSetting) // 正确的写法
if err != nil {
fmt.Println("Error:", err)
return
}
fmt.Println(global.ServerSetting)
}
错误原因分析:
Viper 库的 UnmarshalKey 函数需要一个可寻址的指针作为参数。 &global.ServerSetting 提供了 ServerSetting 指针的内存地址,Viper 可以将读取到的配置数据写入该内存地址。而直接使用 global.ServerSetting 只传递了指针的值,而不是指针本身的地址,Viper 无法修改其指向的内存区域。
解决方法:
必须使用 &global.ServerSetting 来传递可寻址的指针,这样 Viper 才能正确地将配置数据解组到 global.ServerSetting 指向的结构体中。
总结:
Go 语言的指针特性和 Viper 库的解组机制共同决定了必须传递可寻址指针。理解 Go 语言中的指针和可寻址性对于正确使用 Viper 库至关重要。 记住,UnmarshalKey 需要一个可修改的内存地址来存储解组后的数据。 使用 & 操作符获取变量的可寻址指针是解决问题的关键。











