使用 Django Rest Framework 3.2.2 具有现有对象的可写嵌套序列化程序

Posted 2023-02-24

【中文标题】使用 Django Rest Framework 3.2.2 具有现有对象的可写嵌套序列化程序

【英文标题】：Writable nested serializer with existing objects using Django Rest Framework 3.2.2

【发布时间】：2015-11-14 09:14:23

【问题描述】：

考虑一个具有关联类别的列表模型。我想通过对数据进行 POST 来为现有类别创建一个新列表： "title": "myapp", "category": "name": "Business"，其中title 是应创建的列表的标题，Business 是用于此新列表的现有类别的名称。

当我尝试发出这样的请求并为此实例化 ListingSerializer 时，我收到一个错误，指出类别名称必须是唯一的 - 我不想创建新类别，而是使用现有类别.我尝试将类别字段上的验证器设置为 []，但这并没有改变行为。

我可以使用SlugRelatedField，但这会迫使我的请求数据看起来更像"title": "myapp", "category": "Business"，这不是我想要的。我尝试使用SlugRelatedField 的source 参数来指定嵌套关系，但这也不起作用：

category = serializers.SlugRelatedField(
        slug_field='category.name',
        queryset=models.Category.objects.all()
    )

产量：

  "category": [
    "Object with name='name': 'Business' does not exist."
  ]

models.py：

import django.contrib.auth
from django.db import models
from django.conf import settings

class Profile(models.Model):
    display_name = models.CharField(max_length=255)
    user = models.OneToOneField(settings.AUTH_USER_MODEL)

class Category(models.Model):
    name = models.CharField(max_length=50, unique=True)
    description = models.CharField(max_length=200)

class Listing(models.Model):
    title = models.CharField(max_length=50, unique=True)
    category = models.ForeignKey(Category, related_name='listings', null=True)
    owners = models.ManyToManyField(
        Profile,
        related_name='owned_listings',
        db_table='profile_listing',
        blank=True
    )

serializers.py:

import logging
import django.contrib.auth
from rest_framework import serializers
import myapp.models as models

logger = logging.getLogger('mylogger')

class ShortUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = django.contrib.auth.models.User
        fields = ('username', 'email')

class ProfileSerializer(serializers.ModelSerializer):
    user = ShortUserSerializer()
    class Meta:
        model = models.Profile
        fields = ('user', 'display_name')
        read_only = ('display_name',)

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Category
        fields = ('name', 'description')
        read_only = ('description',)


class ListingSerializer(serializers.ModelSerializer):
    owners = ProfileSerializer(required=False, many=True)
    # TODO: how to indicate that this should look for an existing category?
    category = CategorySerializer(required=False, validators=[])

    class Meta:
        model = models.Listing
        depth = 2

    def validate(self, data):
        logger.info('inside ListingSerializer validate')
        return data

    def create(self, validated_data):
        logger.info('inside ListingSerializer.create')
        # not even getting this far...

views.py：

import logging

from django.http import HttpResponse
from django.shortcuts import get_object_or_404

import django.contrib.auth

from rest_framework import viewsets
from rest_framework.response import Response

import myapp.serializers as serializers
import myapp.models as models


# Get an instance of a logger
logger = logging.getLogger('mylogger')

class CategoryViewSet(viewsets.ModelViewSet):
    queryset = models.Category.objects.all()
    serializer_class = serializers.CategorySerializer

class UserViewSet(viewsets.ModelViewSet):
    queryset = django.contrib.auth.models.User.objects.all()
    serializer_class = serializers.ShortUserSerializer

class ProfileViewSet(viewsets.ModelViewSet):
    queryset = models.Profile.objects.all()
    serializer_class = serializers.ProfileSerializer

class ListingViewSet(viewsets.ModelViewSet):
    logger.info('inside ListingSerializerViewSet')
    queryset = models.Listing.objects.all()
    serializer_class = serializers.ListingSerializer

完整示例：https://github.com/arw180/drf-example

【问题讨论】：

非常彻底。我很惊讶这没有尽快得到答复。

github.com/beda-software/drf-writable-nested 可能有用

【参考方案1】：

这并不理想，但我确实找到了解决我的问题的解决方案（我正在等待接受它作为答案，希望其他人可以做得更好）。分为两部分：

