Django:嵌套属性上的 Prefetch_related

Question

我需要列出我所有的设备。为此，我使用与减少查询量相关的预取。但是其中一个花费了太多时间..我想知道它是否不能更好。

我将从模型构造开始:我想要一个设备列表。

class Device(models.Model):
    name = models.CharField(max_length=250, null=True, blank=True)

class GatewayDevice(models.Model):
    gateway = models.ForeignKey(
        Gateway, on_delete=models.CASCADE, related_name="devices"
    )
    device = models.ForeignKey(
        Device, on_delete=models.CASCADE, related_name="gatewaydevices"
    )

在实际代码中，设备模型更大，但该代码无关紧要。如你所见，一个设备有一些网关设备(网关和设备之间的模型)

所以在我的设备列表中，我希望每个设备都有链接的网关。

这是我的观点:

class AdminDeviceView(GenericAPIView):
    def get_permissions(self):
        return IsAuthenticated()

    # noinspection PyMethodMayBeStatic
    def get_serializer_class(self):
        return AdminDeviceInfoSerializer

    @swagger_auto_schema(
        responses={
            200: openapi.Response(
                _("Successfully fetched all data from devices."),
                AdminDeviceInfoSerializer,
            )
        }
    )

    def get(self, request):
    """
    GET the data from all the devices.
    """

    devices = (
        Device.objects.filter()
        .all()
        .prefetch_related(
            "site__users",
            "software_update_history",
            "supplier",
            Prefetch(
                "gatewaydevices",
                queryset=GatewayDevice.objects.filter(end_date=None)
                .order_by()
                .distinct()
                .prefetch_related("gateway"),
            ),
        )
    )

    serializer_class = self.get_serializer_class()
    serializer = serializer_class(devices, many=True)
    devices_data = serializer.data

    return Response(
        {"total": devices.count(), "items": devices_data}, status=status.HTTP_200_OK
    )

这是序列化程序的重要部分:

@staticmethod
def get_gateway(device):
    return (
        GatewaySimpleSerializer(device.gatewaydevices.gateway).data
        if device.gatewaydevices.gateway
        else None
    )

我尝试了不同的方法。这是当前的..现在我收到这个错误:

AttributeError: 'RelatedManager' object has no attribute 'gateway'

Answer 1

首先，您应该可以使用 .select_related("gateway")而不是 .prefetch_related("gateway") .这应该可以为您节省一个查询。
你的问题似乎在这里:

if device.gatewaydevices.gateway

在这里， gatewaydevices不是单个模型实例，因此它没有网关属性。我不确定您的用例是什么，但可以有多个 gatewaydevices .也许你想要第一个(如果为零，这将失败 gatewaydevices ):

if device.gatewaydevices.first().gateway

也许你想知道是否有。这应该有效:

if device.gatewaydevices.filter(gateway__isnull=False)

但这似乎很奇怪，如果您想排除没有 gateway 的对象，感觉此代码应该与查询的其余部分一起使用。 s。我认为你应该删除 if完全并始终返回数据。这样做不会节省任何数据库时间。
基于进一步的评论:

if device.gatewaydevices.filter(end_date__isnull=True).first()

如果您试图避免额外的工作，则一种(可能)更好的方式来编写查询:

gateway_devices = (
    GatewayDevice.objects
    .filter(end_date__isnull=True)
    .select_related("gateway", "device")
)

这将在一个查询中获取所有内容，您只需使用简单的属性访问即可获取相关对象，而无需任何额外查询，例如:

for gateway_device in gateway_devices:
   print(gateway_device.device.name)

看看你的模型(虽然我看不到我需要完美地写这个的一切)看起来你也想要一些来自 Device 的信息。关系，所以你可能需要调整它以获得 device预取你需要的东西，比如:

gateway_devices = (
    GatewayDevice.objects
    .filter(end_date_isnull=True)
    .select_related("gateway")
    .prefetch_related(
        Prefetch(
            "device",
            queryset=Device.objects.prefetch_related(
                # Depending how these are related you may be able to
                # save some queries using `select_related()` instead.
                "site__users", "software_update_history", "supplier"
            )
        )
    )
)

这可能并不完美，但它应该为您提供良好开端所需的一切。