GitHub TOML

最新推荐文章于 2025-07-31 11:29:05 发布
最新推荐文章于 2025-07-31 11:29:05 发布
阅读量682 收藏
点赞数
分类专栏： toml

转载：http://www.cppblog.com/tx7do/archive/2017/04/15/214854.html

TOML　的全称是　Tom's Obvious, Minimal Language，因为它的作者是 GitHub　联合创始人　Tom Preston-Werner 。

TOML 的目标

TOML 的目标是成为一个极简的配置文件格式。TOML 被设计成可以无歧义地被映射为哈希表，从而被多种语言解析。

例子

 

title = "TOML 例子"

[owner]
name = "Tom Preston-Werner"
organization = "GitHub"
bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
dob = 1979-05-27T07:32:00Z # 日期时间是一等公民。为什么不呢？

[database]
server = "192.168.1.1"
ports = [ 8001, 8001, 8002 ]
connection_max = 5000
enabled = true

[servers]

  # 你可以依照你的意愿缩进。使用空格或Tab。TOML不会在意。
  [servers.alpha]
  ip = "10.0.0.1"
  dc = "eqdc10"

  [servers.beta]
  ip = "10.0.0.2"
  dc = "eqdc10"

[clients]
data = [ ["gamma", "delta"], [1, 2] ]

# 在数组里换行没有关系。
hosts = [
  "alpha",
  "omega"
]

TOML 是大小写敏感的。

注释

使用 # 表示注释：

 

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

字符串

字符串和 JSON 的定义一致，只有一点除外：　TOML 要求使用　UTF-8 编码。

注释以引号包裹，里面的字符必须是　UTF-8 格式。引号、反斜杠和控制字符（U+0000 到 U+001F）需要转义。

"I'm a string. \"You can quote me\". Name\tJos\u00E9\nLocation\tSF."

常用的转义序列：

 

\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)
\/     - slash           (U+002F)
\\     - backslash       (U+005C)
\uXXXX - unicode         (U+XXXX)

使用保留的特殊字符，TOML　会抛出错误。例如，在　Windows 平台上，应该使用两个反斜杠来表示路径：

 

wrong = "C:\Users\nodejs\templates" # 注意：这不会生成合法的路径。
right = "C:\\Users\\nodejs\\templates"

二进制数据建议使用　Base64　或其他合适的编码。具体的处理取决于特定的应用。

整数

整数就是一些没有小数点的数字。想用负数？按直觉来就行。整数的尺寸最小为64位。

浮点数

浮点数带小数点。小数点两边都有数字。64位精度。

3.1415
-0.01

布尔值

布尔值永远是小写。

true
false

日期时间

使用　ISO 8601　完整格式。

1979-05-27T07:32:00Z

　数组

数组使用方括号包裹。空格会被忽略。元素使用逗号分隔。注意，不允许混用数据类型。

[ 1, 2, 3 ]
[ "red", "yellow", "green" ]
[ [ 1, 2 ], [3, 4, 5] ]
[ [ 1, 2 ], ["a", "b", "c"] ] # 这是可以的。 
[ 1, 2.0 ] # 注意：这是不行的。

数组可以多行。也就是说，除了空格之外，方括号间的换行也会被忽略。在关闭方括号前的最终项后的逗号是允许的。

表格

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

[table]

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

[table] key = "value"

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

嵌套表格的表格名称中使用.。你可以任意命名你的表格，只是不要用点，点是保留的。

[dog.tater] type = "pug"

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

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

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

# [x] 你 # [x.y] 不需要 # [x.y.z] 这些
[x.y.z.w] # 可以直接写

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

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

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

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

# 别这么干！

[a]
b = 1

[a]
c = 2 
# 也别这个干
[a]
b = 1

[a.b]
c = 2

表格数组

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

 

[[products]]
name = "Hammer"
sku = 738594937

[[products]]

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

等价于以下的　JSON 结构：

