C++教程（三）：c++常用的配置文件类型

目录

1. INI 文件

2. JSON 文件

3. YAML 文件

4. XML 文件

5. TOML 文件

6. 二进制配置文件（Protocol Buffers, MessagePack, Avro 等）

总结

---

在 C++ 项目中，常用的配置文件类型有多种选择，具体选择取决于项目的复杂性、可读性要求、解析器的可用性以及跨平台的需求。常见的配置文件类型包括 INI、JSON、YAML、XML 、TOML、 Protocol Buffers（protobuf）、MessagePack和Avro  等。以下是这些配置文件类型的介绍、特点以及如何在 C++ 中使用它们。

1. INI 文件

1.1 概述
INI 文件是一种非常简单的配置文件格式，常用于存储应用程序的配置信息。它的结构由键值对和可选的节（section）组成，便于阅读和编写。

1.2 INI 文件示例

[General]
app_name = MyApp
version = 1.0[Database]
host = localhost
port = 5432
username = user
password = pass

1.3 在 C++ 中解析 INI 文件
C++ 中可以使用 inih 库来解析 INI 文件。

安装 inih：git clone https://github.com/benhoyt/inih

使用 inih 解析 INI 文件的示例代码：

#include "INIReader.h"
#include <iostream>int main() {INIReader reader("config.ini");if (reader.ParseError() < 0) {std::cout << "Can't load 'config.ini'\n";return 1;}std::string appName = reader.Get("General", "app_name", "UNKNOWN");std::string dbHost = reader.Get("Database", "host", "UNKNOWN");std::cout << "App Name: " << appName << std::endl;std::cout << "Database Host: " << dbHost << std::endl;return 0;
}

1.4 优点
简单易用：易于阅读和编写。
解析效率高：结构简单，解析速度快。
1.5 缺点
功能有限：不支持复杂的数据结构，如嵌套、数组等。

2. JSON 文件

2.1 概述
JSON（JavaScript Object Notation） 是一种轻量级的数据交换格式，广泛用于配置文件和数据传输。它支持嵌套的对象、数组和基本数据类型。

2.2 JSON 文件示例

{"app_name": "MyApp","version": "1.0","database": {"host": "localhost","port": 5432,"username": "user","password": "pass"}
}

2.3 在 C++ 中解析 JSON 文件
C++ 中常用的 JSON 库包括 nlohmann/json 和 RapidJSON。

安装 nlohmann/json：sudo apt install nlohmann-json-dev

使用 nlohmann/json 解析 JSON 文件的示例代码：

#include <nlohmann/json.hpp>
#include <fstream>
#include <iostream>int main() {std::ifstream file("config.json");nlohmann::json config;file >> config;std::string appName = config["app_name"];std::string dbHost = config["database"]["host"];std::cout << "App Name: " << appName << std::endl;std::cout << "Database Host: " << dbHost << std::endl;return 0;
}

2.4 优点
支持复杂数据结构：如嵌套对象、数组等。
广泛使用：很多系统和语言都支持 JSON。
2.5 缺点
格式较冗长：相比 INI 文件，JSON 更加冗长，不如 INI 简单。

3. YAML 文件

3.1 概述
YAML（YAML Ain't Markup Language） 是一种人类可读的配置文件格式，支持多种数据类型，包括列表、字典、嵌套对象等。它比 JSON 更加简洁易读，特别适用于配置文件。

3.2 YAML 文件示例

app_name: MyApp
version: 1.0
database:host: localhostport: 5432username: userpassword: pass

3.3 在 C++ 中解析 YAML 文件
C++ 中常用的 YAML 解析库是 yaml-cpp。

安装 yaml-cpp：sudo apt install libyaml-cpp-dev

使用 yaml-cpp 解析 YAML 文件的示例代码：

#include <yaml-cpp/yaml.h>
#include <iostream>int main() {YAML::Node config = YAML::LoadFile("config.yaml");std::string appName = config["app_name"].as<std::string>();std::string dbHost = config["database"]["host"].as<std::string>();std::cout << "App Name: " << appName << std::endl;std::cout << "Database Host: " << dbHost << std::endl;return 0;
}

3.4 优点
简洁：比 JSON 更加简洁，易于书写。
支持复杂数据结构：和 JSON 一样，支持字典、列表和嵌套对象。
3.5 缺点
格式敏感：YAML 对缩进非常敏感，容易出错。

4. XML 文件

4.1 概述
XML（Extensible Markup Language） 是一种标记语言，常用于结构化数据的表示，尤其适合配置文件和文档数据。XML 具有很好的扩展性，支持复杂的数据结构，但较为冗长。

4.2 XML 文件示例

<config><app_name>MyApp</app_name><version>1.0</version><database><host>localhost</host><port>5432</port><username>user</username><password>pass</password></database>
</config>

