django之BaseSerializer

BaseSerializer 是 Django REST framework (DRF) 中的一个核心类，用于将复杂的数据范例（如查询集和模型实例）转换为 Python 数据范例，以便于渲染成 JSON、XML 或其他内容范例。BaseSerializer 是所有序列化器的基类，提供了一些常用的方法和属性。以下是一些常用的方法和属性的先容：
常用方法

• to_representation(instance)
  
  
  
  • 描述: 将模型实例或查询集转换为原生 Python 数据范例。
    
  • 用途: 用于序列化数据，即将复杂数据范例转换为简单的、可序列化的数据范例。
    
  • 示例:
    1. def to_representation(self, instance):
    2.     return {
    3.         'id': instance.id,
    4.         'name': instance.name,
    5.         'email': instance.email,
    6.     }

    复制代码
  
  
• to_internal_value(data)
  
  
  
  • 描述: 将原生数据（通常是字典）转换为验证后的数据。
    
  • 用途: 用于反序列化数据，即将简单的、可序列化的数据范例转换为复杂的数据范例。
    
  • 示例:
    1. def to_internal_value(self, data):
    2.     return {
    3.         'id': data.get('id'),
    4.         'name': data.get('name'),
    5.         'email': data.get('email'),
    6.     }

    复制代码
  
  
• validate(attrs)
  
  
  
  • 描述: 对输入数据举行验证。
    
  • 用途: 用于自定义验证逻辑。
    
  • 示例:
    1. def validate(self, attrs):
    2.     if 'email' in attrs and not attrs['email'].endswith('@example.com'):
    3.         raise serializers.ValidationError("Email must be from the domain 'example.com'.")
    4.     return attrs

    复制代码
  
  
• create(validated_data)
  
  
  
  • 描述: 利用验证后的数据创建并返回一个新实例。
    
  • 用途: 用于处理惩罚创建操作。
    
  • 示例:
    1. def create(self, validated_data):
    2.     return MyModel.objects.create(**validated_data)

    复制代码
  
  
• update(instance, validated_data)
  
  
  
  • 描述: 利用验证后的数据更新并返回一个现有实例。
    
  • 用途: 用于处理惩罚更新操作。
    
  • 示例:
    1. def update(self, instance, validated_data):
    2.     instance.name = validated_data.get('name', instance.name)
    3.     instance.email = validated_data.get('email', instance.email)
    4.     instance.save()
    5.     return instance

    复制代码
  
  

常用属性

• data
  
  
  
  • 描述: 返回序列化后的数据。
    
  • 用途: 用于获取序列化后的数据。
    
  • 示例:
    1. serializer = MySerializer(instance)
    2. serialized_data = serializer.data

    复制代码
  
  
• errors
  
  
  
  • 描述: 返回验证错误信息。
    
  • 用途: 用于获取验证错误信息。
    
  • 示例:
    1. serializer = MySerializer(data=request.data)
    2. if not serializer.is_valid():
    3.     errors = serializer.errors

    复制代码
  
  
• is_valid(raise_exception=False)
  
  
  
  • 描述: 检查数据是否有效。
    
  • 用途: 用于验证数据。
    
  • 示例:
    1. serializer = MySerializer(data=request.data)
    2. if serializer.is_valid():
    3.     # Data is valid
    4. else:
    5.     # Data is not valid

    复制代码
  
  
• validated_data
  
  
  
  • 描述: 返回验证后的数据。
    
  • 用途: 用于获取验证后的数据。
    
  • 示例:
    1. serializer = MySerializer(data=request.data)
    2. if serializer.is_valid():
    3.     validated_data = serializer.validated_data

    复制代码
  
  
• initial_data
  
  
  
  • 描述: 返回初始化时传入的原始数据。
    
  • 用途: 用于获取初始化时传入的原始数据。
    
  • 示例:
    1. serializer = MySerializer(data=request.data)
    2. initial_data = serializer.initial_data

    复制代码
  
  

下面通过一个详细的示例来展示如安在实际应用中利用 BaseSerializer 中的常用方法。假设有一个简单的 Django 模型 Book，我们将创建一个序列化器 BookSerializer 来演示这些方法的实际用法。
模型定义

