Python中json.dumps使用教程

发布时间：2023-05-10

JSON序列化：使用Python的json.dumps()函数

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式。在Python中，可以使用json.dumps()函数将Python对象转化为JSON格式的数据。

一、json.dumps()函数的语法和参数

json.dumps()函数的语法如下：

json.dumps(obj, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

其中，参数obj必须是一个Python对象，支持的数据类型包括dict、list、tuple、str、int、float、bool和None。其他参数的含义如下：

  • skipkeys：表示是否跳过dict中的非字符串类型的key，默认为False。
  • ensure_ascii：表示是否将非ASCII字符转义，默认为True。
  • check_circular：表示是否检查循环引用，默认为True。
  • allow_nan：表示是否允许NaN、Infinity、-Infinity等特殊值，默认为True。
  • cls：表示自定义的JSONEncoder，用于将Python对象序列化为JSON格式。
  • indent：表示缩进字符数，用于美化输出。
  • separators：表示分隔符，默认为(',', ':')。
  • default：用于处理非序列化类型的数据，如datetime类型。
  • sort_keys：表示是否按照key的字典序排序，默认为False。
  • kw：表示其他需要传递给JSONEncoder的关键字参数。

二、使用json.dumps()函数将Python对象序列化为JSON格式

1、将Python字典序列化为JSON格式：

import json
dict_obj = {'Name': 'Alice', 'Age': 18, 'Sex': 'Female'}
json_str = json.dumps(dict_obj, indent=4, sort_keys=True, ensure_ascii=False)
print(json_str)

输出结果如下：

{
    "Age": 18,
    "Name": "Alice",
    "Sex": "Female"
}

2、将Python列表序列化为JSON格式：

import json
list_obj = ['Alice', 18, 'Female']
json_str = json.dumps(list_obj, indent=4, ensure_ascii=False)
print(json_str)

输出结果如下：

[
    "Alice",
    18,
    "Female"
]

3、将Python元组序列化为JSON格式：

import json
tuple_obj = ('Alice', 18, 'Female')
json_str = json.dumps(tuple_obj, indent=4, ensure_ascii=False)
print(json_str)

输出结果如下：

[
    "Alice",
    18,
    "Female"
]

4、将Python字符串序列化为JSON格式：

import json
str_obj = 'Hello, world!'
json_str = json.dumps(str_obj, indent=4, ensure_ascii=False)
print(json_str)

输出结果如下：

"Hello, world!"

5、将Python数字序列化为JSON格式：

import json
num_obj = 123
json_str = json.dumps(num_obj, indent=4)
print(json_str)

输出结果如下：

123

6、将Python布尔值序列化为JSON格式：

import json
bool_obj = True
json_str = json.dumps(bool_obj, indent=4)
print(json_str)

输出结果如下：

true

7、将Python空值序列化为JSON格式：

import json
none_obj = None
json_str = json.dumps(none_obj, indent=4)
print(json_str)

输出结果如下：

null

三、json.dumps()函数的常用技巧

1、使用default参数序列化自定义对象

有时候，需要将自定义对象（如datetime、Decimal等）序列化为JSON格式。可以通过自定义JSONEncoder来实现，也可以使用default参数来处理。

import json
import datetime
class CustomEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, datetime.datetime):
            return obj.strftime('%Y-%m-%d %H:%M:%S')
        elif isinstance(obj, datetime.date):
            return obj.strftime('%Y-%m-%d')
        else:
            return super().default(obj)
dt_obj = datetime.datetime.now()
json_str = json.dumps(dt_obj, indent=4, cls=CustomEncoder)
print(json_str)

输出结果如下：

"2022-06-21 09:53:22"

2、使用ensure_ascii参数序列化中文字符

当Python对象中包含了中文字符时，使用json.dumps()函数默认会将中文字符转义成Unicode编码。可以通过设置ensure_ascii参数为False来输出原始的中文字符。

import json
dict_obj = {'姓名': '小明', '年龄': 18, '性别': '男'}
json_str = json.dumps(dict_obj, indent=4, ensure_ascii=False)
print(json_str)

输出结果如下：

{
    "姓名": "小明",
    "年龄": 18,
    "性别": "男"
}

3、使用indent参数美化输出的JSON格式

为了提高JSON格式的可读性，在输出时可以通过设置indent参数来实现缩进。

import json
dict_obj = {'Name': 'Alice', 'Age': 18, 'Sex': 'Female'}
json_str = json.dumps(dict_obj, indent=4)
print(json_str)

输出结果如下：

{
    "Name": "Alice",
    "Age": 18,
    "Sex": "Female"
}

总结

本文介绍了json.dumps()函数的用法和常用技巧。通过学习本文，读者可以掌握如何使用Python中的json模块将Python对象序列化为JSON格式的数据，以及如何应对常见的序列化问题。

推荐文章