如何在 Python 中使用 JSON.dump()：终极指南

本指南介绍了 Python 中的 json.dump() 和 json.dumps 的操作方法--这是一种以 JSON 格式存储结构化数据的重要工具。这种方法广泛应用于处理配置文件、Web 搜索结果、API 响应和其他结构化数据。材料涵盖函数的语法、参数、json.dump 与 json.dumps 的区别、使用示例、支持的数据类型，以及在 Python 中高效可靠地处理 JSON 的最佳实践。

json.dump 有什么作用？

json.dump 是 json 模块中的一个函数，用于将 Python 对象序列化为 JSON 格式并直接保存到文件中。

json.dump() 的语法和参数

json.dump() 函数接受两个主要参数--数据和写入 JSON 输出的文件对象。一般调用结构如下

json.dump(obj, file, **kwargs)

• obj - 需要存储的 Python 对象（如字典或列表）。
• file - 以写入模式打开的文件，输出结果将保存在该文件中。

除了主要参数外，还有几个可选参数：

• indent - 为漂亮打印 JSON 定义缩进。
• sort_keys - 如果设置为 True，则按字母顺序排序字典键。
• ensure_ascii - 设置为 False 时，允许在输出中存储非 ASCII 字符。

当数据的可读性很重要时，以及在准备文件供机器处理时，这些参数尤其有用。

如何以及何时在 Python 中使用 json.dump()

Python json dump 函数用于将数据序列化并立即以 JSON 格式保存到文件中。在需要将网络扫描结果、应用程序配置或收集的数据存储到文件中以便进一步分析或传输时，该函数非常有用。

主要优势包括

• 直接文件输出 - 由于不创建中间字符串，因此减少了内存使用量。
• 灵活的参数--缩进、排序键、ensure_ascii 等选项使输出结果更容易满足特定要求。
• 支持 Unicode - 在处理多语言项目时至关重要。

json 模块是 Python 标准库的一部分，这意味着无需安装第三方软件，只需在脚本开头导入即可。

哪些数据类型可在 Python 中转换为 JSON

json.dump() 函数仅支持以 JSON 格式表示的对象的序列化。这些对象包括列表、字典、字符串、整数、浮点数、布尔值和 None。

示例演示了 json.dump() 保存字典的典型用法：

import json

data = {
    "name": "Helen",
    "age": 28,
    "is_active": True,
    "skills": ["Python", "SQL"]
}

with open("user.json", "w", encoding="utf-8") as f:
    json.dump(data, f, ensure_ascii=False, indent=2)

如果尝试序列化不支持的对象（如类或函数），将引发 TypeError。

json.dump() vs json.dumps()

Python 提供了两个将数据序列化为 JSON 格式的类似函数 - json.dump() 和 json.dumps()。尽管它们的名字相似，但用途却不同：

• json.dump() 将序列化数据直接写入文件。它接受两个主要参数：对象和打开的文件描述符。
• json.dumps() 返回 JSON 格式的字符串，然后可以对其进行进一步处理或手动写入文件。json.dumps()中的任何可用参数（如缩进、ensure_ascii 或 sort_keys）都可用于定制结果。

下面的示例说明了 json.dump() 与将 json.dumps() 的输出写入文件之间的区别：

import json

data = {"key": "value"}

# 使用 json.dump()
with open("output.json", "w", encoding="utf-8") as f:
    json.dump(data, f)

# 使用 json.dumps()
json_string = json.dumps(data)
print(json_string)  # {"key": "value"}

两者的关键区别在于任务：

• 如果目标是将数据直接保存到文件中，则应使用 json.dump()；
• 如果需要字符串表示以便进一步处理--json.dumps() 更合适。

如何在 Python 中使用 JSON 将数据保存到文件中

将数据保存到 JSON 文件是 Python 中最常见的应用场景之一。要做到这一点，只需创建一个 Python 对象（例如字典），以写入模式打开文件，然后将该对象传递给 json.dump() 函数。

用 Python 将 JSON 写入文件：

import json

# 1.要存储的数据
user_data = {
    "username": "admin",
    "active": True,
    "roles": ["editor", "moderator"]
}

# 2.以写入模式打开文件
with open("data.json", "w", encoding="utf-8") as f:
    # 3.写入文件
    json.dump(user_data, f, ensure_ascii=False, indent=4)

在这个例子中

• ensure_ascii=False 允许不使用转义序列存储西里尔字符。
• indent=4 增加了缩进，以提高可读性。
• 创建（或覆盖）文件 data.json，并以格式化的 JSON 表示形式写入结构。

掌握 Python 中的 JSON：最佳实践

在 Python 中处理 JSON 时，最好遵循一系列简化数据处理和提高代码可靠性的实践：

• 使用 json.dumps 缩进参数：它会为 JSON 文件添加间距，使结构更易于人类阅读和调试。
• 序列化前验证数据：JSON 默认不支持某些对象类型（例如类、函数或日期时间等对象），因此需要手动转换。
• 正确处理编码：如果要存储带有西里尔字母或其他非 ASCII 字符的数据，请使用 ensure_ascii=False，并使用 UTF-8 编码打开文件。
• 避免将整个大文件加载到内存中：与其一次性存储整个结构，不如分部分写入数据或使用流式方法。

遵循这些原则有助于防止错误并提高可扩展性，尤其是在与收集和处理大量结构化信息相关的任务中。

结论

json.dump() 是将结构化数据保存为 JSON 格式的可靠而高效的工具，它能将 Python 对象直接写入文件，同时支持格式化、键排序和正确处理多语言文本。json.dumps() 函数提供了基于字符串的序列化，从而对其进行了灵活的处理。这些函数涵盖了从存储配置文件到管理网络搜刮结果和 API 响应等广泛的用例。

在使用 Python 处理 JSON 时，遵循最佳实践可确保可读性、正确性和稳定性，从而使这些工具成为现代开发工作流程中不可或缺的一部分。