配置文件写法——常用数据格式TOML，JSON和YAML对比

最新推荐文章于 2024-06-15 09:51:54 发布
最新推荐文章于 2024-06-15 09:51:54 发布
阅读量4k 收藏 9
点赞数 1
分类专栏： Python技能与踩坑记录 网络安全与web安全实践 文章标签： json python 后端
原文链接：https://www.cnblogs.com/sunsky303/p/9208848.html
版权

本文将帮助您了解如何通过不同的数据格式构建数据。坦率地说，在我开始与Hugo TOML合作之前，我感到羞耻是一个需要发现的新领域，但我对YAML和JSON非常熟悉。

您可以 将所有这三种数据格式用于配置，前置事项和自定义数据 但TOML是用于整个项目的推荐格式。首先我想简单介绍一下每种数据格式，然后再进入规范和比较。

TOML（Tom’s Obvious，Minimal Language）
TOML显然是由Tom - Tom Preston-Werner编写的 - 确切地说。这是一个在麻省理工学院授权的开源项目，目前在Github上有超过5k星。2013年3月发布的第一个TOML版本，使TOML成为三个标准的年轻人。TOML的目标是成为最小的配置文件格式，由于精确的语义，这种格式易于阅读。TOML被设计为无歧义地映射到散列表。TOML应该很容易用各种语言来解析数据结构。

关于TOML语法的简短事实:
TOML区分大小写。
TOML文件只能包含UTF-8编码的Unicode字符。
空格表示制表符（0x09）或空格（0x20）。
换行符表示LF（0x0A）或CRLF（0x0D0A）。
要在前面的问题中使用TOML，你需要将它封装在+++如下之间：

+++
date = "2016-12-14T21:27:05.454Z"
publishdate = "2016-12-14T21:27:05.454Z"
 
title = "Deep dive into TOML, JSON and YAML"
tags = ["toml","yaml","json", "front matter"]
 
type = "article"
 
[amp]
    elements = []
    
[article]
    lead = "Lorem ipsum."
    category = "frontmatter"
    related = []
 
[sitemap]
  changefreq = "monthly"
  priority = 0.5
  filename = "sitemap.xml"
+++

YAML（不是标记语言）
YAML是一种广泛使用的语言，用于跨不同语言和框架的配置文件。YAML的创建者和维护者是Clark C. Evans，起初是SML-DEV，专注于简化XML的XML人员名单帮助生成Common XML，这是一个功能强大的XML子集，为XML创建了数据序列化的替代方案，特别是与Python ，Perl和Ruby。该项目始于2001年，第一个1.0版本于2009年1月由Oren Ben-Kiki，Clark Evans和Brian Ingerson发布。自2009年以来，当前版本1.2正在使用中。

关于YAML语法的简短事实:
.yml文件以’ - '开头，标记文档的开始
键值对由冒号分隔
列表以连字符开头
YAML使用具有一个或多个空格的缩进来描述嵌套集合
要在前面的问题中使用YAML，你需要将它包裹在之间—：

---
date: '2016-12-14T21:27:05.454Z'
publishdate: '2016-12-14T21:27:05.454Z'
title: Deep dive into TOML, JSON and YAML
tags:
- toml
- yaml
- json
- front matter
type: article
amp:
  elements: []
article:
  lead: Lorem ipsum.
  category: frontmatter
  related: []
sitemap:
  changefreq: monthly
  priority: 0.5
  filename: sitemap.xml
---

JSON（JavaScript对象表示法）
JSON是一种轻量级的数据交换格式。由于JavaScript和大多数Serverside语言本身支持JSON，因此JSON广泛用于Web环境中浏览器和服务器之间的API通信。在21世纪初，Douglas Crockford引入了数据格式JSON的第一个规范。当前版本由ECMA-404于2013年10月指定。

有关JSON语法的简短事实:
数据存储在名称/值对中
记录用逗号分隔。没有以下属性的尾随逗号是不允许的。
双引号包装属性名称和字符串。单引号是不允许的。
由于JSON包裹在两个花括号中，{}因此在Hugo的前端内容中没有必要使用特殊的包装：

{
    "date" : "2016-12-14T21:27:05.454Z",
    "publishdate" : "2016-12-14T21:27:05.454Z",
    "title" : "Deep dive into TOML, JSON and YAML",
    "tags" : ["toml","yaml","json", "front matter"],
    "type" : "article",
    "amp" : {
        "elements" : []
    },
    "article" : {
        "lead" : "Lorem ipsum.",
        "category" : "frontmatter",
        "related" : []
    },
    "sitemap" : {
      "changefreq" : "monthly",
      "priority" : 0.5,
      "filename" : "sitemap.xml"
    }
}

