在DRF中使用延迟加载

时间:2019-03-28 08:37:51

标签: python django django-rest-framework

我想使用Django Rest Framework做一个简单的lazy loading。 我拥有Laravel的扎实背景,您可以像这样简单地使用它:

Subscription::with('company')->paginate()

但是使用DRF,我遇到了问题。一家公司可以一个订阅,而我的模型是这样定义的:

公司

class CompanyManager(BaseUserManager):
    def create_user(self, email, password=None):
        """
        Creates and saves a User with the given email and password
        """
        if not email:
            raise ValueError('Users must have an email address')

        user = self.model(
            email=self.normalize_email(email),
        )

        user.set_password(password)

        user.save(using=self._db)

        return user


class Company(AbstractBaseUser):
    """
        Company refers to what we have referee in the official document as "Empresa Partner"

        Attributes:
            name: The name of the main company
            email: Email to contact the main company
            code: the code attributed to this company
    """
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    email = models.EmailField(unique=True)
    username = models.CharField(blank=True, max_length=100)
    is_staff = models.BooleanField(blank=True, default=False)
    our_system_date = models.DateTimeField(auto_now=True)

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []

    objects = CompanyManager()

    def __str__(self):
        return self.email

订阅

class Subscription(models.Model):
    """
    Subscriptions that references the plans and the companies
    :company:
        The owner of this subscription

    :plan:
        The plan this subscription is based on

    :starts:
        When the subscription starts

    :ends:
        When this subscription ends
    """
    company = models.ForeignKey(Company, on_delete=models.CASCADE)
    plan = models.ForeignKey(Plan, on_delete=models.CASCADE)
    starts = models.DateTimeField()
    ends = models.DateTimeField()
    created_at = models.DateTimeField(auto_now=True)

我尝试使用此答案What's the difference between select_related and prefetch_related in Django ORM?所指的select_related,但每次向端点发出请求时,它都不会显示Company中与之相关的Subscription

我如何使用select_related

    def list(self, request, *args, **kwargs):
        queryset = Subscription.objects\
            .all().select_related('company')\
            .order_by('-created_at')
        page = self.paginate_queryset(queryset)

        if page is not None:
            serializer = SubscriptionSerializer(
                page,
                many=True,
            )

            return self.get_paginated_response(serializer.data)

在我的SubscriptionSerliazer中:

class SubscriptionSerializer(ModelSerializer):
    class Meta:
        model = Subscription
        fields = (
            'company',
            'plan',
            'starts',
            'ends',
            'created_at',
        )

1 个答案:

答案 0 :(得分:1)

如果要返回相关模型的字段而不是仅返回其主键,则需要为相关模型定义一个序列化器(在这里:CompanySerializer),并指示父序列化器使用它: / p>

class SubscriptionSerializer(ModelSerializer):
    company = CompanySerializer()

    class Meta:
        model = Subscription
        fields = (
            'company',
            # ...
        )