配置文件格式 TOML 快速上手

大家好，欢迎来到IT知识分享网。

文章目录

1.简介
2.语法
3.数据结构
4.实例
参考文献

1.简介

GitHub 联合创始人 Tom Preston-Werner 觉得 YAML 不够简洁优雅，如缩进要严格对齐，因此和其他几位开发者一起捣鼓了一个 TOML（Tom’s Obvious Minimal Language）。

TOML 旨在成为一个语义显著且易于阅读的极简配置文件格式，能够无歧义地转化为哈希表，且能够简单解析成编程语言中形形色色的数据结构，用于取代 YAML 和 JSON。

2.语法

TOML 的基本语法规则如下：

TOML 是大小写敏感的
TOML 文件必须是合法的 UTF-8 编码的 Unicode 文档
空白的意思是 Tab（0x09）或空格（0x20）
换行的意思是 LF（0x0A）或 CRLF（0x0D0A）
井号将此行剩下的部分标记为注释

3.数据结构

3.1 键值对

TOML 文档最基本的构成区块是键值对。

键名在等号的左边而值在右边。
键名和键值周围的空白会被忽略。
键、等号和值必须在同一行（不过有些值可以跨多行）。

key = "value"

值必须是这些类型：字符串，整数，浮点数，布尔值，日期时刻，数组或行内表。不指定值是有误的。

键名可以是裸露的，引号引起来的，或点分隔的。

裸键只能包含 ASCII 字母，ASCII 数字，下划线和短横线（A-Za-z0-9_-）。

key = "value" bare_key = "value" bare-key = "value" 1234 = "value"

引号键遵循与基础字符串或字面量字符串相同的规则并允许你使用更为广泛的键名。除非必要，使用裸键为最佳实践。

"127.0.0.1" = "value" "character encoding" = "value" "ʎǝʞ" = "value" 'key2' = "value" 'quoted "value"' = "value"

点分隔键是一系列通过点相连的裸键或引号键。这允许了你将相近属性放在一起：

"名称" = "橙子" "物理属性"."颜色" = "橙色" "物理属性"."形状" = "圆形" site."google.com" = true

这在 JSON 那是以下结构：

{ 
    "名称": "橙子", "物理属性": { 
    "颜色": "橙色", "形状": "圆形" }, "site": { 
    "google.com": true } }

点分隔符周围的空白会被忽略，不过，最佳实践是不要使用任何不必要的空白。

多次定义同一个键是不行的。

# 不要这样做 name = "Tom" name = "Pradyun"

3.2 字符串

共有四种方式来表示字符串：基础式、多行基础式、字面量式和多行字面量式。所有字符串都只能包含有效的 UTF-8 字符。

基础字符串

任何 Unicode 字符都可以使用，除了那些必须转义的：引号，反斜杠，以及控制字符（U+0000 至 U+001F，U+007F）。

str = "我是一个字符串。\"你可以把我引起来\"。姓名\tJos\u00E9\n位置\t旧金山。"

为了方便，一些流行的字符有其简便转义写法。

\b - backspace (U+0008) \t - tab (U+0009) \n - linefeed (U+000A) \f - form feed (U+000C) \r - carriage return (U+000D) \" - quote (U+0022) \\ - backslash (U+005C) \uXXXX - unicode (U+XXXX) \UXXXXXXXX - unicode (U+XXXXXXXX)

任何 Unicode 字符都可以用 \uXXXX 或 \UXXXXXXXX 的形式来转义。转义码必须是有效的 Unicode 标量值。

所有上面未列出的其它转义序列都是保留的，如果被用了，TOML 应当生成一个错误。

有时你需要表示一小篇文本（例如译文）或者想要对非常长的字符串进行折行。TOML 对此进行了简化。

多行基础字符串

多行基础字符串由三个引号包裹，允许折行。紧随开头引号的那个换行会被去除。其它空白和换行符会被原样保留。

str1 = """ 玫瑰是红色的 紫罗兰是蓝色的"""

TOML 解析器可以相对灵活地解析成对所在平台有效的换行字符。

# 在 Unix 系统，上面的多行字符串可能等同于： str2 = "玫瑰是红色的\n紫罗兰是蓝色的" # 在 Windows 系统，它可能等价于： str3 = "玫瑰是红色的\r\n紫罗兰是蓝色的"

