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格式的數據，以及如何應對常見的序列化問題。