Django rest framework ซ้อนอ็อบเจกต์อ้างอิงตัวเอง

ฉันมีโมเดลที่มีลักษณะดังนี้:

class Category(models.Model):
    parentCategory = models.ForeignKey('self', blank=True, null=True, related_name='subcategories')
    name = models.CharField(max_length=200)
    description = models.CharField(max_length=500)

ฉันจัดการเพื่อให้แสดง json แบบแบนของทุกหมวดหมู่ด้วย serializer:

class CategorySerializer(serializers.HyperlinkedModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()
    subcategories = serializers.ManyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

ตอนนี้สิ่งที่ฉันต้องการทำคือให้รายการหมวดหมู่ย่อยมีการแสดงประเภทย่อยแบบอินไลน์ json แทนรหัสของพวกเขา ฉันจะทำอย่างไรกับ django-rest-framework ฉันพยายามค้นหาในเอกสาร แต่ดูเหมือนว่าไม่สมบูรณ์

แทนที่จะใช้ ManyRelatedField ให้ใช้ Serializer ที่ซ้อนกันเป็นฟิลด์ของคุณ:

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

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()
    subcategories = serializers.SubCategorySerializer()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

หากคุณต้องการจัดการกับฟิลด์ที่ซ้อนกันโดยพลการคุณควรดูที่การปรับแต่งฟิลด์เริ่มต้นในส่วนของเอกสาร ขณะนี้คุณไม่สามารถประกาศซีเรียลไลเซอร์เป็นฟิลด์ในตัวมันเองได้โดยตรง แต่คุณสามารถใช้วิธีการเหล่านี้เพื่อแทนที่ฟิลด์ที่จะใช้โดยค่าเริ่มต้น

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

        def get_related_field(self, model_field):
            # Handles initializing the `subcategories` field
            return CategorySerializer()

อันที่จริงตามที่คุณระบุไว้ข้างต้นไม่ถูกต้องนัก นี่เป็นการแฮ็กเล็กน้อย แต่คุณอาจลองเพิ่มช่องหลังจากประกาศ serializer แล้ว

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()

    class Meta:
        model = Category
        fields = ('parentCategory', 'name', 'description', 'subcategories')

CategorySerializer.base_fields['subcategories'] = CategorySerializer()

กลไกของการประกาศความสัมพันธ์แบบเรียกซ้ำเป็นสิ่งที่ต้องเพิ่ม

แก้ไข : โปรดทราบว่าขณะนี้มีแพ็กเกจของบุคคลที่สามซึ่งเกี่ยวข้องกับกรณีการใช้งานประเภทนี้โดยเฉพาะ ดูdjangorestframework-recursive

@ วิธีการแก้ปัญหาของ wjin ได้ทำงานที่ดีสำหรับผมจนผมอัพเกรด Django REST กรอบ 3.0.0 ซึ่ง deprecates to_native นี่คือโซลูชัน DRF 3.0 ของฉันซึ่งเป็นการปรับเปลี่ยนเล็กน้อย

สมมติว่าคุณมีโมเดลที่มีช่องอ้างอิงตัวเองเช่นความคิดเห็นที่เป็นชุดข้อความในคุณสมบัติที่เรียกว่า "การตอบกลับ" คุณมีการแสดงแผนภูมิต้นไม้ของเธรดความคิดเห็นนี้และคุณต้องการจัดลำดับแผนภูมิ

ขั้นแรกกำหนดคลาส RecursiveField ที่ใช้ซ้ำได้ของคุณ

class RecursiveField(serializers.Serializer):
    def to_representation(self, value):
        serializer = self.parent.parent.__class__(value, context=self.context)
        return serializer.data

จากนั้นสำหรับซีเรียลไลเซอร์ของคุณให้ใช้ RecursiveField เพื่อจัดลำดับค่าของ "การตอบกลับ"

class CommentSerializer(serializers.Serializer):
    replies = RecursiveField(many=True)

    class Meta:
        model = Comment
        fields = ('replies, ....)

Easy peasy และคุณต้องใช้โค้ด 4 บรรทัดสำหรับโซลูชันที่ใช้ซ้ำได้

หมายเหตุ: หากโครงสร้างข้อมูลของคุณซับซ้อนกว่าแบบต้นไม้เช่นพูดว่าเป็น กราฟ acyclic ที่กำหนดทิศทาง (FANCY!) คุณสามารถลองใช้แพ็คเกจของ @ wjin - ดูวิธีแก้ปัญหาของเขา แต่ฉันไม่มีปัญหากับวิธีแก้ปัญหานี้สำหรับต้นไม้ที่ใช้ MPTTModel

อีกทางเลือกหนึ่งที่ใช้ได้กับ Django REST Framework 3.3.2:

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = Category
        fields = ('id', 'name', 'parentid', 'subcategories')

    def get_fields(self):
        fields = super(CategorySerializer, self).get_fields()
        fields['subcategories'] = CategorySerializer(many=True)
        return fields

มาเล่นเกมช้าที่นี่ แต่นี่คือทางออกของฉัน สมมติว่าฉันเป็นอนุกรมของ Blah โดยมีลูกหลายคนเป็นประเภท Blah ด้วย

    class RecursiveField(serializers.Serializer):
        def to_native(self, value):
            return self.parent.to_native(value)

การใช้ฟิลด์นี้ฉันสามารถทำให้เป็นอนุกรมของวัตถุที่กำหนดซ้ำซึ่งมีวัตถุลูกจำนวนมาก

    class BlahSerializer(serializers.Serializer):
        name = serializers.Field()
        child_blahs = RecursiveField(many=True)

ฉันเขียนฟิลด์แบบวนซ้ำสำหรับ DRF3.0 และบรรจุไว้สำหรับ pip https://pypi.python.org/pypi/djangorestframework-recursive/

ฉันสามารถบรรลุผลลัพธ์นี้ได้โดยใช้ไฟล์serializers.SerializerMethodField. ฉันไม่แน่ใจว่านี่เป็นวิธีที่ดีที่สุดหรือเปล่า แต่ได้ผลสำหรับฉัน:

class CategorySerializer(serializers.ModelSerializer):

    subcategories = serializers.SerializerMethodField(
        read_only=True, method_name="get_child_categories")

    class Meta:
        model = Category
        fields = [
            'name',
            'category_id',
            'subcategories',
        ]

    def get_child_categories(self, obj):
        """ self referral field """
        serializer = CategorySerializer(
            instance=obj.subcategories_set.all(),
            many=True
        )
        return serializer.data

อีกทางเลือกหนึ่งคือการเรียกคืนในมุมมองที่ทำให้โมเดลของคุณเป็นอนุกรม นี่คือตัวอย่าง:

class DepartmentSerializer(ModelSerializer):
    class Meta:
        model = models.Department


class DepartmentViewSet(ModelViewSet):
    model = models.Department
    serializer_class = DepartmentSerializer

    def serialize_tree(self, queryset):
        for obj in queryset:
            data = self.get_serializer(obj).data
            data['children'] = self.serialize_tree(obj.children.all())
            yield data

    def list(self, request):
        queryset = self.get_queryset().filter(level=0)
        data = self.serialize_tree(queryset)
        return Response(data)

    def retrieve(self, request, pk=None):
        self.object = self.get_object()
        data = self.serialize_tree([self.object])
        return Response(data)

เมื่อเร็ว ๆ นี้ฉันมีปัญหาเดียวกันและได้หาวิธีแก้ปัญหาที่ดูเหมือนจะใช้งานได้แม้ในเชิงลึกโดยพลการ วิธีแก้ปัญหาคือการดัดแปลงเล็กน้อยจาก Tom Christie:

class CategorySerializer(serializers.ModelSerializer):
    parentCategory = serializers.PrimaryKeyRelatedField()

    def convert_object(self, obj):
        #Add any self-referencing fields here (if not already done)
        if not self.fields.has_key('subcategories'):
            self.fields['subcategories'] = CategorySerializer()      
        return super(CategorySerializer,self).convert_object(obj) 

    class Meta:
        model = Category
        #do NOT include self-referencing fields here
        #fields = ('parentCategory', 'name', 'description', 'subcategories')
        fields = ('parentCategory', 'name', 'description')
#This is not needed
#CategorySerializer.base_fields['subcategories'] = CategorySerializer()

ฉันไม่แน่ใจว่ามันสามารถทำงานได้อย่างน่าเชื่อถือในทุกสถานการณ์แม้ว่า ...

นี่คือการดัดแปลงจากโซลูชัน caipirginka ที่ทำงานบน drf 3.0.5 และ django 2.7.4:

class CategorySerializer(serializers.ModelSerializer):

    def to_representation(self, obj):
        #Add any self-referencing fields here (if not already done)
        if 'branches' not in self.fields:
            self.fields['subcategories'] = CategorySerializer(obj, many=True)      
        return super(CategorySerializer, self).to_representation(obj) 

    class Meta:
        model = Category
        fields = ('id', 'description', 'parentCategory')

โปรดสังเกตว่า CategorySerializer ในบรรทัดที่ 6 ถูกเรียกด้วยออบเจ็กต์และแอตทริบิวต์ many = True

ฉันคิดว่าฉันจะเข้าร่วมสนุก!

ผ่านwjinและMark Chackerianฉันได้สร้างวิธีแก้ปัญหาทั่วไปมากขึ้นซึ่งใช้ได้กับโมเดลที่เหมือนต้นไม้โดยตรงและโครงสร้างต้นไม้ที่มีแบบจำลองผ่าน ฉันไม่แน่ใจว่านี่เป็นคำตอบของมันเองหรือเปล่า แต่ฉันคิดว่าฉันอาจจะใส่มันไว้ที่ไหนสักแห่ง ฉันรวมตัวเลือก max_depth ซึ่งจะป้องกันการเรียกซ้ำแบบไม่สิ้นสุดที่เด็กระดับลึกที่สุดจะแสดงเป็น URLS (นั่นคือประโยคสุดท้ายหากคุณไม่ต้องการให้เป็น url)

from rest_framework.reverse import reverse
from rest_framework import serializers

class RecursiveField(serializers.Serializer):
    """
    Can be used as a field within another serializer,
    to produce nested-recursive relationships. Works with
    through models, and limited and/or arbitrarily deep trees.
    """
    def __init__(self, **kwargs):
        self._recurse_through = kwargs.pop('through_serializer', None)
        self._recurse_max = kwargs.pop('max_depth', None)
        self._recurse_view = kwargs.pop('reverse_name', None)
        self._recurse_attr = kwargs.pop('reverse_attr', None)
        self._recurse_many = kwargs.pop('many', False)

        super(RecursiveField, self).__init__(**kwargs)

    def to_representation(self, value):
        parent = self.parent
        if isinstance(parent, serializers.ListSerializer):
            parent = parent.parent

        lvl = getattr(parent, '_recurse_lvl', 1)
        max_lvl = self._recurse_max or getattr(parent, '_recurse_max', None)

        # Defined within RecursiveField(through_serializer=A)
        serializer_class = self._recurse_through
        is_through = has_through = True

        # Informed by previous serializer (for through m2m)
        if not serializer_class:
            is_through = False
            serializer_class = getattr(parent, '_recurse_next', None)

        # Introspected for cases without through models.
        if not serializer_class:
            has_through = False
            serializer_class = parent.__class__

        if is_through or not max_lvl or lvl <= max_lvl: 
            serializer = serializer_class(
                value, many=self._recurse_many, context=self.context)

            # Propagate hereditary attributes.
            serializer._recurse_lvl = lvl + is_through or not has_through
            serializer._recurse_max = max_lvl

            if is_through:
                # Delay using parent serializer till next lvl.
                serializer._recurse_next = parent.__class__

            return serializer.data
        else:
            view = self._recurse_view or self.context['request'].resolver_match.url_name
            attr = self._recurse_attr or 'id'
            return reverse(view, args=[getattr(value, attr)],
                           request=self.context['request'])

ด้วย Django REST framework 3.3.1 ฉันต้องการรหัสต่อไปนี้เพื่อเพิ่มหมวดหมู่ย่อยในหมวดหมู่:

Models.py

class Category(models.Model):

    id = models.AutoField(
        primary_key=True
    )

    name = models.CharField(
        max_length=45, 
        blank=False, 
        null=False
    )

    parentid = models.ForeignKey(
        'self',
        related_name='subcategories',
        blank=True,
        null=True
    )

    class Meta:
        db_table = 'Categories'

serializers.py

class SubcategorySerializer(serializers.ModelSerializer):

    class Meta:
        model = Category
        fields = ('id', 'name', 'parentid')


class CategorySerializer(serializers.ModelSerializer):
    subcategories = SubcategorySerializer(many=True, read_only=True)

    class Meta:
        model = Category
        fields = ('id', 'name', 'parentid', 'subcategories')

โซลูชันนี้เกือบจะคล้ายกับโซลูชันอื่น ๆ ที่โพสต์ไว้ที่นี่ แต่มีความแตกต่างเล็กน้อยในแง่ของปัญหาการทำซ้ำของเด็กที่ระดับราก (หากคุณคิดว่าเป็นปัญหา) ตัวอย่างเช่น

class RecursiveSerializer(serializers.Serializer):
    def to_representation(self, value):
        serializer = self.parent.parent.__class__(value, context=self.context)
        return serializer.data

class CategoryListSerializer(ModelSerializer):
    sub_category = RecursiveSerializer(many=True, read_only=True)

    class Meta:
        model = Category
        fields = (
            'name',
            'slug',
            'parent', 
            'sub_category'
    )

และหากคุณมีมุมมองนี้

class CategoryListAPIView(ListAPIView):
    queryset = Category.objects.all()
    serializer_class = CategoryListSerializer

สิ่งนี้จะให้ผลลัพธ์ดังต่อไปนี้

[
{
    "name": "parent category",
    "slug": "parent-category",
    "parent": null,
    "sub_category": [
        {
            "name": "child category",
            "slug": "child-category",
            "parent": 20,  
            "sub_category": []
        }
    ]
},
{
    "name": "child category",
    "slug": "child-category",
    "parent": 20,
    "sub_category": []
}
]

ที่นี่parent categoryมีการเป็นchild categoryตัวแทนและ json คือสิ่งที่เราต้องการให้เป็นตัวแทน

แต่คุณจะเห็นว่ามีการทำซ้ำchild categoryที่ระดับราก

เนื่องจากบางคนกำลังถามในส่วนความคิดเห็นของคำตอบที่โพสต์ไว้ข้างต้นว่าเราจะหยุดการทำซ้ำของเด็กในระดับรากได้อย่างไรเพียงกรองชุดแบบสอบถามของคุณด้วยparent=Noneดังต่อไปนี้

class CategoryListAPIView(ListAPIView):
    queryset = Category.objects.filter(parent=None)
    serializer_class = CategoryListSerializer

มันจะแก้ปัญหาได้

หมายเหตุ: คำตอบนี้อาจไม่เกี่ยวข้องโดยตรงกับคำถาม แต่ปัญหานั้นเกี่ยวข้องกัน นอกจากนี้วิธีการใช้RecursiveSerializerนี้มีราคาแพง จะดีกว่าถ้าคุณใช้ตัวเลือกอื่นที่มีประสิทธิภาพสูง