想书写长字符串却不想引入无关空白，可以用“行末反斜杠”。当一行的最后一个非空白字符是 \ 时，它会连同它后面的所有空白（包括换行）一起被去除，直到下一个非空白字符或结束引号为止。所有对基础字符串有效的转义序列，对多行基础字符串也同样适用。

# 下列字符串的每一个字节都完全相同： str1 = "那只 敏捷的 棕 狐狸 跳 过了 那只 懒 狗。" str2 = """ 那只 敏捷的 棕 \ 狐狸 跳 过了 \ 那只 懒 狗。""" str3 = """\ 那只 敏捷的 棕 \ 狐狸 跳 过了 \ 那只 懒 狗。\ """

任何 Unicode 字符都可以使用，除了那些必须被转义的：反斜杠和控制字符（U+0000 至 U+001F，U+007F）。引号不需要转义，除非它们的存在会造成一个比预期提前的结束标记。

如果你常常要指定 Windows 路径或正则表达式，那么必须转义反斜杠就马上成为啰嗦而易错的了。为了帮助搞定这点，TOML 支持字面量字符串，它完全不允许转义。

字面量字符串

字面量字符串由单引号包裹。类似于基础字符串，他们只能表现为单行：

# 所见即所得。 winpath = 'C:\Users\nodejs\templates' winpath2 = '\\ServerX\admin$\system32\' quoted = '汤姆·"达布斯"·普雷斯顿—维尔纳' regex = '<\i\c*\s*>'

由于没有转义，无法在由单引号包裹的字面量字符串中写入单引号。万幸，TOML 支持一种多行版本的字面量字符串来解决这个问题。

多行字面量字符串

regex2 = '''I [dw]on't need \d{2} apples''' lines = ''' 原始字符串中的 第一个换行被剔除了。 所有其它空白 都保留了。 '''

除 tab 以外的所有控制字符都不允许出现在字面量字符串中。因此，对于二进制数据，建议你使用 Base64 或其它合适的 ASCII 或 UTF-8 编码。对那些编码的处理方式，将交由应用程序自己来确定。

3.3 整数

整数是纯数字。正数可以有加号前缀。负数的前缀是减号。

int1 = +99 int2 = 42 int3 = 0 int4 = -17

对于大数，你可以在数字之间用下划线来增强可读性。每个下划线两侧必须至少有一个数字。

int5 = 1_000 int6 = 5_349_221 int7 = 1_2_3_4_5 # 无误但不鼓励

前导零是不允许的。整数值 -0 与 +0 是有效的，并等同于无前缀的零。

非负整数值也可以用十六进制、八进制或二进制来表示。在这些格式中，+ 不被允许，而（前缀后的）前导零是允许的。十六进制值大小写不敏感。数字间的下划线是允许的（但不能存在于前缀和值之间）。

# 带有 `0x` 前缀的十六进制 hex1 = 0xDEADBEEF hex2 = 0xdeadbeef hex3 = 0xdead_beef # 带有 `0o` 前缀的八进制 oct1 = 0o0 oct2 = 0o755 # 对于表示 Unix 文件权限很有用 # 带有 `0b` 前缀的二进制 bin1 = 0b

取值范围要求为 64 比特（signed long）（−9,223,372,036,854,775,808 至 9,223,372,036,854,775,807）。

3.4 浮点数

浮点数应当被实现为 IEEE 754 binary64 值。

# 小数 flt1 = +1.0 flt2 = 3.1415 flt3 = -0.01 # 指数 flt4 = 5e+22 flt5 = 1e6 flt6 = -2E-2 # 都有 flt7 = 6.626e-34

flt8 = 224_617.445_991_228

浮点数值 -0.0 与 +0.0 是有效的，并且应当遵从 IEEE 754。

特殊浮点值也能够表示。它们是小写的。

# 无穷 sf1 = inf # 正无穷 sf2 = +inf # 正无穷 sf3 = -inf # 负无穷 # 非数 sf4 = nan # 实际上对应信号非数码还是静默非数码，取决于实现 sf5 = +nan # 等同于 `nan` sf6 = -nan # 有效，实际码取决于实现

3.5 布尔值

布尔值就是你所惯用的那样。要小写。

bool1 = true bool2 = false

