Django 的序列化器(Serializers)是 Django REST framework(DRF)中的一个核心组件,用于将复杂的数据范例(如 Django 模型实例)转换为 JSON、XML 或其他内容范例,反之亦然。序列化器不仅可以序列化和反序列化数据,还可以举行数据验证和处理。
根本用法
1. 定义模型
定义一些 Django 模型:
- # models.py
- from django.db import models
- class Author(models.Model):
- name = models.CharField(max_length=100)
- class Book(models.Model):
- title = models.CharField(max_length=100)
- author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE)
复制代码 2. 定义序列化器
定义序列化器:
- # serializers.py
- from rest_framework import serializers
- from .models import Author, Book
- class AuthorSerializer(serializers.ModelSerializer):
- class Meta:
- model = Author
- fields = ['id', 'name']
- class BookSerializer(serializers.ModelSerializer):
- author = AuthorSerializer() # 嵌套序列化器
- class Meta:
- model = Book
- fields = ['id', 'title', 'author']
复制代码 model 和 fields 的用法
model 属性指定了这个序列化器对应的 Django 模型。DRF 会根据这个模型主动天生相应的序列化器字段。
fields 属性指定了你盼望在序列化器中包罗的模型字段。可以选择模型中的全部字段,也可以只选择特定的字段。
fields 的其他用法
包罗全部字段
如果你盼望序列化器包罗模型的全部字段,可以利用特别的字符串 '__all__':
- class AuthorSerializer(serializers.ModelSerializer):
- class Meta:
- model = Author
- fields = '__all__'
复制代码 排除特定字段
如果你盼望序列化器包罗模型的全部字段,但排除某些字段,可以利用 exclude 属性:
- class AuthorSerializer(serializers.ModelSerializer):
- class Meta:
- model = Author
- exclude = ['created_at', 'updated_at']
复制代码 自定义字段
你还可以在序列化器中添加自定义字段:
- class AuthorSerializer(serializers.ModelSerializer):
- full_name = serializers.SerializerMethodField()
- class Meta:
- model = Author
- fields = ['id', 'name', 'full_name']
- def get_full_name(self, obj):
- return f"{obj.first_name} {obj.last_name}"
复制代码 fields 属性中字段的顺序决定了序列化的顺序
3. 利用序列化器
在视图中利用序列化器:
- # views.py
- from rest_framework import generics
- from .models import Author, Book
- from .serializers import AuthorSerializer, BookSerializer
- class AuthorListCreateView(generics.ListCreateAPIView):
- queryset = Author.objects.all()
- serializer_class = AuthorSerializer
- class BookListCreateView(generics.ListCreateAPIView):
- queryset = Book.objects.all()
- serializer_class = BookSerializer
复制代码 序列化方法
1. 序列化单个对象
- # 在 Django shell 或视图中
- from .models import Book
- from .serializers import BookSerializer
- book = Book.objects.first()
- serializer = BookSerializer(book)
- print(serializer.data)
复制代码 2. 序列化多个对象
- # 在 Django shell 或视图中
- books = Book.objects.all()
- serializer = BookSerializer(books, many=True)
- print(serializer.data)
复制代码
- 利用 many=True 可以一次性处理全部对象,而不需要手动循环处理每个对象 。
- 利用 many=True 可以提高性能,因为 DRF内部会举行优化,减少不必要的开销。手动循环处理每个对象大概会导致性能降落,尤其是在处理大量数据时。
反序列化方法
1. 反序列化单个对象
- # 在 Django shell 或视图中
- data = {'title': 'New Book', 'author': {'name': 'New Author'}}
- serializer = BookSerializer(data=data)
- if serializer.is_valid():
- book = serializer.save()
- print(book)
- else:
- print(serializer.errors)
复制代码 2. 反序列化多个对象
- # 在 Django shell 或视图中
- data = [
- {'title': 'Book 1', 'author': {'name': 'Author 1'}},
- {'title': 'Book 2', 'author': {'name': 'Author 2'}}
- ]
- serializer = BookSerializer(data=data, many=True)
- if serializer.is_valid():
- books = serializer.save()
- print(books)
- else:
- print(serializer.errors)
复制代码 免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |