人世一身霜雪, 归来仍是少年.

Django小技巧11: 自定义链式Queryset Manager

翻译整理自: simpleisbetterthancomplex.com

在 Django Model 中,Manager是与数据库交互的接口。默认情况下Manager可通过Model.objects属性使用。默认情况下, 每个 Model 的默认 Manager 是django.db.models.Manager。扩展和重写默认Manager非常简单.

Python
 
from django.db import models

class DocumentManager(models.Manager):
    def pdfs(self):
        return self.filter(file_type='pdf')

    def smaller_than(self, size):
        return self.filter(size__lt=size)

class Document(models.Model):
    name = models.CharField(max_length=30)
    size = models.PositiveIntegerField(default=0)
    file_type = models.CharField(max_length=10, blank=True)

    objects = DocumentManager()

设置后, 你可以通过pdfs方法快速的过滤属于 PDF 的文档.

Python
 
Document.objects.pdfs()

当然,返回的结果是链式的, 依然拥有 queryset 的一些操作方法(order_byfilter等..).

Python
 
Document.objects.pdfs().order_by('name')

但是, 如果你试图在使用自定义的一些方法, 链式将会中止:

Python
 
Document.objects.pdfs().smaller_than(1000)

AttributeError: 'QuerySet' object has no attribute 'smaller_than'

要使上述代码能够工作, 你必须创建自定义的get_queryset方法.

Python
 
class DocumentQuerySet(models.QuerySet):
    def pdfs(self):
        return self.filter(file_type='pdf')

    def smaller_than(self, size):
        return self.filter(size__lt=size)

class DocumentManager(models.Manager):
    def get_queryset(self):
        return DocumentQuerySet(self.model, using=self._db)  # Important!

    def pdfs(self):
        return self.get_queryset().pdfs()

    def smaller_than(self, size):
        return self.get_queryset().smaller_than(size)

class Document(models.Model):
    name = models.CharField(max_length=30)
    size = models.PositiveIntegerField(default=0)
    file_type = models.CharField(max_length=10, blank=True)

    objects = DocumentManager()

现在可以像任何的 QuerySet 方法一样使用他。 并且是链式的!

Python
 
Document.objects.pdfs().smaller_than(1000).exclude(name='Article').order_by('name')

Manager 除了自定义 QuerySet 还可以做其他的工作, 如果你只在 Manager 中自定义 QuerySet ,推荐扩展下models.QuerySet, 并在模型中定义objects = DocumentQuerySet.as_manager().

Python
 
class DocumentQuerySet(models.QuerySet):
    def pdfs(self):
        return self.filter(file_type='pdf')

    def smaller_than(self, size):
        return self.filter(size__lt=size)

class Document(models.Model):
    name = models.CharField(max_length=30)
    size = models.PositiveIntegerField(default=0)
    file_type = models.CharField(max_length=10, blank=True)

    objects = DocumentQuerySet.as_manager()

自定义的 Manager 代码, 你可以写在models.py, 但随着代码库的增长, 我更加推荐你将定义的QuerySetsManagers保存名为managers.py文件中.

© JackeyGao.io 2018.