3.6 坐标日期时刻

要明确无误地表示世上的一个特定时间，你可以使用指定了时区偏移量的 RFC 3339 格式的日期时刻。

odt1 = 1979-05-27T07:32:00Z odt2 = 1979-05-27T00:32:00-07:00 odt3 = 1979-05-27T00:32:00.-07:00

出于可读性的目的，你可以用空格替代日期和时刻中间的 T（RFC 3339 的第 5.6 节中允许了这样做）。

odt4 = 1979-05-27 07:32:00Z

小数秒的精度取决于实现，但至少应当能够精确到毫秒。如果它的值超出了实现所支持的精度，那多余的部分必须被舍弃，而不能四舍五入。

ldt1 = 1979-05-27T07:32:00 ldt2 = 1979-05-27T00:32:00.

如果你只写了 RFC 3339 日期时刻中的日期部分，那它表示一整天，同时也不涉及时区偏移。

ld1 = 1979-05-27

如果你只写了 RFC 3339 日期时刻中的时刻部分，它将只表示一天之中的那个时刻，而与任何特定的日期无关、亦不涉及时区偏移。

lt1 = 07:32:00 lt2 = 00:32:00.

3.7 数组

数组是内含值的方括号。空白会被忽略。子元素由逗号分隔。子元素的数据类型必须一致（不同写法的字符串应当被认为是相同的类型，不同元素类型的数组也同是数组类型）。

arr1 = [ 1, 2, 3 ] arr2 = [ "red", "yellow", "green" ] arr3 = [ [ 1, 2 ], [3, 4, 5] ] arr4 = [ "所有（写法的）", '字符串', """都是一样的""", '''类型'''] arr5 = [ [ 1, 2 ], ["a", "b", "c"] ] arr6 = [ 1, 2.0 ] # 有误

数组也可以跨多行。数组的最后一个值后面可以有终逗号（也称为尾逗号）。值和结束括号前可以存在任意数量的换行和注释。