{
  "products": [
    { "name": "Hammer", "sku": 738594937 },
    { },
    { "name": "Nail", "sku": 284758393, "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"

等价于如下的　JSON 结构：

 

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

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

# 不合法的　TOML
[[fruit]]
   name = "apple"

   [[fruit.variety]]
        name = "red delicious" 
# 和上面冲突了
[fruit.variety]
    name = "granny smith"

来真的？

是的。

但是为什么？

因为我们需要一个像样的人类可读的格式，同时能无歧义地映射到哈希表。然后　YAML 的规范有 80 页那么长，真是发指！不，不考虑　JSON 。你知道为什么。

天哪，你是对的！

哈哈！想帮忙么？发合并请求过来。或者编写一个解析器。勇敢一点。

实现

如果你有一个实现，请发一个合并请求，把你的实现加入到这个列表中。请在你的解析器的 README 中标记你的解析器支持的 提交SHA1 或 版本号。

校验

@BurntSushi) - https://github.com/BurntSushi/toml/tree/master/tomlv

TOML 测试套件 （语言无关）

编辑器支持

编码器

TOML（Tom‘s Obvious, Minimal Language）配置文件格式基本用法和特性汇总
小秋 AI SLAM 入门实战教程
02-23 1676
它用于配置文件的编写，其设计哲学是简洁明了，易于人类理解和编辑，同时也易于机器精确解析。TOML的语法类似于INI文件，但提供了更丰富的数据类型和结构。TOML广泛用于配置文件，特别是在需要清晰、易于手动编辑的文件中。它的简洁性和直观性使得它在许多现代应用程序和工具中被采用，例如Rust的包管理器Cargo和Python的包管理工具Poetry等。TOML的设计理念使其成为一个优秀的配置文件格式选择，尤其是对于那些希望最小化学习曲线同时需要表达复杂配置的开发者和应用程序。：用于表示嵌套的表。
Hugo + Github配置个人博客搭建指南
Tanqueen的博客
09-16 1768
写在前面正如我前文所说，我在整个的搭建过程中还是踩了不少的坑，究其原因，就是因为太怕麻烦，结果变得更加麻烦，反而浪费时间。所以授人以鱼不如授人以渔，我想在我写的教程里尽量将可能出现的问题和原因都写清楚，也算是对今天这一天不务正业的总结。应该是详细的，不详细的话，只能不详细了。。。希望你已经安装了git。
TOML简介
热门推荐
用心做事
02-19 2万+
TOML简介GitHub 目前的新项目已经转用　CoffeeScript 了。CoffeeScript 比　JavaScript　要简洁优雅得多。同样地，GitHub　也觉得 YAML 不够简洁优雅，因此捣鼓出了一个　TOML。TOML　的全称是　Tom’s Obvious, Minimal Language，因为它的作者是 GitHub　联合创始人　Tom Preston-Werner 。GitH
toml
Mar.三月
07-10 1767
toml是一种配置文件格式，常见的配置文件格式有很多种，toml是我最新见到的，常见的有.ini .json .yaml\yml .xml ,但是toml最为简洁、最为语义化！ TOML 是前GitHub CEO， Tom Preston-Werner，于2013年创建的语言，其目标是成为一个小规模的易于使用和阅读的语义化配置文件格式。 TOML的目标是成为一个有明显语义而容易去阅读的...
Python 项目中，TOML（Tom‘s Obvious, Minimal Language）是一种常用的配置文件格式
nbspzs的专栏
12-30 546
【代码】Python 项目中，TOML（Tom‘s Obvious, Minimal Language）是一种常用的配置文件格式。
TOML简介 （转）
weixin_30951389的博客
02-14 391
TOML的由来 配置文件的使用由来已久，从.ini、XML、JSON、YAML再到TOML，语言的表达能力越来越强，同时书写便捷性也在不断提升。 TOML是前GitHub CEO， Tom Preston-Werner，于2013年创建的语言，其目标是成为一个小规模的易于使用的语义化配置文件格式。TOML被设计为可以无二义性的转换为一个哈希表(Hash table)。 例子 ...
toml-php:用 PHP 解析 TOML
07-12
如果你愿意，你也可以从 GitHub 下载/克隆源代码。 只需在您的应用程序中包含src/Toml/Toml.php文件，您就可以开始使用了。 用法 下面将解析一个 TOML 格式的字符串： $array = \Toml\parse('title = "TOML ...
toml:适用于TOML的Python库
05-13
git clone https://github.com/uiri/toml.git cd toml python setup.py install 快速教程 toml.loads接收一个包含标准TOML格式数据的字符串，并返回一个包含已解析数据的字典。 >>> import toml >>> toml_string = ...
go-toml：TOML语言的Go库
02-03
import "github.com/pelletier/go-toml" 使用范例 阅读TOML文档： config , _ := toml . Load ( ` [postgres] user = "pelletier" password = "mypassword"` ) // retrieve data directly user := config . Get ( ...
go-toml-config:Go的基于TOML的配置
04-13
go-toml-config ... import "github.com/stvp/go-toml-config" var ( country = config . String ( "country" , "Unknown" ) atlantaEnabled = config . Bool ( "atlanta.enabled" , false ) alantaPopulation
TOML 介绍
chunji9994的博客
10-09 310
GitHub 目前的新项目已经转用　CoffeeScript了。CoffeeScript 比　JavaScript　要简洁优雅得多。同样地，GitHub　也觉得 YAML 不够简洁优雅，因此捣鼓出了一个　TOML。 TOML　的全称是　Tom's Obvious, Minimal Lang...
TOML介绍
最新发布
07-31 365
项目说明TOML 是什么一种现代配置文件格式设计目标明显、最小、易读适用场景项目配置、依赖管理、服务设置优点有注释、类型丰富、无歧义缺点不适合复杂嵌套数据推荐使用替代 JSON/YAML 做配置文件。
【TOML配置文件】配置文件我用TOML！人性化，少出错！
IT里的交易员-博客
08-06 8729
配置文件的使用由来已久，从.ini、XML、JSON、YAML再到TOML，语言的表达能力越来越强，同时书写便捷性也在不断提升。接触到TOML是因为前几种都有其不方便的地方，具体就不解释了。要写配置文件，关键就是要简单方便，还要不出错。......
什么是TOML？
weixin_30301449的博客
04-09 760
配置文件的使用由来已久，从.ini、XML、JSON、YAML再到TOML，语言的表达能力越来越强，同时书写便捷性也在不断提升。 TOML是前GitHub CEO， Tom Preston-Werner，于2013年创建的语言，其目标是成为一个小规模的易于使用的语义化配置文件格式。TOML被设计为可以无二义性的转换为一个哈希表(Hash table)。Comparison with Other F...
toml文件格式
demon7552003的小本本
05-22 1660
TOML的由来 配置文件的使用由来已久，从.ini、XML、JSON、YAML再到TOML，语言的表达能力越来越强，同时书写便捷性也在不断提升。 TOML是前GitHub CEO， Tom Preston-Werner，于2013年创建的语言，其目标是成为一个小规模的易于使用的语义化配置文件格式。TOML被设计为可以无二义性的转换为一个哈希表(Hash table)。 例子 # 这是一个TOML文件 title = "TOML Example" [owner] name = "Lance Uppercu
TOML：简洁明了的配置文件格式
一起coding，一起嗨。
06-20 486
TOML：简洁明了的配置文件格式
什么是 TOML？
pumpkin84514的博客
05-31 790
TOML，全称，是一个专门为配置文件设计的语言，追求的是：“人类易读 + 机器易解析”。TOML 的语法非常接近 INI，但更加强大和一致性，是 Rust 官方默认的配置文件格式。app: App,port: u16,port: u16,部分内容配置文件格式TOMLRust工具serdetomlcrate使用场景项目配置、插件配置、本地服务配置优势层级清晰、易读、强类型映射支持。
TOML配置文件，可能是目前 YAML 最有力的竞争者
2301_77645573的博客
05-22 882
TOML是在 2013 年发布的配置文件格式。距今虽然有8年历史了，但是之前一直没有在大项目中见过的。我是前段时间在看python的pep规范，无意中看到了这种配置文件格式，稍微了解了一下，才发现现在有很多新的明星项目都喜欢用它来做配置文件。
TOML配置文件格式，YAML最有力的竞争者
分享软件测试技术和学习方法
08-02 2684
​​今天我们一起来学习toml这种简洁的配置文件格式吧。TOML是在 2013 年发布的配置文件格式。距今虽然有8年历史了，但是之前一直没有在大项目中见过的。我是前段时间在看python的pep规范，无意中看到了这种配置文件格式，稍微了解了一下，才发现现在有很多新的明星项目都喜欢用它来做配置文件。1、有rust语言的包管理工具cargo；2、类似于docker的容器工具containerd；3、go语言很多项目都喜欢用。比如静态网站生成工具Hugo、数据库InfluxDB、GitLab CI。...
go toml
03-11
### Go语言中TOML格式配置文件解析 #### 使用第三方库 `github.com/BurntSushi/toml` 在Go语言中处理TOML格式的配置文件通常依赖于`github.com/BurntSushi/toml`这个流行的第三方库。此库提供了简单易用的方法来加载并解析TOML文件。 安装该库可以通过命令行执行： ```bash go get github.com/BurntSushi/toml ``` 定义结构体用于映射TOML中的键值对，例如对于给定的内容[^3]，可以创建如下结构体： ```go type Config struct { Title string `toml:"title"` Owner string `toml:"owner"` Version float64 `toml:"version"` } ``` 读取和解析TOML文件的具体实现方式如下所示： ```go package main import ( "fmt" "log" toml "github.com/BurntSushi/toml" ) func main() { var config Config if _, err := toml.DecodeFile("config.toml", &config); err != nil { log.Fatal(err) } fmt.Printf("%+v\n", config) } ``` 这段代码会打开名为`config.toml`的文件，并尝试将其内容解码到预先定义好的`Config`结构体实例中去。如果遇到任何错误，则终止程序运行并打印出错信息；否则将以友好的格式输出已解析的数据。 当涉及到更复杂的嵌套结构时，如数据库连接信息或者SQL语句列表等复杂场景下的配置项[^4]，同样也可以通过扩展相应的结构体字段来进行适配： ```go type Database struct { Driver string `toml:"driver"` User string `toml:"us"` // 注意这里使用的是'us' Password string `toml:"password"` } type SQLStatements struct { Sql1 string `toml:"sql_1"` Sql2 string `toml:"sql_2"` Sql3 string `toml:"sql_3"` Sql4 string `toml:"sql_4"` } type FullConfig struct { Config `toml:",inline"` // 继承自上面定义的基础配置 Database Database `toml:"Database"` SQL SQLStatements `toml:"SQL"` } ``` 这样就可以更加灵活地应对不同类型的配置需求了。 #### TOML特性支持 值得注意的是，在编写TOML配置文件的过程中还可以利用一些特殊的语法糖使得书写更为简洁高效。比如针对Windows路径或正则表达式的特殊字符问题，TOML提供了一种叫做字面量字符串的功能，它可以避免不必要的转义操作，提高可读性和维护性[^2]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值