Django REST Framework(六)模型序列化器

如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。

ModelSerializer与常规的Serializer相同，但提供了：

• 基于模型类自动生成一系列字段

• 基于模型类自动为Serializer生成validators，比如unique_together

• 包含默认的create()和update()的实现

• 模型序列化器定义

• 比如我们创建一个BookInfoSerializer

  
  class BookSerializer(serializers.ModelSerializer):
      """图书数据序列化器"""
      class Meta:
          model = Book
          fields = '__all__'

• model 指明参照哪个模型类

• fields 指明为模型类的哪些字段生成

• 我们可以在python manage.py shell中查看自动生成的BookSerializer的具体实现。

  class BookSerializer(serializers.ModelSerializer):
      """图书数据序列化器"""
  
      class Meta:
          model = Book
          fields = '__all__'
  
  
  # 视图
  class BookView(APIView):
  
      def get(self, request):
          books = Book.objects.all()
          bs = BookSerializer(instance=books, many=True)
          return Response(bs.data)
  
      def post(self, request):
          bs = BookSerializer(data=request.data)
          if bs.is_valid():
              bs.save()
              return Response(bs.data)
          else:
              return Response(bs.errors)
  
  
  class BookDetailView(APIView):
  
      def get(self, request, pk):
          book = Book.objects.get(pk=pk)
          bs = BookSerializer(instance=book)
          return Response(bs.data)
  
      def put(self, request, pk):
          instance = Book.objects.get(pk=pk)
          bs = BookSerializer(instance=instance, data=request.data)
          if bs.is_valid():
              bs.save()
              return Response(bs.data)
          else:
              return Response(bs.errors)
  
      def delete(self, request, pk):
          Book.objects.get(pk=pk).delete()
          return Response()

• 指定字段

  • 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如

    class BookSerializer(serializers.ModelSerializer):
        """图书数据序列化器"""
        class Meta
            model = BookInfo
            fields = ('id', 'title', 'pub_date')

  • 使用exclude可以明确排除掉哪些字段

    class BookSerializer(serializers.ModelSerializer):
        """图书数据序列化器"""
        class Meta:
            model = Book
            exclude = ('pub_date',)

  • 指明只读字段 可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段

    class BookSerializer(serializers.ModelSerializer):
        """图书数据序列化器"""
        class Meta:
            model = Book
            fields = ('id', 'title', 'pub_date'， 'bread', 'bcomment')
            read_only_fields = ('id', 'bread', 'bcomment')

• 添加额外参数

  • 我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

    class BookSerializer(serializers.ModelSerializer):
        """图书数据序列化器"""
        class Meta:
            model = Book
            fields = ('id', 'title', 'pub_date')
            extra_kwargs = {
                'bread': {'min_value': 0, 'required': True},
                'bcomment': {'min_value': 0, 'required': True},
            }
    '''
    BookSerializer():
        id = IntegerField(label='ID', read_only=True)
        title = CharField(label='书籍名称', max_length=32)
        pub_date = DateField(label='出版日期')
    
    '''