【问题标题】:Implement a writable serializer for multilevel nested relationships in django rest framework在 django rest 框架中为多级嵌套关系实现可写序列化器
【发布时间】:2015-11-13 09:10:38
【问题描述】:

在 drf3 中,您现在可以通过重写 create() 方法并自己处理 valid_data 来实现可写的嵌套序列化程序。但是,如果您在模型中有这样的多层嵌套关系怎么办:

class Order(models.Model):
    """
    Order model to aggregate all the shipments created by a user at a particular time.
    """
    created_at = models.DateTimeField(
        verbose_name='created at',
        auto_now_add=True
    )
    updated_at = models.DateTimeField(
        verbose_name='updated at',
        auto_now=True
    )

class Shipment(models.Model):
    """
    Many to One Relationship with the Orders Model. Aggregates all the details of a shipment being sent.
    """
    created_at = models.DateTimeField(
        verbose_name='created at',
        auto_now_add=True
    )
    updated_at = models.DateTimeField(
        verbose_name='updated at',
        auto_now=True
    )
    order = models.ForeignKey(
        to=Order
    )

class ItemDetail(models.Model):
    """
    Specifies details of the shipment contents. One to One relationship with the Shipment Model.
    """
    shipment = models.OneToOneField(
        to=Shipment,
        primary_key=True
    )
    CONTENT_TYPES = (
        ('D', 'Documents'),
        ('P', 'Products')
    )
    content = models.CharField(
        verbose_name='package contents',
        max_length=1,
        choices=CONTENT_TYPES,
        default='P'
    )

如何使用自定义创建方法为订单编写序列化程序来处理这种情况?我见过的所有例子,包括官方页面上的例子,都只有一层嵌套关系。

Read 与 depth 参数一起工作正常。不过,我真的 感谢您对编写创建/更新方法的任何帮助。

【问题讨论】:

    标签: django django-rest-framework


    【解决方案1】:

    writable nested serializer is explained in the documentation。

    请不要在创建/更新中重新创建新的序列化程序。 一旦您点击了最顶部的序列化程序创建/更新,您的所有数据都会得到验证,包括嵌套数据。

    此时,您必须自己编写从验证数据到各种对象的映射。

    我试图让它在 DRF 2.x 中自动运行,但结果发现用例太多,其中一些是专有的。因此,DRF 将这项工作留给了开发人员 - 即您。

    【讨论】:

    • 文档仅显示了如何为嵌套深度 = 1 的序列化程序编写创建/更新。我不确定如何为深度 > 1 编写一个。我是否必须编写创建/更新每个级别,它都会自动进行验证,还是我必须在顶部序列化器上展平结构,以便在那里完成验证?
    • 正如我在回答中所说,验证已经完成并且包含深度元素。您只需要最顶级的序列化程序的创建/更新方法来创建/更新/删除各种实例,包括深度实例,无论它有多深。
    • 明白了。唯一不清楚的是我将如何弹出下两层的对象的验证数据,在本例中为 ItemDetail。我猜 OrderSerializer 上的 create 方法会首先创建订单。然后是装运,最后是 ItemDetail。对于发货,我可以做shipments = validated_data.pop('shipments')。但是我将如何获得 ItemDetail 的验证数据?
    • shipment_data = valid_data.pop('shipments') 然后在 shipping_data 上循环,您将弹出第二层,依此类推
    • 完美。谢谢 :) 将尝试并发布结果
    【解决方案2】:

    一种方法是有两个序列化程序,第一个是 ItemDetailSerializer,它将调用 ShipmentSirializer 来处理 Order 和 Shipment 的创建,然后创建 ItemDetail 本身。

    类似:

    class ItemDetailSerializer(serializers.ModelSerializer):
        """
        # Describe here all relationships
        """
        class Meta:
            model = ItemDetail
    
        def create(self, validated_data):
    
            shipment = validated_data.pop('shipment')
            shipment_serializer = ShipmentSerializer(data=shipment)
            if shipment_serializer.is_valid()
                shipment_serializer.save()
    
                item_detail = ItemDetail.objects.create(shipment=shipment_serializer.instance,
                                                        **validated_data)
                return item_detail
    

    对于ShipmentSerializer,您可以关注您提到的有关嵌套关系的文档。

    【讨论】:

    • 首先非常感谢您的回复。我实际上是在寻找一种方法来定义一个订单序列化程序,它将使用反向关系进行发货(我知道如何从官方文档中做到这一点)。但是,我不清楚的部分是,如何在调用订单序列化程序时验证和创建 itemdetail 对象?
    • 为此,您需要自己实施验证。只需覆盖validate_item_detail 方法并将item_detail 添加到您的OrderSerializer
    • 所以,基本上我必须展平嵌套结构并将深度 > 1 的所有子模型引入顶部序列化程序并在顶部序列化程序本身中创建对象?如果这不是你的意思,请纠正我
    • 是的,使用这种方法,您需要 pop 深度 > 1 的所有内容,并分别为它们创建对象。
    猜你喜欢
    • 2016-10-01
    • 2018-12-13
    • 2017-02-09
    • 2016-09-03
    • 2021-06-23
    • 1970-01-01
    • 1970-01-01
    • 2018-10-05
    • 2015-03-20
    相关资源
    最近更新 更多