arr7 = [ 1, 2, 3 ] arr8 = [ 1, 2, # 这是可以的 ]

3.8 表

表（也被称为哈希表或字典）是键值对的集合。它们在方括号里，并作为单独的行出现。看得出它们不同于数组，因为数组只有值。

在它下方，直至下一个表或文件结束，都是这个表的键值对。表不保证保持键值对的指定顺序。

[table-1] key1 = "some string" key2 = 123 [table-2] key1 = "another string" key2 = 456

表名的规则与键名相同（见前文键名定义）。

[dog."tater.man"] type.name = "pug"

这在 JSON 那儿，是以下结构：

{ "dog": { "tater.man": { "type": { "name": "pug" } } } }

键名周围的空格会被忽略，然而最佳实践还是不要有任何多余的空白。

[a.b.c] # 这是最佳实践 [ d.e.f ] # 等同于 [d.e.f] [ g . h . i ] # 等同于 [g.h.i] [ j . "ʞ" . 'l' ] # 等同于 [j."ʞ".'l']

你不必层层完整地写出你不想写的所有途径的父表。TOML 知道该怎么办。

# [x] 你 # [x.y] 不 # [x.y.z] 需要这些 [x.y.z.w] # 来让这生效

空表是允许的，只要里面没有键值对就行了。

类似于键名，你不能重复定义任何表。这样做是错误的。

# 不要这样做 [a] b = 1 [a] c = 2 # 也不要这样做 [a] b = 1 [a.b] c = 2

3.9 行内表

行内表提供了一种更为紧凑的语法来表示表，即在一行内表示一个表。行内表由花括号包裹，在括号中，可以出现零或多个逗号分隔的键值对。键值对采取与标准表中键值对相同的形式。什么类型的值都可以，包括行内表。

行内表出现在同一行内。不允许花括号中出现换行，除非它们存在于正确的值当中。即便如此，也强烈不建议把一个行内表搞成纵跨多行的样子。如果你发现自己真的需要，那意味着你应该使用标准表。

name = { first = "汤姆", last = "普雷斯顿—维尔纳" } point = { x = 1, y = 2 } animal = { type.name = "哈巴狗" } # 上述行内表等同于下面的标准表定义 [name] first = "汤姆" last = "普雷斯顿—维尔纳" [point] x = 1 y = 2 [animal] type.name = "哈巴狗"

3.10 表数组

最后还剩下一个没法表示的是表数组。

表数组可以通过双方括号来表示。各个具有相同方括号名的表将会成为该数组内的一员。这些表的出现顺序就是它们的插入顺序。

一个没有任何键值对的双方括号表将为视为一个空表。

[[products]] name = "Hammer" sku =  [[products]] [[products]] name = "Nail" sku =  color = "gray"

这在 JSON 那儿，是以下结构。

{ 
    "products": [ { 
    "name": "Hammer", "sku":  }, { 
    }, { 
    "name": "Nail", "sku": , "color": "gray" } ] }

你还可以创建一个嵌套表数组。只要在子表上使用相同的双方括号语法语法。每个双方括号子表将隶属于上方最近定义的表元素。

[[fruit]] name = "apple" [fruit.physical] color = "red" shape = "round" [[fruit.variety]] name = "red delicious" [[fruit.variety]] name = "granny smith" [[fruit]] name = "banana" [[fruit.variety]] name = "plantain"

上述 TOML 对应下面的 JSON。

{ 
    "fruit": [ { 
    "name": "apple", "physical": { 
    "color": "red", "shape": "round" }, "variety": [ { 
    "name": "red delicious" }, { 
    "name": "granny smith" } ] }, { 
    "name": "banana", "variety": [ { 
    "name": "plantain" } ] } ] }

若试图向一个静态定义的数组追加内容，即便数组尚且为空或类型兼容，也必须在解析时报错。

# 无效的 TOML 文档 fruit = [] [[fruit]] # 不允许 若试图用已经确定为数组的名称定义表，必须在解析时报错。 # 无效的 TOML 文档 [[fruit]] name = "apple" [[fruit.variety]] name = "red delicious" # 这个表与之前的表冲突了 [fruit.variety] name = "granny smith"

你也可以适当使用行内表：

points = [ { x = 1, y = 2, z = 3 }, { x = 7, y = 8, z = 9 }, { x = 2, y = 4, z = 8 } ]

4.实例

以 TOML 表示一个简单的服务配置。

name = "UserProfileServer" maxconns = 1000 queuecap = 10000 queuetimeout =300 [loginfo] loglevel = "ERROR" logsize = "10M" lognum = 10 logpath = "/usr/local/app/log"

以 Go 为例，解析上面的 TOML 配置文件。

第一步，通过 TOML-to-Go 快速将 TOML 转换为 Go struct。

type Server struct { 
    Name string `toml:"name"` Maxconns int `toml:"maxconns"` Queuecap int `toml:"queuecap"` Queuetimeout int `toml:"queuetimeout"` Loginfo struct { 
    Loglevel string `toml:"loglevel"` Logsize string `toml:"logsize"` Lognum int `toml:"lognum"` Logpath string `toml:"logpath"` } `toml:"loginfo"` }

第二步，通过第三方库 BurntSushi/toml 为例完成解析，当然你也可以选择其自己喜欢的第三方开源库，如 spf13/viper。

package main import( "fmt" "github.com/BurntSushi/toml" ) type Server struct { 
    Name string `toml:"name"` Maxconns int `toml:"maxconns"` Queuecap int `toml:"queuecap"` Queuetimeout int `toml:"queuetimeout"` Loginfo struct { 
    Loglevel string `toml:"loglevel"` Logsize string `toml:"logsize"` Lognum int `toml:"lognum"` Logpath string `toml:"logpath"` } `toml:"loginfo"` } func main() { 
    v := Server{ 
   } if _, err := toml.DecodeFile("server.toml", &v); err != nil { 
    fmt.Printf("parse toml failed, err=%v\n", err) } else { 
    fmt.Printf("%+v\n", v) } }

运行输出：

{Name:UserProfileServer Maxconns:1000 Queuecap:10000 Queuetimeout:300 Loginfo:{Loglevel:ERROR Logsize:10M Lognum:10 Logpath:/usr/local/app/log}}

参考文献

免责声明：本站所有文章内容,图片，视频等均是来源于用户投稿和互联网及文摘转载整编而成，不代表本站观点，不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益，请在线联系站长,一经查实,本站将立刻删除。本文来自网络,若有侵权，请联系删除，如若转载，请注明出处：https://haidsoft.com/112468.html