Golang 配置文件: TOML vs YAML

YAML

YAML 是 "YAML Ain't a Markup Language"（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。

YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。

YAML 的配置文件后缀为 .yml，如：runoob.yml 。

基本语法

1. 大小写敏感
2. 使用缩进表示层级关系
3. 缩进不允许使用tab，只允许空格
4. 缩进的空格数不重要，只要相同层级的元素左对齐即可
5. '#'表示注释

TOML

Comparison with Other Formats

TOML shares traits with other file formats used for application configuration and data serialization, such as YAML and JSON. TOML and JSON both are simple and use ubiquitous data types, making them easy to code for or parse with machines. TOML and YAML both emphasize human readability features, like comments that make it easier to understand the purpose of a given line. TOML differs in combining these, allowing comments (unlike JSON) but preserving simplicity (unlike YAML).

Because TOML is explicitly intended as a configuration file format, parsing it is easy, but it is not intended for serializing arbitrary data structures. TOML always has a hash table at the top level of the file, which can easily have data nested inside its keys, but it doesn't permit top-level arrays or floats, so it cannot directly serialize some data. There is also no standard identifying the start or end of a TOML file, which can complicate sending it through a stream. These details must be negotiated on the application layer.

INI files are frequently compared to TOML for their similarities in syntax and use as configuration files. However, there is no standardized format for INI and they do not gracefully handle more than one or two levels of nesting.

Further reading:

• YAML spec: https://yaml.org/spec/1.2/spec.html
• JSON spec: RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format
• Wikipedia on INI files: https://en.wikipedia.org/wiki/INI_file

Tools: spf13/viper

Viper is a complete configuration solution for Go applications including 12-Factor apps. It is designed to work within an application, and can handle all types of configuration needs and formats. It supports:

• setting defaults
• reading from JSON, TOML, YAML, HCL, envfile and Java properties config files
• live watching and re-reading of config files (optional)
• reading from environment variables
• reading from remote config systems (etcd or Consul), and watching changes
• reading from command line flags
• reading from buffer
• setting explicit values

Viper can be thought of as a registry for all of your application's configuration needs.

Viper和Cobra工具是可以一起搭配使用。Viper负责配置文件读写管理，而Cobra负责构建强大的命令行工具.

Cobra: https://github.com/spf13/cobra 

Cobra is a library for creating powerful modern CLI applications.

Cobra is used in many Go projects such as Kubernetes, Hugo, and Github CLI to name a few. This list contains a more extensive list of projects using Cobra.

参考文档

• TOML

• • GitHub - toml-lang/toml: Tom's Obvious, Minimal Language
  • TOML: Tom's Obvious Minimal Language
  • 如何读取配置文件

• • • GitHub - BurntSushi/toml: TOML parser for Golang with reflection
    • GitHub - spf13/viper: Go configuration with fangs

•  YAML

• • YAML 入门教程 | 菜鸟教程
  • 如何读取配置文件

• • • GitHub - spf13/viper: Go configuration with fangs

• 两者对比

• • 深入对比TOML，JSON和YAML-阿里云开发者社区
  • YAML vs TOML : devops