如何在DRF序列化Chart时获取关联Through模型的可见性属性？

首先修正模型中的笔误：你在MonitoredFlow模型的charts字段中指定的through="ChartFlows"应该改为through="ChartFlow"（因为中间表模型类名为ChartFlow，不是ChartFlows），否则Django无法正确关联中间表。

接下来通过自定义序列化器实现需求：

1. 带可见性字段的MonitoredFlow序列化器 #

创建一个序列化器，为每个MonitoredFlow实例添加is_visible字段，该字段从关联的ChartFlow中间表记录中获取值：

from rest_framework import serializers
from .models import Chart, MonitoredFlow, ChartFlow

class MonitoredFlowWithVisibilitySerializer(serializers.ModelSerializer):
    is_visible = serializers.SerializerMethodField()

    class Meta:
        model = MonitoredFlow
        fields = ['id', 'name', 'is_visible']

    def get_is_visible(self, obj):
        # 从上下文获取当前序列化的Chart实例
        current_chart = self.context.get('chart')
        if not current_chart:
            return True  # 默认可见
        
        # 查询当前Chart与该MonitoredFlow对应的中间表记录
        chart_flow = ChartFlow.objects.filter(
            chart=current_chart,
            monitored_flow=obj
        ).first()
        return chart_flow.is_monitored_flow_visible_on_chart if chart_flow else True

2. Chart主序列化器 #

在Chart的序列化器中使用上面的自定义序列化器，并将当前Chart实例传入子序列化器的上下文：

class ChartSerializer(serializers.ModelSerializer):
    monitored_flows = MonitoredFlowWithVisibilitySerializer(many=True)

    class Meta:
        model = Chart
        fields = ['id', 'name', 'monitored_flows']

    def to_representation(self, instance):
        # 将当前Chart实例传递给每个子序列化器的上下文
        child_serializer = self.fields['monitored_flows'].child
        child_serializer.context['chart'] = instance
        return super().to_representation(instance)

3. 优化查询避免N+1问题 #

在视图中使用prefetch_related预取关联数据，减少数据库查询次数：

from rest_framework.generics import RetrieveAPIView, ListAPIView
from django.db.models import Prefetch
from .models import Chart
from .serializers import ChartSerializer

class ChartDetailView(RetrieveAPIView):
    queryset = Chart.objects.prefetch_related(
        Prefetch(
            'monitored_flows',
            # 预取每个MonitoredFlow对应的ChartFlow记录
            queryset=MonitoredFlow.objects.prefetch_related('chartflow_set')
        )
    )
    serializer_class = ChartSerializer

class ChartListView(ListAPIView):
    queryset = Chart.objects.prefetch_related(
        Prefetch(
            'monitored_flows',
            queryset=MonitoredFlow.objects.prefetch_related('chartflow_set')
        )
    )
    serializer_class = ChartSerializer

验证结果 #

完成上述配置后，访问Chart的详情或列表接口，返回的格式将符合你的预期：

{
    "id": 1,
    "name": "some chart name",
    "monitored_flows": [
        {
            "id": 1,
            "name": "some flow name",
            "is_visible": true
        }
    ]
}

内容的提问来源于stack exchange，提问作者A-Palgy