基本介绍

TOML致力于配置文件的小型化和易读性。

  1. WIKI介绍:
  2. 官方地址: https://github.com/toml-lang/toml
  3. 汉化版:

与其他格式比较

TOML与用于应用程序配置和数据序列化的其他文件格式(如YAMLJSON)具有相同的特性。TOMLJSON都很简单,并且使用普遍存在的数据类型,这使得它们易于编写代码或使用机器进行解析。TOMLYAML都强调人的可读性,比如注释,它使理解给定行的目的变得更容易。TOML的不同之处在于,它支持注释(不像JSON),但保持了简单性(不像YAML)。

由于TOML被显式地设计为一种配置文件格式,所以解析它很容易,但并不打算序列化任意的数据结构。TOML的文件顶层是一个哈希表,它很容易在键中嵌套数据,但是它不允许顶级数组或浮点数,所以它不能直接序列化一些数据。也没有标准来标识TOML文件的开始或结束,这会使通过流发送文件变得复杂。这些细节必须在应用层进行协商。

INI文件经常与TOML进行比较,因为它们在语法和用作配置文件方面具有相似性。然而,INI没有标准化的格式,它们不能优雅地处理超过一两个层次的嵌套。

基础语法

特点:

  • 大小写敏感,必须是UTF-8编码
  • 注释:#
  • 空白符:tab(0x09)space(0x20)
  • 换行符:LF(0x0A)CRLF(0x0D 0x0A)
  • 键值对:同一行,无值的键不可用,每行只能保存一个键值对

TOML主要结构是键值对,与JSON类似。值必须是如下类型: String, Integer, Float, Boolean, Datetime, Array, Table

注释

使用 # 表示注释:

  1. # I am a comment. Hear me roar. Roar.
  2. key = "value" # Yeah, you can do this.

字符串

TOML中有4种字符串表示方法:基本、多行-基本、字面量、多行-字面量

由三个双引号包裹,除了分隔符开始的换行外,字符串内的换行将被保留:

  1. str1 = """
  2. Roses are red

由单引号包裹,其内不允许转义,因此可以方便的表示基本字符串中需要转义的内容:

  1. winpath = 'C:\Users\nodejs\templates'

与多行-基本字符串相似:

  1. str1 = '''
  2. Roses are red
  3. Violets are blue'''

数值与BOOL值

  1. int1 = +99
  2. flt3 = -0.01
  3. bool1 = true

日期时间

数组

数组使用方括号包裹。空格会被忽略。元素使用逗号分隔。

注意,同一个数组下不允许混用数据类型。

  1. array1 = [ 1, 2, 3 ]
  2. array2 = [ "red", "yellow", "green" ]
  3. array4 = [ [ 1, 2 ], ["a", "b", "c"] ] # 这是可以的。
  4. array5 = [ 1, 2.0 ] # 注意:这是不行的。

表格

表格(也叫哈希表或字典)是键值对的集合。它们在方括号内,自成一行。注意和数组相区分,数组只有值。

  1. [table]

在此之下,直到下一个 table 或 EOF 之前,是这个表格的键值对。键在左,值在右,等号在中间。键以非空字符开始,以等号前的非空字符为结尾。键值对是无序的。

  1. [table]
  2. key = "value"

你可以随意缩进,使用 Tab空格。为什么要缩进呢?因为你可以嵌套表格。

  1. [dog.tater]
  2. type = "pug"

以上等价于如下的 JSON 结构:

  1. { "dog": { "tater": { "type": "pug" } } }

如果你不想的话,你不用声明所有的父表。TOML 知道该如何处理。

空表是允许的,其中没有键值对。

只要父表没有被直接定义,而且没有定义一个特定的键,你可以继续写入:

  1. [a.b]
  2. c = 1
  3. [a]
  4. d = 2

然而你不能多次定义键和表格。这么做是不合法的。

  1. # 别这么干!
  2. [a]
  3. b = 1
  4. [a]
  5. c = 2
  6. # 也别这个干
  7. [a]
  8. b = 1
  9. [a.b]
  10. c = 2

表格数组

最后要介绍的类型是表格数组。表格数组可以通过包裹在双方括号内的表格名来表达。使用相同的双方括号名称的表格是同一个数组的元素。表格按照书写的顺序插入。双方括号表格如果没有键值对,会被当成空表。

  1. [[products]]
  2. name = "Hammer"
  3. [[products]]
  4. [[products]]
  5. name = "Nail"
  6. color = "gray"

等价于以下的 JSON 结构:

  1. {
  2. "products": [
  3. { "name": "Hammer", "sku": 738594937 },
  4. { },
  5. { "name": "Nail", "sku": 284758393, "color": "gray" }
  6. ]
  7. }

表格数组同样可以嵌套。只需在子表格上使用相同的双方括号语法。每一个双方括号子表格从属于最近定义的上层表格元素。

  1. [[fruit]]
  2. name = "apple"
  3. [fruit.physical]
  4. color = "red"
  5. shape = "round"
  6. [[fruit.variety]]
  7. name = "red delicious"
  8. [[fruit.variety]]
  9. name = "granny smith"
  10. [[fruit]]
  11. name = "banana"
  12. [[fruit.variety]]
  13. name = "plantain"

尝试定义一个普通的表格,使用已经定义的数组的名称,将抛出一个解析错误:

  1. # 不合法的 TOML
  2. [[fruit]]
  3. name = "apple"
  4. [[fruit.variety]]
  5. name = "red delicious"
  6. # 和上面冲突了
  7. name = "granny smith"