首先，在初始化ListingSerializer (http://www.django-rest-framework.org/api-guide/serializers/#partial-updates) 时使用partial=True 参数。然后使用序列化器的validate方法获取输入数据对应的实际模型实例。

其次，明确删除CategorySerializer 中name 字段的验证器。这尤其糟糕，因为它影响的不仅仅是ListingSerializer。

遗漏任何一部分都会导致在序列化程序被实例化时抛出验证错误。

对views.py的修改：

class ListingViewSet(viewsets.ModelViewSet):
    queryset = models.Listing.objects.all()
    serializer_class = serializers.ListingSerializer

    def create(self, request):
        serializer = serializers.ListingSerializer(data=request.data,
            context='request': request, partial=True)
        if not serializer.is_valid():
            logger.error('%s' % serializer.errors)
            return Response(serializer.errors,
                  status=status.HTTP_400_BAD_REQUEST)

        serializer.save()
        return Response(serializer.data, status=status.HTTP_201_CREATED)

对 serializers.py 的修改：

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Category
        fields = ('name', 'description')
        read_only = ('description',)
        # also need to explicitly remove validators for `name` field
        extra_kwargs = 
            'name': 
                'validators': []
            
        

class ListingSerializer(serializers.ModelSerializer):
    owners = ProfileSerializer(required=False, many=True)
    category = CategorySerializer(required=False)
    class Meta:
        model = models.Listing
        depth = 2

    def validate(self, data):
        # manually get the Category instance from the input data
        data['category'] = models.Category.objects.get(name=data['category']['name'])
        return data

    def create(self, validated_data):
        title = validated_data['title']

        listing = models.Listing(title=validated_data['title'],
            category=validated_data['category'])

        listing.save()

        if 'owners' in validated_data:
            logger.debug('owners: %s' % validated_data['owners'])
            for owner in validated_data['owners']:
                print ('adding owner: %s' % owner)
                listing.owners.add(owner)
        return listing

如果有人能想出更好的解决方案（例如如何使source 参数与SlugRelatedField 一起正常工作），我会稍等片刻接受这个答案 - 我有一个使用示例如果你想试验，上面的解决方案https://github.com/arw180/drf-example。我也很想听听 cmets 关于为什么在 CategorySerializer 中需要 extra_kwargs 的东西 - 为什么不像这样实例化它：category = CategorySerializer(required=False, validators=[]) 足够（在 ListingSerializer 中）？更新：我认为这不起作用，因为唯一验证器是从数据库约束中自动添加的，并且无论此处设置的任何显式验证器如何都运行，如本答案所述：http://iswwwup.com/t/3bf20dfabe1f/python-order-of-serializer-validation-in-django-rest-framework.html

【讨论】：

您应该接受这个答案，因为它仍然是“最先进的”（参见github issue）。该票证还包含指向核心贡献者的帖子的链接，该帖子的文档大致相同。

【参考方案2】：

将CategorySerializer.create 转为update_or_create 方法name

class CategorySerializer(serializers.ModelSerializer):

    ...

    # update_or_create on `name`
    def create(self, validated_data):
        try:
            self.instance = Category.objects.get(name=validated_data['name'])
            self.instance = self.update(self.instance, validated_data)
            assert self.instance is not None, (
                '`update()` did not return an object instance.'
            )
            return self.instance
        except Category.DoesNotExist:
            return super(CategorySerializer, self).create(validated_data)

    ...

我建议您在需要创建自定义功能时查看DRF source。

DRF的创建者回答的相关问题：django-rest-framework 3.0 create or update in nested serializer

编辑

所以我仍然处于自动处理嵌套可写字段的 DRF 2 思维模式中。你可以在这里阅读这个主题：http://www.django-rest-framework.org/topics/3.0-announcement/

我已经测试了以下代码并且它可以工作：

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        ...
        extra_kwargs = 
            'name': 'validators': [],
            'description': 'required': False,
        


class ListingSerializer(serializers.ModelSerializer):

    ...

    def update_or_create_category(self, validated_data):
        data = validated_data.pop('category', None)
        if not data:
            return None

        category, created = models.Category.objects.update_or_create(
            name=data.pop('name'), defaults=data)

        validated_data['category'] = category

    def create(self, validated_data):
        self.update_or_create_category(validated_data)
        return super(ListingSerializer, self).create(validated_data)

    def update(self, instance, validated_data):
        self.update_or_create_category(validated_data)
        return super(ListingSerializer, self).update(instance, validated_data)

编辑

SlugRelatedField的正确使用方式是这样的，如果你想知道的话：

class ListingSerializer(serializers.ModelSerializer):

    ...

    # slug_field should be 'name', i.e. the name of the field on the related model
    category = serializers.SlugRelatedField(slug_field='name',
        queryset=models.Category.objects.all())

    ...

【讨论】：

在ModelViewSet 中实例化序列化程序时出现验证错误，因此即使进行了这些更改，我仍然有错误。

好的，我会调查的。

虽然我对partial=True 的使用更简洁，但一旦我添加了对 PUT 请求的支持，您的解决方案可能会更好。它仍然使用extra_kwargs 删除CategorySerializer 类的验证器，这并不理想，尽管汤姆克里斯蒂本人选择在您链接的答案中不使用ModelSerializer，一个好处是它可以避免这种情况自动生成的字段验证器存在问题。除非有人使用SlugRelatedField

找到更清洁的方法，否则我可能会接受这一点

如果您尝试将字段留空或未定义等操作，您会发现验证仍在进行中。

哦，如果不存在具有请求名称的类别，您不希望它创建一个新类别吗？

【参考方案3】：

我有类似的问题：我需要检查嵌套序列化程序 (CategorySerializer) 是否存在，如果是则使用它，如果不存在 - 从嵌套序列化程序 (ListingSerializer) 创建它。仅当我没有对嵌套序列化程序中的字段使用自定义验证时，@demux 的解决方案才对我完全有效（如果存在此实例，我将从嵌套序列化程序检查该字段）。所以我在嵌套序列化程序中添加了create() 方法，并且@demux 自定义update_or_create_category()、create()、update() 为ListingSerializer 工作得很好。

class CategorySerializer(serializers.ModelSerializer):

    class Meta:
    model = Category
    ...

    def create(self, validated_data):
        if Category.objects.filter(name=self.validated_data['name']).exists():
            raise serializers.ValidationError("This category name already exists")
        return Category.objects.create(**validated_data)