TOML，YAML和JSON之间的语法差异

现在让我们来看看最常见用例中的语法和功能集差异。

字符串

任何格式都支持Strings。唯一的区别在于，JSON不支持多行字符串。

TOML

key = "String Value"
multiline = """\
       The quick brown \
       fox jumps over \
       the lazy dog.\
       """
YAML
key : String Value
multilinePreservedLinebreaks:
|
  L1 - The quick brown
  L2 - fox jumps over
  L3 - the lazy dog.
multilineReplaceLinebreaksWithWhitespace:
>
  This sentence ist just too long to keep it
  on the same line.

JSON

{
  "key" : "String Value"
}

对象/哈希表/集合

TOML中的表格几乎与YAML中的JSON和Collections中的对象相同。要访问Hugo模板中的集合，请按照.类似方式导航{{ .Params.objectkey.subkey }}。


TOML
[table_key]
property = "Value"
secondProperty = "2nd Value"
 
[alternative.direct]
access = "results in alternative.direct.access for this value"
 
alternativeCalledInlineTable = { property = "Value", "etc" = "You got it." }

YAML
objectKey:
  property: Value
  secondProperty: 2nd Value
alternative: { subkey: 5.0, another: 123 }

JSON
{
  "objectKey" : {
    "property" : "Value",
    "secondProperty" : "2nd Value"
  }
}

数组/列表

数组或列表受所有语言支持。


TOML
fruits = [ "Apple", "Banana", "Strawberry" ]
formats = [
  "YAML",
  "JSON",
  "TOML"
]

YAML
fruits:
  - Apple
  - Banana
  - Strawberry
formats: [ YAML, JSON, TOML ]

JSON
{
  "fruits": ["Apple","Banana","Strawberry"],
  "formats": [
    "YAML",
    "JSON",
    "TOML"
  ]
}

为了扩展这些例子，我们可以创建一个各更为复杂的列表

对象/表/集合的列表

，就像这样：

TOML
[[fruits]]
name = "Apple"
weight = 600
 
[[fruits]]
name = "Banana"
weight = 300
 
[[fruits]]
name = "Strawberry"
weight = 40


YAML
fruits:
- name: Apple
  weight: 600
- name: Banana
  weight: 300
- name: Strawberry
  weight: 40


JSON
{
  "fruits": [
    {
        "name" : "Apple",
        "weight" : 600
    },
    {
        "name" : "Banana",
        "weight" : 300
    },
    {
        "name" : "Strawberry",
        "weight" : 40
    }
  ]
}

上面的所有示例都会生成一个可以{{ range .Params.fruits }}<strong>{{ .name }}</strong> - Weight: {{ .weight }}{{ end }}在Hugo模板文件中迭代的列表。

我认为你现在对数组和表格是如何协同工作有了很好的理解; 让我们再次扩展以获得完整的概述。


TOML
[[fruits]]
  name = "Apple"
  weight = 600
 
  [fruit.physical]
    color = "red"
    shape = "round"
 
  [[fruit.variety]]
    name = "red delicious"
 
  [[fruit.variety]]
    name = "granny smith"
 
[[fruits]]
  name = "Banana"
  weight = 300
 
  [fruit.physical]
    color = "yellow"
    shape = "curved"
    
  [[fruit.variety]]
    name = "plantain"
    
[[fruits]]
  name = "Strawberry"
  weight = 40
 
  [fruit.physical]
    color = "red"
    shape = "kind-of-oval"
    
  [[fruit.variety]]
    name = "the-good-one"


YAML
fruits:
- name: Apple
  weight: 600
  physical:
    color: red
    shape: round
  variety:
  - name: red delicious
  - name: granny smith
- name: Banana
  weight: 300
  physical:
    color: yellow
    shape: curved
  variety:
  - name: plantain
- name: Strawberry
  weight: 40
  physical:
    color: red
    shape: kind-of-oval
  variety:
  - name: the-good-one


