nlohmann::json::dump()函数（将JSON对象序列化为字符串）

Posted 2023-03-12 Dontla

文章目录

• • nlohmann::json::dump()函数
  • • 参数解析
    • • indent
      • indent_char
      • ensure_ascii
      • error_handler
      • 函数最后的const

nlohmann::json::dump()函数

当我们需要将JSON数据写入文件或将其发送到网络时，通常需要将JSON对象序列化为字符串格式。nlohmann::json类的dump()函数可以帮助我们将JSON对象序列化为字符串形式，以便于存储和传输。

该函数支持多种重载形式，但通常最常用的是以下两种形式：

std::string dump(int indent = -1, 
				char indent_char = ' ', 
				bool ensure_ascii = false, 
				error_handler_t error_handler = error_handler_t::strict) const;

std::ostream& dump(std::ostream& o, 
					int indent = -1, 
					char indent_char = ' ', 
					bool ensure_ascii = false, 
					error_handler_t error_handler = error_handler_t::strict) const;

其中，第一个函数返回一个表示JSON对象的字符串，而第二个函数则将该字符串写入给定的输出流。

参数解析

这些函数的参数选项如下

indent

用于指定缩进的空格数或制表符数。默认值为-1，表示不使用缩进，即生成压缩的JSON字符串。如果将该参数设置为0或正整数，则输出的JSON字符串将使用该数量的空格或制表符进行缩进。例如，设置indent=4时，JSON字符串将缩进4个空格。

indent_char

用于指定缩进使用的字符，通常为空格或制表符。默认值为' '。

ensure_ascii

用于指定是否将所有非ASCII字符转换为其对应的Unicode转义序列。默认值为false，即不进行转义。
ensure_ascii选项为true，即dump()函数将确保所有非ASCII字符都被转义为类似\\uXXXX的ASCII字符序列，这样可以保证序列化结果可以在ASCII环境下正确解析。
如果将ensure_ascii选项设置为false，则dump()函数将不会将非ASCII字符转义为ASCII字符序列，而是保留原来的字符。这通常用于将JSON文本输出到非ASCII环境，例如使用UTF-8编码的环境。

error_handler

用于指定处理非法JSON数据的方式。默认值为error_handler_t::strict，表示遇到非法数据时抛出异常，可以设置为error_handler_t::ignore，表示忽略非法数据，或error_handler_t::replace，表示用U+FFFD字符替换非法数据。

函数最后的const

在 C++ 中，const 关键字用于表示一个变量或成员函数不可修改。当函数声明为 const 成员函数时，它不会修改任何类的成员变量。在 nlohmann::json 库中，dump() 函数声明为 const 成员函数，因此它不会修改 JSON 对象本身，而是返回一个序列化后的字符串。

具体来说，const 关键字告诉编译器该函数不会修改调用对象的任何成员变量，因此在该函数中不允许使用 this 指针修改任何成员变量。此外，const 成员函数只能调用其他 const 成员函数和常量函数，这是因为它们都不会修改调用对象的状态。

因此，nlohmann::json 库中的 dump() 函数声明为 const 成员函数，表示该函数不会修改 JSON 对象本身，而只是返回一个序列化后的字符串，因此可以在任何时候调用该函数，即使 JSON 对象被声明为 const。