4.3 在 C++ 中解析 XML 文件
C++ 中常用的 XML 解析库有 TinyXML2 和 libxml2。

安装 TinyXML2：sudo apt install libtinyxml2-dev

使用 TinyXML2 解析 XML 文件的示例代码：

#include <tinyxml2.h>
#include <iostream>int main() {tinyxml2::XMLDocument doc;doc.LoadFile("config.xml");tinyxml2::XMLElement* root = doc.FirstChildElement("config");const char* appName = root->FirstChildElement("app_name")->GetText();const char* dbHost = root->FirstChildElement("database")->FirstChildElement("host")->GetText();std::cout << "App Name: " << appName << std::endl;std::cout << "Database Host: " << dbHost << std::endl;return 0;
}

4.4 优点
自描述性强：适合数据交换和存储，支持丰富的标签和属性。
标准化：支持复杂的模式验证和结构化数据。
4.5 缺点
冗长：比 JSON 和 YAML 更加冗长，占用空间大。
解析速度较慢：相比于其他格式，解析效率较低。

5. TOML 文件

5.1 概述
TOML（Tom's Obvious, Minimal Language） 是一种简单易读的配置文件格式，设计目标是让配置文件既能轻松编辑，又能被解析为结构化数据。它的结构类似于 INI 文件，但支持更复杂的数据类型和嵌套结构。

5.2 TOML 文件示例

app_name = "MyApp"
version = "1.0"[database]
host = "localhost"
port = 5432
username = "user"
password = "pass"

5.3 在 C++ 中解析 TOML 文件
C++ 中常用的 TOML 解析库是 toml++。

安装 toml++：git clone https://github.com/marzer/tomlplusplus

使用 toml++ 解析 TOML 文件的示例代码：

#include <toml++/toml.h>
#include <iostream>int main() {auto config = toml::parse_file("config.toml");std::string appName = config["app_name"].value_or("Unknown");std::string dbHost = config["database"]["host"].value_or("Unknown");std::cout << "App Name: " << appName << std::endl;std::cout << "Database Host: " << dbHost << std::endl;return 0;
}

5.4 优点
简洁：比 JSON 更加简洁，语法更人性化。
支持复杂数据结构：像 YAML 和 JSON 一样，支持嵌套、列表等复杂结构。
5.5 缺点
较少使用：TOML 仍然相对较新，支持的工具和库不如 JSON、YAML 广泛。

6. 二进制配置文件（Protocol Buffers, MessagePack, Avro 等）

6.1 概述
对于需要高效传输和存储的场景，可以使用二进制格式来配置和序列化数据。常用的二进制配置格式包括 Protocol Buffers（protobuf）、MessagePack、Avro 等。这些格式更适合高性能、数据密集型应用，特别是在分布式系统或嵌入式系统中使用。下面以使用较多的protobuf文件举例说明。

6.2 protobuf文件示例

syntax = "proto3";message Person {int32 id = 1;string name = 2;string email = 3;
}

6.3 在 C++ 中解析Protocol Buffers 文件

安装 Protocol Buffers 

sudo apt install protobuf-compiler
sudo apt install libprotobuf-dev

编译 .proto 文件生成 C++ 代码：protoc --cpp_out=. person.proto
 

#include "person.pb.h"
#include <fstream>
#include <iostream>int main() {Person person;person.set_id(123);person.set_name("Alice");person.set_email("[e-mail]");// 序列化到文件std::ofstream output("person.data", std::ios::binary);person.SerializeToOstream(&output);output.close();// 反序列化Person new_person;std::ifstream input("person.data", std::ios::binary);new_person.ParseFromIstream(&input);input.close();std::cout << "ID: " << new_person.id() << "\n"<< "Name: " << new_person.name() << "\n"<< "Email: " << new_person.email() << std::endl;
}

6.4 优点
高效：二进制格式比文本格式更加紧凑，传输效率高。
跨平台支持：这些格式有很好的多语言支持，适合跨平台、跨语言项目。
6.5 缺点
不可读：二进制格式不便于人类直接编辑和阅读，通常需要专门的工具或界面来修改。

总结

不同的配置文件格式在 C++ 项目中的应用各有优缺点，选择时应考虑以下因素：

INI 文件：简单，适用于小型项目和配置需求较少的应用。
JSON 文件：灵活，适用于需要复杂数据结构的项目。
YAML 文件：简洁易读，适用于配置文件较多、易读性要求高的项目。
XML 文件：功能强大，适用于需要复杂描述和自描述性的场景。
TOML 文件：简洁且支持复杂数据，适合需要人类友好且功能强大的配置场景。
二进制配置文件：适合高效、紧凑存储和传输需求的场景。