JSON
{
  "fruits": [
    {
        "name" : "Apple",
        "weight" : 600,
        "physical": {
          "color": "red",
          "shape": "round"
        },
        "variety": [
          { "name": "red delicious" },
          { "name": "granny smith" }
        ]
    },
    {
        "name" : "Banana",
        "weight" : 300,
        "physical": {
          "color": "yellow",
          "shape": "curved"
        },
        "variety": [
          { "name": "plantain" }
        ]
    },
    {
        "name" : "Strawberry",
        "weight" : 40,
        "physical": {
          "color": "red",
          "shape": "kind-of-oval"
        },
        "variety": [
          { "name": "the-good-one" }
        ]
    }
  ]
}

数字（整数，浮点数，无穷大等）

所有数据结构中的数字编写都非常相似，但功能集有所不同：



TOML
explicit_pos = +99
positive = 42
zero = 0
negative = -17
 
# For large numbers, you may use underscores to enhance readability.
# Each underscore must be surrounded by at least one digit.
large = 1_000
verylarge = 5_349_221
 
# fractional
float = +1.0
float_pi = 3.1415
negative_float = -0.01
 
# exponent
flt4 = 5e+22
flt5 = 1e6
flt6 = -2E-2
 
# both
flt7 = 6.626e-34

YAML
integer: 12
octal_number: 014
hexadecimal: 0xC
float: 18.6
exponential: 1.2e+32
infinity: .inf


JSON （Infinity并且NaN在JSON中不受支持）
{
  "integer": 12,
  "octal_number": 12,
  "hexadecimal": 12,
  "float": 18.6,
  "exponential": 1.2e+32
}

杂项 - 日期时间，布尔，空

TOML
bool1 = true
bool2 = false
 
date1 = 1979-05-27T07:32:00Z
date2 = 1979-05-27T00:32:00-07:00
date3 = 1979-05-27T00:32:00.999999-07:00


YAML
bool1: true
bool2: false
 
null1: null
null2: ~
 
date_iso: 2016-12-14T21:59:43.10-05:00 # ISO-8601
date_simple: 2016-12-14


JSON
{
  "bool1": true,
  "bool2": false,
  "null1": null,
  "date_iso": "2016-12-14 21:59:43 -0500",
  "date_simple": "2016-12-14"
}

总结：希望大家能很好地了解这三种数据结构之间的差异，以便使用它们中的任何一种。要简洁同时功能强大，请用yaml， 要在不同语言中交换、共享数据，请用json， 想尝鲜，用toml，还不够的话，请用xml吧。

参考链接：https://blog.csdn.net/paladinzh/article/details/88951763

https://chilaidashi.blog.csdn.net/article/details/120220469?spm=1001.2101.3001.6650.1&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7Edefault-1.no_search_link&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7Edefault-1.no_search_link

