Go使用BurntSushi/toml读取TOML文件返回空结构体问题

问题表现 #

读取TOML配置实现多类文件系统规则支持时，除filesystem.file外还需兼容filesystem.s3等类型，各类型下独立定义路径参数，调用解析接口后仅返回空结构体{map[file:{map[]}]}，配置内容未被正确加载。
使用的TOML解析库为BurntSushi/toml。

问题复现材料 #

TOML配置文件（test.toml） #

[filesystem.file]
    [filesystem.file.test]
        folder = "tmp/testdata"
    [filesystem.file.test2]
        folder = "tmp/testdata2"
[filesystem.s3]
    [filesystem.s3.test]
        folder = "s3folder/testdata"

原有Go业务代码 #

package main

type File struct {
    Folder string `toml:"folder"`
}

type FileSystem struct {
    File map[string]File `toml:"file"`
}

type Config struct {
    FileSystem  map[string]FileSystem `toml:"filesystem"`
}

func main() {
    var conf Config
    _, err := toml.DecodeFile("test.toml", &conf)
    if err != nil {
        log.Fatalln("Error on loading config: ", err)
    }
    log.Printf("config: %v", conf)
}

问题根因 #

结构体定义和TOML配置层级不匹配：

1. 多余嵌套了FileSystem结构体，该结构体仅定义了File字段，相当于要求配置中filesystem.file层级下必须存在file子键才能解析，但实际配置中该层级下直接是test/test2等实例配置，无对应file子键，因此解析结果为空。
2. FileSystem结构体没有定义S3相关字段，filesystem.s3下的所有配置会被直接忽略。
3. 原有代码缺失必要的包导入，本身无法正常编译。

修复方案 #

调整结构体层级，去掉多余的中间结构体，让Go结构体字段和TOML配置层级一一对应，修复后代码如下：

package main

import (
	"log"
	"github.com/BurntSushi/toml"
)

// File 对应单个文件系统实例的配置参数
type File struct {
	Folder string `toml:"folder"`
}

// Config 对应TOML文件顶级配置结构
type Config struct {
	// 第一层map key为文件系统类型（file/s3等），第二层map key为对应类型下的实例名（test/test2等）
	FileSystem map[string]map[string]File `toml:"filesystem"`
}

func main() {
	var conf Config
	_, err := toml.DecodeFile("test.toml", &conf)
	if err != nil {
		log.Fatalln("Error on loading config: ", err)
	}
	// 用%+v打印可输出更详细的结构信息
	log.Printf("config: %+v", conf)
}

修复后运行输出 #

config: {FileSystem:map[file:map[test:{Folder:tmp/testdata} test2:{Folder:tmp/testdata2}] s3:map[test:{Folder:s3folder/testdata}]]}

所有配置项均可正常读取。

扩展说明 #

如果后续不同文件系统类型的配置字段存在差异（比如S3类型需要额外配置bucket、region参数，本地file类型仅需folder参数），可以将第二层map的值类型设置为toml.Primitive实现延迟解码，根据文件系统类型选择对应结构体反序列化即可。

内容的提问来源于stack exchange，提问作者TheQuestioner