如何将 Python 类对象序列化为 JSON

Python 2月前 75

在 Python 程序中，我们常常需要将对象转化为 JSON 格式，以便于传输和存储。JSON 是一种轻量级的数据交换格式，它的优点在于易于阅读和编写，同时也易于解析和生成。在 Python 中，我们可以使用 json 模块来进行 JSON 编码和解码操作。本文将介绍如何将 Python 类对象序列化为 JSON，并且会附带注意事项和示例代码。

JSON 序列化

JSON 序列化是将 Python 对象转化为 JSON 字符串的过程。Python 对象可以是字典、列表、元组、数字、字符串、布尔值和 None 等基本类型。但是，当我们需要将自定义的类对象序列化为 JSON 字符串时，需要进行一些特殊的处理。下面是一个简单的类定义：

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

我们可以创建一个 Person 对象，并将其序列化为 JSON 字符串：

import json

person = Person("Tom", 20)
json_str = json.dumps(person.__dict__)
print(json_str)

输出结果为：

{"name": "Tom", "age": 20}

上述代码使用了 json.dumps() 方法将 person 对象的 dict 属性转化为 JSON 字符串。dict 属性是一个字典，它包含了类的所有属性和值。因此，我们可以通过将 dict 转化为 JSON 字符串来序列化类对象。

序列化自定义类对象

如果我们需要序列化一个自定义的类对象，需要先将其转化为一个 Python 字典，然后再将字典序列化为 JSON 字符串。下面是一个更复杂的类定义：

class Student:
    def __init__(self, name, age, grades):
        self.name = name
        self.age = age
        self.grades = grades
    
    def get_average_grade(self):
        total = sum(self.grades)
        return total / len(self.grades)

我们可以创建一个 Student 对象，并将其序列化为 JSON 字符串：

import json

student = Student("Alice", 18, [80, 90, 85])
student_dict = {
    "name": student.name,
    "age": student.age,
    "grades": student.grades,
    "average_grade": student.get_average_grade()
}
json_str = json.dumps(student_dict)
print(json_str)

输出结果为：

{"name": "Alice", "age": 18, "grades": [80, 90, 85], "average_grade": 85.0}

上述代码将 Student 对象转化为了一个字典 student_dict，并在字典中添加了一个平均成绩的属性 average_grade。然后，我们将字典序列化为 JSON 字符串。

注意事项

在序列化类对象时，需要注意以下几点：

类的属性必须是基本类型或可序列化的对象。如果属性是一个函数或其他不可序列化的对象，需要在序列化之前进行处理。
序列化的结果可能无法还原为原来的对象。因此，在反序列化时需要进行特殊的处理，例如使用自定义的解码器。
序列化的结果可能包含敏感信息，因此需要进行加密或其他安全措施。

示例代码

下面是一个完整的示例代码，包括了一个自定义的解码器：

import json

class Student:
    def __init__(self, name, age, grades):
        self.name = name
        self.age = age
        self.grades = grades
    
    def get_average_grade(self):
        total = sum(self.grades)
        return total / len(self.grades)

class StudentDecoder(json.JSONDecoder):
    def decode(self, s, **kwargs):
        obj = super().decode(s, **kwargs)
        return Student(obj["name"], obj["age"], obj["grades"])

student = Student("Alice", 18, [80, 90, 85])
student_dict = {
    "name": student.name,
    "age": student.age,
    "grades": student.grades,
    "average_grade": student.get_average_grade()
}
json_str = json.dumps(student_dict)
print(json_str)

decoded_student = json.loads(json_str, cls=StudentDecoder)
print(decoded_student.name)
print(decoded_student.age)
print(decoded_student.grades)
print(decoded_student.get_average_grade())

输出结果为：

{"name": "Alice", "age": 18, "grades": [80, 90, 85], "average_grade": 85.0}
Alice
18
[80, 90, 85]
85.0

上述代码使用了一个自定义的解码器 StudentDecoder，它继承了 json.JSONDecoder 类，并重写了 decode() 方法。decode() 方法在解码 JSON 字符串时会调用，它将 JSON 字符串转化为 Student 对象。在上述代码中，我们先将 Student 对象转化为字典，然后将字典序列化为 JSON 字符串。接着，我们使用 json.loads() 方法将 JSON 字符串解码为字典，然后使用 StudentDecoder 将字典转化为 Student 对象。