深入解析yaml-cpp中的YAML数据生成技术-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00164/article/details/148505032

深入解析yaml-cpp中的YAML数据生成技术

yaml-cpp A YAML parser and emitter in C++ 项目地址: https://gitcode.com/gh_mirrors/ya/yaml-cpp

概述

yaml-cpp是一个功能强大的C++ YAML处理库，它不仅能够解析YAML文件，还能够生成YAML格式的数据。本文将详细介绍如何使用yaml-cpp库生成YAML数据，涵盖从基础到高级的各种技巧。

基础数据生成

yaml-cpp采用类似C++标准输出流的方式生成YAML数据，核心类是YAML::Emitter。最基本的用法是直接输出标量值：

YAML::Emitter out;
out << "Hello, World!";
std::cout << out.c_str(); // 输出: Hello, World!

这种方式生成的YAML是最简单的标量形式，适用于基础数据输出。

生成列表和映射

列表生成

YAML中的列表（序列）使用BeginSeq和EndSeq标记生成：

YAML::Emitter out;
out << YAML::BeginSeq;
out << "eggs";
out << "bread";
out << "milk";
out << YAML::EndSeq;

输出结果为：

- eggs
- bread
- milk

映射生成

YAML中的键值对映射使用BeginMap和EndMap标记生成，其中Key和Value分别表示键和值：

YAML::Emitter out;
out << YAML::BeginMap;
out << YAML::Key << "name";
out << YAML::Value << "Ryan Braun";
out << YAML::Key << "position";
out << YAML::Value << "LF";
out << YAML::EndMap;

输出结果为：

name: Ryan Braun
position: LF

嵌套结构

YAML支持复杂的数据嵌套结构：

YAML::Emitter out;
out << YAML::BeginMap;
out << YAML::Key << "name";
out << YAML::Value << "Barack Obama";
out << YAML::Key << "children";
out << YAML::Value << YAML::BeginSeq << "Sasha" << "Malia" << YAML::EndSeq;
out << YAML::EndMap;

输出结果为：

name: Barack Obama
children:
  - Sasha
  - Malia

高级格式化控制

yaml-cpp提供了多种格式化控制选项，可以灵活调整YAML输出格式。

文字块

使用Literal标记可以生成保留换行和缩进的文字块：

YAML::Emitter out;
out << YAML::Literal << "A\n B\n  C";

输出结果为：

|
A
 B
  C

流式风格

使用Flow标记可以生成紧凑的流式风格：

YAML::Emitter out;
out << YAML::Flow;
out << YAML::BeginSeq << 2 << 3 << 5 << 7 << 11 << YAML::EndSeq;

输出结果为：

[2, 3, 5, 7, 11]

注释添加

可以在YAML中添加注释：

YAML::Emitter out;
out << YAML::BeginMap;
out << YAML::Key << "method";
out << YAML::Value << "least squares";
out << YAML::Comment("should we change this method?");
out << YAML::EndMap;

输出结果为：

method: least squares  # should we change this method?

锚点和别名

YAML支持使用锚点和别名实现数据引用：

YAML::Emitter out;
out << YAML::BeginSeq;
out << YAML::Anchor("fred");
out << YAML::BeginMap;
out << YAML::Key << "name" << YAML::Value << "Fred";
out << YAML::Key << "age" << YAML::Value << "42";
out << YAML::EndMap;
out << YAML::Alias("fred");
out << YAML::EndSeq;

输出结果为：

- &fred
  name: Fred
  age: 42
- *fred

处理STL容器

yaml-cpp为常见的STL容器提供了内置支持：

std::vector<int> squares = {1, 4, 9, 16};
std::map<std::string, int> ages = {{"Daniel", 26}, {"Jesse", 24}};

YAML::Emitter out;
out << YAML::BeginSeq;
out << YAML::Flow << squares;
out << ages;
out << YAML::EndSeq;

输出结果为：

- [1, 4, 9, 16]
-
  Daniel: 26
  Jesse: 24

自定义类型支持

可以为自定义类型重载operator<<以实现YAML序列化：

struct Vec3 { int x; int y; int z; };
YAML::Emitter& operator << (YAML::Emitter& out, const Vec3& v) {
    out << YAML::Flow;
    out << YAML::BeginSeq << v.x << v.y << v.z << YAML::EndSeq;
    return out;
}

编码控制

yaml-cpp默认输出UTF-8编码，可以强制输出ASCII编码：

emitter.SetOutputCharset(YAML::EscapeNonAscii);

错误处理

在生成YAML时，如果出现错误（如忘记结束标记），Emitter会停止输出并设置错误标志：

YAML::Emitter out;
assert(out.good());
out << YAML::Key;  // 错误：缺少对应的Value
assert(!out.good());
std::cout << "Emitter error: " << out.GetLastError() << "\n";