笨猪起飞
关注
  • 1
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【TOML配置文件】配置文件我用TOML！人性化，少出错！
IT里的交易员-博客
08-06 7042
配置文件的使用由来已久，从.ini、XML、JSON、YAML再到TOML，语言的表达能力越来越强，同时书写便捷性也在不断提升。接触到TOML是因为前几种都有其不方便的地方，具体就不解释了。要写配置文件，关键就是要简单方便，还要不出错。......
TOML配置文件格式，YAML最有力的竞争者
分享软件测试技术和学习方法
08-02 2465
​​今天我们一起来学习toml这种简洁的配置文件格式吧。TOML是在 2013 年发布的配置文件格式。距今虽然有8年历史了，但是之前一直没有在大项目中见过的。我是前段时间在看python的pep规范，无意中看到了这种配置文件格式，稍微了解了一下，才发现现在有很多新的明星项目都喜欢用它来做配置文件。1、有rust语言的包管理工具cargo；2、类似于docker的容器工具containerd；3、go语言很多项目都喜欢用。比如静态网站生成工具Hugo、数据库InfluxDB、GitLab CI。...
Python笔记 - TOML配置文件
最新发布
Merlin's Engineering Blog
06-15 478
TOML（Tom’s Obvious, Minimal Language）是一种配置文件格式，旨在比JSON、YAML等格式更易读、更人性化。它使用简洁的语法，能清晰地表达复杂的结构，同时保留良好的可读性。本文将介绍TOML的基本语法，提供代码示例，并探讨其在Python项目中的使用场景。
常用配置文件-toml文件
奔跑的豆子的专栏
05-08 6302
toml的目标是成为一种最小的配置文件格式，由于明显的语义，该格式易于阅读。toml旨在明确的映射到哈希表。toml应该易于解析解析为多重语言的数据结构。 .toml文件的基本格式如下： [default] key1 = value1 key2 = value2 ... 从文件语法格式来看，.toml文件格式与.ini文件格式差不多，都是由多个部分组成，每个部分都由一个[section]标题开头，然后由特定的字符串"="分割的键/值条目。 安装 pip3 install toml 写入文件 下面，我们将
Toml配置文件的使用
h___q的博客
07-02 5823
原文链接：https://www.ahaoaha.top/2019/05/29/Toml配置文件的使用/ toml的使用 下载第三方库：go get github.com/BurntSushi/toml toml的配置格式十分灵活，可以是整数（最小尺寸64位）、字符串（必须是utf-8编码）、数组、布尔值简单类型；也可以数组、map等复杂类型。 语法 表格 表格是键值对的集合，使用[]定义，一个表...
记录一次toml库CommonJS规范与项目不兼容的问题
weixin_43405946的博客
07-10 276
项目场景： 我需要解析toml文本为json，然后遍历它得出想要的数据 问题描述： 我的项目支持toml库CommonJS规范 原因分析： 我的项目一直在维护中，项目环境不支持CommonJS规范，而toml库用的是CommonJS规范 最初我使用的toml低版本，可以支持我的项目。但是不能解析最新版本的toml格式。 然后我换成另一个toml库版本，我手动修改源码把CommonJS我项目支持的ES6规范，但是稳定性不好 最后的使用browerify编译我的toml库文件 解决
flatcat:将嵌套文件格式（如JSON，TOML，YAML）展平为单行，并包含所有值的完整路径
03-08
flatcat的主要目的是允许使用标准UNIX文件命令（例如grep ， awk和sed来解析嵌套和分层文件格式（例如JSON，TOML，YAML等）。这些文件已成为事实上的配置标准，但是很少支持处理这些文件。 在这里， flatcat通过将...
重新编组：在CBOR，JSON，MessagePack，TOML和YAML之间转换
01-30
在CBOR，JSON，MessagePack，TOML和YAML之间转换。 安装后，提供命令行命令remarshal以及简短命令{cbor,json,msgpack,toml,yaml}2{cbor,json,msgpack,toml,yaml} 。 这些命令可用于格式转换，重新格式化和错误检测。...
常用的数据格式：.pdf
04-27
TOML的目标是成为最简单的配置文件格式，避免使用括号和复杂的缩进规则，采用链式声明，让配置文件更易读。它的设计简洁明了，但可能不适合处理复杂的嵌套结构。 这些数据格式各有优缺点，选择哪种取决于具体需求...
配置：:memo:进行配置管理（加载，获取，设置）。 支持JSON，YAML，TOML，INI，HCL，ENV和标志。 多文件加载，数据覆盖合并，解析ENV变量。 Go应用配置加载管理，支持多种格式，多文件加载，远程文件加载，支持数据合并，解析环境变量名
02-03
可以为您的特定格式添加自定义驱动程序支持多文件和多数据加载支持从OS ENV加载配置支持从远程URL加载配置数据支持从命令行参数（ flags ）设置配置数据支持数据叠加和合并，在加载多个数据副本时按键自动加载支持...
re-txt:将文本格式从一种转换为另一种，如果要将json文件重新格式化为yaml，toml为yaml，csv为yaml等，这非常有用。
04-14
将文本文件从一个结构重新格式化为另一个结构，即：从json转换为yaml，将toml转换为json，...等等 支持的源格式 json yaml 盐酸 托姆 CSV 支持的目标格式 json yaml 托姆 例子 # json to yaml using flag $ re-...
【go语言】读取toml文件
Candy___i的博客
01-15 693
全称为Tom's Obvious, Minimal Language，是一种易读的配置文件格式，旨在成为一个极简的数据序列化语言。TOML的设计原则之一是保持简洁性，易读性，同时提供足够的灵活性以满足各种应用场景。TOML文件由多个表（table）组成，每个表包含一组键值对。键值对由键名、等号（或冒号），以及对应的值组成。TOML支持嵌套表，可以构建层次结构，使得配置文件更加结构化。
toml
Mar.三月
07-10 1683
toml是一种配置文件格式，常见的配置文件格式有很多种，toml是我最新见到的，常见的有.ini .json .yaml\yml .xml ,但是toml最为简洁、最为语义化！ TOML 是前GitHub CEO， Tom Preston-Werner，于2013年创建的语言，其目标是成为一个小规模的易于使用和阅读的语义化配置文件格式。 TOML的目标是成为一个有明显语义而容易去阅读的...
golang toml解析
迎风的舵手
01-04 1万+
TOML 的全称是 Tom’s Obvious, Minimal Language，因为它的作者是 GitHub 联合创始人 Tom Preston-Werner。 TOML 的目标是成为一个极简的配置文件格式。TOML 被设计成可以无歧义地被映射为哈希表，从而被多种语言解析。 github: https://github.com/BurntSushi/toml 安装:go get gith
golang几种常用配置文件使用方法总结（yaml、toml、json、xml、ini）
热门推荐
TigerwolfC的博客
10-24 4万+
yaml配置文件的使用方法总结 首先介绍使用yaml配置文件，这里使用的是github上第三方开源gopkg.in/yaml.v2 第一步：下载 go get gopkg.in/yaml.v21 第二步：新建一个yaml文件，比如conf.yaml host: localhost:3306 user: root pwd: 123456 dbname: test1234 特别需要强调的是冒号...
YAML书写规范
weixin_38171030的博客
06-26 2254
1. 认识 YAML 　　YAML是一个类似 XML、JSON 的标记性语言。YAML 强调以数据为中心，并不是以标识语言为重点。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。 1.1 YAML 的设计目标： 人类容易阅读 可用于不同程序间的数据交换 适合描述程序所使用的数据结构，特别是脚本语言 丰富的表达能力与可扩展性...
Go实战--也许最快的Go语言Web框架kataras/iris初识二(TOML、Cache、Cookie)
一蓑烟雨任平生 也无风雨也无晴
10-25 1万+
生命不止，继续 go go go!!!昨天介绍了iris框架，介绍了如何使用basic认证、Markdown、YAML、Json等： Go实战–也许最快的Go语言Web框架kataras/iris初识(basic认证、Markdown、YAML、Json)继续跟大家一起学习iris框架.TOML什么是toml? toml也是一种配置文件，关于golang中配置文件的使用之前也有介绍过： Go实
TOML 教程 - 可能是目前最好的配置文件格式
木牛的博客
06-23 2208
配置文件是一种非常基础的文件格式，但远没有数据文件格式（如SQLite）、文档文件格式（如Markdown）、编程语言（如JavaScript）、甚至二进制文件格式（如PNG）需求那么复杂。 　　只要严谨但不严苛、支持必要的数据类型和嵌套，又易于人类手工直接阅读和编辑就可以了。 　　但就是这样一种广泛需要而又简单的应用场景，却反而长期以来一直没有一种足够好的文件格式。 　　INI（.ini）文件是一种非常原始的基础形式，但各家有各家的用法，而且它最多只能解决一层嵌套。只适合非常非常简单的配置文...
nodejs点击修改toml配置文件
06-06
在Node.js中，可以使用toml模块来解析和生成toml格式的配置文件，因此可以通过Node.js来实现点击修改toml格式的配置文件的功能。以下是一般的实现思路： 1. 创建一个API接口，用于接收来自客户端的修改请求，并将修改后的内容写入配置文件。 2. 在客户端使用Ajax或Fetch等技术，向服务器端发送修改请求。请求的参数可以包括要修改的配置项名称和修改后的值。 3. 在服务器端接收到修改请求后，使用toml模块读取配置文件的内容，并将修改后的内容写入到文件中。这里需要注意的是，要保证对文件的写入操作是安全的，需要进行一些权限控制和错误处理。 4. 返回修改结果给客户端，通常会返回一个布尔值或者一些错误信息，以便客户端进行下一步处理。 下面是一个简单的示例代码，用于修改toml格式的配置文件： ``` const fs = require('fs'); const toml = require('toml'); // 定义API接口，用于接收修改请求 app.post('/api/config', (req, res) => { const { key, value } = req.body; // 获取请求参数 // 读取配置文件 const config = toml.parse(fs.readFileSync('config.toml', 'utf8')); // 修改配置项的值 config[key] = value; // 将修改后的内容写入文件 fs.writeFileSync('config.toml', toml.stringify(config)); // 返回修改结果 res.json({ success: true }); }); ``` 需要注意的是，由于涉及到文件操作，需要特别小心防止文件损坏或数据丢失。因此，在实现过程中需要使用一些安全的技术和方法来保证文件的完整性和安全性，例如备份、加锁、权限控制等。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值