首先定义一个简单的 Book 模型：

1. from django.db import models
3. class Book(models.Model):
4.     title = models.CharField(max_length=100)
5.     author = models.CharField(max_length=100)
6.     published_date = models.DateField()
7.     isbn = models.CharField(max_length=13, unique=True)

复制代码

序列化器定义

接下来定义一个 BookSerializer，并在其中利用 BaseSerializer 的常用方法：

1. from rest_framework import serializers
2. from .models import Book
4. class BookSerializer(serializers.Serializer):
5.     title = serializers.CharField(max_length=100)
6.     author = serializers.CharField(max_length=100)
7.     published_date = serializers.DateField()
8.     isbn = serializers.CharField(max_length=13)
10.     def to_representation(self, instance):
11.         """将模型实例转换为原生 Python 数据类型"""
12.         return {
13.             'title': instance.title,
14.             'author': instance.author,
15.             'published_date': instance.published_date,
16.             'isbn': instance.isbn,
17.         }
19.     def to_internal_value(self, data):
20.         """将原生数据转换为验证后的数据"""
21.         return {
22.             'title': data.get('title'),
23.             'author': data.get('author'),
24.             'published_date': data.get('published_date'),
25.             'isbn': data.get('isbn'),
26.         }
28.     def validate(self, attrs):
29.         """对输入数据进行验证"""
30.         if len(attrs['isbn']) != 13:
31.             raise serializers.ValidationError("ISBN must be 13 characters long.")
32.         return attrs
34.     def create(self, validated_data):
35.         """使用验证后的数据创建并返回一个新实例"""
36.         return Book.objects.create(**validated_data)
38.     def update(self, instance, validated_data):
39.         """使用验证后的数据更新并返回一个现有实例"""
40.         instance.title = validated_data.get('title', instance.title)
41.         instance.author = validated_data.get('author', instance.author)
42.         instance.published_date = validated_data.get('published_date', instance.published_date)
43.         instance.isbn = validated_data.get('isbn', instance.isbn)
44.         instance.save()
45.         return instance

复制代码

例子1

序列化数据

将 Book 模型实例序列化为 JSON 格式：

1. from .models import Book
2. from .serializers import BookSerializer
4. # 假设我们有一个 Book 实例
5. book_instance = Book.objects.get(id=1)
7. # 序列化
8. serializer = BookSerializer(book_instance)
9. serialized_data = serializer.data
10. print(serialized_data)

复制代码

反序列化数据

将 JSON 数据反序列化为 Book 模型实例：

1. from .serializers import BookSerializer
3. # 假设我们有一些 JSON 数据
4. json_data = {
5.     'title': 'New Book',
6.     'author': 'John Doe',
7.     'published_date': '2023-10-01',
8.     'isbn': '1234567890123'
9. }
11. # 反序列化
12. serializer = BookSerializer(data=json_data)
13. if serializer.is_valid():
14.     book_instance = serializer.save()
15.     print(book_instance)
16. else:
17.     print(serializer.errors)

复制代码

更新实例

利用验证后的数据更新现有的 Book 实例：

1. from .models import Book
2. from .serializers import BookSerializer
4. # 假设我们有一个 Book 实例
5. book_instance = Book.objects.get(id=1)
7. # 新的数据
8. update_data = {
9.     'title': 'Updated Book',
10.     'author': 'Jane Doe',
11.     'published_date': '2023-10-02',
12.     'isbn': '1234567890123'
13. }
15. # 更新
16. serializer = BookSerializer(book_instance, data=update_data)
17. if serializer.is_valid():
18.     updated_instance = serializer.save()
19.     print(updated_instance)
20. else:
21.     print(serializer.errors)

复制代码

验证数据

验证输入数据：

1. from .serializers import BookSerializer
3. # 一些无效的 JSON 数据
4. invalid_data = {
5.     'title': 'Invalid Book',
6.     'author': 'John Doe',
7.     'published_date': '2023-10-01',
8.     'isbn': '1234567890'  # ISBN 长度不正确
9. }
11. # 验证
12. serializer = BookSerializer(data=invalid_data)
13. if not serializer.is_valid():
14.     print(serializer.errors)  # 输出验证错误信息

