Python中json.dump的使用方法与示例

JSON是一种轻量级的数据交换格式，常用于前后端数据传输。Python中有一个json库可以很方便地处理JSON数据，其中json.dump方法则是将Python对象转化为JSON格式并写入文件的方法。

一、JSON格式的概念与基本语法

JSON是JavaScript对象表示法（JavaScript Object Notation）的缩写，是一种轻量级的数据格式，具有易读、易解析、易生成的特点。JSON与Python中的字典类似，由键值对(key-value)组成，键必须为字符串类型，值可以为字符串、数字、数组、对象等数据类型。下面是一个简单JSON格式的例子：

{
    "name": "Tom",
    "age": 20,
    "interests": ["reading", "music", "sports"],
    "address": {
        "street": "No.1 Road",
        "city": "Beijing"
    }
}

在JSON格式中，以花括号{}表示对象，在对象内部，按照键值对的方式表示数据，键与值之间用冒号:分隔。多个键值对之间用逗号,分隔。键必须为双引号("")包裹的字符串类型，值的类型可以是字符串、数字、数组、对象等。在Python中，可以将一个JSON格式的字符串通过json.loads()方法转化为字典类型，示例如下：

import json

json_str = '{ "name": "Tom", "age": 20, "interests": ["reading", "music", "sports"], "address": {"street": "No.1 Road", "city": "Beijing"} }'

json_dict = json.loads(json_str)

print(json_dict)
# 输出：{'name': 'Tom', 'age': 20, 'interests': ['reading', 'music', 'sports'], 'address': {'street': 'No.1 Road', 'city': 'Beijing'}}

二、json.dump方法的基本使用

json.dump方法是将Python对象转化为JSON格式并写入文件的方法。其中，Python对象可以是列表、元组、字典等数据类型，不支持自定义类对象。示例如下：

import json

data = {
    "name": "Tom",
    "age": 20,
    "interests": ["reading", "music", "sports"],
    "address": {
        "street": "No.1 Road",
        "city": "Beijing"
    }
}

# 将Python对象写入JSON文件
with open('data.json', 'w', encoding='utf-8') as f:
    json.dump(data, f, ensure_ascii=False, indent=4)

# 读取JSON文件内容并转化为Python对象
with open('data.json', 'r', encoding='utf-8') as f:
    json_data = json.load(f)

print(json_data)
# 输出：{'name': 'Tom', 'age': 20, 'interests': ['reading', 'music', 'sports'], 'address': {'street': 'No.1 Road', 'city': 'Beijing'}}

上述代码中，使用json.dump方法将Python对象data转化为JSON格式并写入文件data.json中。其中，ensure_ascii=False表示输出非ASCII字符，indent表示JSON格式的缩进空格数。

三、json.dump方法的高级用法

1. 序列化自定义对象

json.dump方法支持序列化大部分Python内置的数据类型，但不支持诸如set、complex等其中的一些类型。因此，如果要序列化自定义的Python对象，则需要在对象中定义__dict__方法，将对象转化为一个字典。

示例如下：

import json

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def intro(self):
        print('name: %s, age: %d' % (self.name, self.age))

p = Person('Tom', 20)

# 定义__dict__方法，将对象转化为一个字典
def person2dict(p):
    return {'name': p.name, 'age': p.age}

# 将对象转化为字典，并写入JSON文件
with open('data.json', 'w', encoding='utf-8') as f:
    json.dump(p, f, default=person2dict)

# 读取JSON文件内容并转化为Python对象
with open('data.json', 'r', encoding='utf-8') as f:
    json_data = json.load(f)

print(json_data)
# 输出：{'name': 'Tom', 'age': 20}

在上述代码中，定义了一个Person类，其中还定义了一个方法person2dict，用于将对象转化为一个字典。在定义字典时，要注意键必须为字符串类型。在使用json.dump方法将对象序列化为JSON格式时，需要将default参数设置为person2dict函数，将对象转化为字典格式。

2. 序列化datetime等数据类型

datetime、Decimal等部分数据类型，在序列化为JSON格式时会报错。此时，可以通过定义一个自定义的编码器，继承json.JSONEncoder并重写default方法来解决问题。

示例如下：

import json
import datetime

class DateEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, datetime.datetime):
            return obj.strftime('%Y-%m-%d %H:%M:%S')
        else:
            return json.JSONEncoder.default(self, obj)

data = {
    "name": "Tom",
    "age": 20,
    "birth": datetime.datetime(2000, 1, 1, 11, 11, 11)
}

# 定义自定义编码器，并将对象转化为JSON格式
json_str = json.dumps(data, cls=DateEncoder)

# 将JSON格式的字符串写入文件
with open('data.json', 'w', encoding='utf-8') as f:
    f.write(json_str)

# 读取JSON文件内容并转化为Python对象
with open('data.json', 'r', encoding='utf-8') as f:
    json_data = json.load(f)

print(json_data)
# 输出：{'name': 'Tom', 'age': 20, 'birth': '2000-01-01 11:11:11'}

在上述代码中，定义了一个DateEncoder类，继承自json.JSONEncoder并重写了其中的default方法，用于将datetime数据类型转化为字符串格式。在使用json.dump方法时，将cls参数设置为DateEncoder类，即可实现序列化。

3. 格式化Dump输出

在json.dump中，还可以设置其中的一些参数来进行格式化输出等操作。其中一些常用的参数如下：

ensure_ascii：是否将非ASCII字符转化为ASCII码。默认值为True。
indent：用于指定缩进格式。可以为整数，表示空格的个数；也可以为字符串，如'\\t'表示用制表符作为缩进。默认值为None。
separators：用于指定分隔符的格式。默认值为(',', ':')。
sort_keys：是否按键的名称对JSON数据进行排序。默认值为False。

示例如下：

import json

data = {
    "name": "Tom",
    "age": 20,
    "interests": ["reading", "music", "sports"],
    "address": {
        "street": "No.1 Road",
        "city": "Beijing"
    }
}

# 格式化的Dump输出
result = json.dumps(data, ensure_ascii=False, indent=4, sort_keys=True)
print(result)
# 输出：
# {
#     "address": {
#         "city": "Beijing",
#         "street": "No.1 Road"
#     },
#     "age": 20,
#     "interests": [
#         "reading",
#         "music",
#         "sports"
#     ],
#     "name": "Tom"
# }