TOML格式简介

TOML(Tom's Obvious, Minimal Language)是一种用于配置文件的轻量级文本格式,旨在易于阅读和编写。它的设计目标是简单明了,同时也能表达复杂的数据结构。TOML文件通常用于配置应用程序、库或项目的设置。

下面是一些TOML的基本概念和语法,以及如何编写TOML文件的示例:

基本语法

TOML文件由键值对(key-value pairs)组成,每个键值对由键、等号(或双冒号),以及值组成。键和值之间需要用等号(=)或双冒号(::)分隔,如下所示:

toml 复制代码
key = "value"

toml 复制代码
key :: "value"

TOML文件也支持行内注释,可以使用井号(#)来注释一行:

toml 复制代码
key = "value"  # 这是一条注释

数据类型

TOML支持多种数据类型,包括字符串、整数、浮点数、布尔值、日期时间和数组。以下是一些示例:

toml 复制代码
string_key = "Hello, TOML!"
integer_key = 42
float_key = 3.14
boolean_key = true
date_key = 2023-09-08T14:30:00Z
array_key = [1, 2, 3]

嵌套表(Nested Tables)

TOML允许创建嵌套的表(tables),用于组织配置数据。嵌套表由表名和一对方括号组成,如下所示:

toml 复制代码
[table_name]
key1 = "value1"
key2 = "value2"

多行字符串

TOML支持多行字符串,可以使用三个双引号(""")或三个单引号(''')来表示,例如:

toml 复制代码
multiline_string = """
This is a
multi-line string.
"""

区分大小写

TOML是区分大小写的,因此键名和表名是大小写敏感的。

示例

下面是一个简单的TOML示例,表示一个应用程序的配置:

toml 复制代码
# Application settings
app_name = "MyApp"
version = "1.0"

# Database settings
[database]
host = "localhost"
port = 5432
username = "myuser"
password = "mypassword"

这只是TOML的基础,它支持更复杂的数据结构和更丰富的功能,可以根据你的需要进行扩展和定制。你可以在项目的配置文件中使用TOML来管理各种设置。

TOML的多级嵌套需要一些规则,包括缩进和键的结构。以下是一些重要的规则:

  1. 缩进: TOML使用缩进来表示多级嵌套。通常情况下,你可以使用空格或制表符作为缩进字符,但是在整个文件中要保持一致。通常,2或4个空格的缩进是常见的选择。缩进用来表示嵌套关系。

  2. 表名: 表名是包含在方括号内的,用来表示表的层次结构。表名可以根据需要进行嵌套,但要确保使用正确的缩进来表示层次关系。

  3. 键名: 键名可以包含字母、数字和下划线。键名不需要缩进,它们是与表名对齐的。键名是区分大小写的。

  4. 键值对: 键值对由键、等号(=)或双冒号(::)和值组成。键值对需要缩进,以表示它们属于哪个表。

所以,你不一定要使用database.connection这种形式,可以根据你的需求自定义键名和表名,只需遵循上述规则即可。例如,你可以这样表示多级嵌套:

toml 复制代码
[server]
hostname = "example.com"
port = 8080

[database]
  [database.connection]
  host = "localhost"
  port = 5432
  username = "myuser"
  password = "mypassword"

[logging]
level = "info"
file = "app.log"

在上述示例中,database.connection 是一个自定义的表名,用于表示数据库连接设置的嵌套。你可以根据你的需求自由定义键名和表名,只要遵循TOML的语法规则即可。