复制代码

例子2

好的，下面我将完善这个例子，假设有一个名为 StatPlatProjectData 的模型，并且我们盼望在序列化时删除某些字段（如 created_at、updated_at 和 executor），将利用 BasicSerializer 作为基类，并在 to_representation 方法中自定义序列化逻辑。
模型定义

首先定义 StatPlatProjectData 模型：

1. from django.db import models
3. class StatPlatProjectData(models.Model):
4.     name = models.CharField(max_length=100)
5.     description = models.TextField()
6.     executor = models.CharField(max_length=100)
7.     created_at = models.DateTimeField(auto_now_add=True)
8.     updated_at = models.DateTimeField(auto_now=True)

复制代码

序列化器定义

接下来定义 StatPlatProjectDataSerializer，并在其中利用 BasicSerializer 的常用方法：

1. from rest_framework import serializers
2. from .models import StatPlatProjectData
4. class BasicSerializer(serializers.ModelSerializer):
5.     pass
7. class StatPlatProjectDataSerializer(BasicSerializer):
8.     created_at = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', read_only=True)
9.     updated_at = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', read_only=True)
11.     class Meta:
12.         model = StatPlatProjectData
13.         fields = '__all__'
15.     def to_representation(self, instance):
16.         data = super().to_representation(instance)
17.         del_keys = ['created_at', 'updated_at', 'executor']
18.         for key in del_keys:
19.             data.pop(key, None)
20.         return data

复制代码

序列化数据

将 StatPlatProjectData 模型实例序列化为 JSON 格式，并删除指定的字段：

1. from .models import StatPlatProjectData
2. from .serializers import StatPlatProjectDataSerializer
4. # 假设有一个 StatPlatProjectData 实例
5. project_data_instance = StatPlatProjectData.objects.get(id=1)
7. # 序列化
8. serializer = StatPlatProjectDataSerializer(project_data_instance)
9. serialized_data = serializer.data
10. print(serialized_data)

复制代码

在这个例子中，serialized_data 将包含所有字段，除了 created_at、updated_at 和 executor。
反序列化数据

将 JSON 数据反序列化为 StatPlatProjectData 模型实例：

1. from .serializers import StatPlatProjectDataSerializer
3. # 假设有一些 JSON 数据
4. json_data = {
5.     'name': 'New Project',
6.     'description': 'This is a new project.',
7.     'executor': 'John Doe'
8. }
10. # 反序列化
11. serializer = StatPlatProjectDataSerializer(data=json_data)
12. if serializer.is_valid():
13.     project_data_instance = serializer.save()
14.     print(project_data_instance)
15. else:
16.     print(serializer.errors)

复制代码

更新实例

利用验证后的数据更新现有的 StatPlatProjectData 实例：

1. from .models import StatPlatProjectData
2. from .serializers import StatPlatProjectDataSerializer
4. # 假设有一个 StatPlatProjectData 实例
5. project_data_instance = StatPlatProjectData.objects.get(id=1)
7. # 新的数据
8. update_data = {
9.     'name': 'Updated Project',
10.     'description': 'This is an updated project.',
11.     'executor': 'Jane Doe'
12. }
14. # 更新
15. serializer = StatPlatProjectDataSerializer(project_data_instance, data=update_data)
16. if serializer.is_valid():
17.     updated_instance = serializer.save()
18.     print(updated_instance)
19. else:
20.     print(serializer.errors)

复制代码

验证数据

验证输入数据：

1. from .serializers import StatPlatProjectDataSerializer
3. # 一些无效的 JSON 数据
4. invalid_data = {
5.     'name': 'Invalid Project',
6.     'description': 'This is an invalid project.',
7.     'executor': ''  # executor 不能为空
8. }
10. # 验证
11. serializer = StatPlatProjectDataSerializer(data=invalid_data)
12. if not serializer.is_valid():
13.     print(serializer.errors)  # 输出验证错误信息

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。