详解Django的 prefetch_related() 函数：对关联对象进行预取

2023年3月23日下午5:15 • Django函数大全

1. 什么是prefetch_related()函数

1.1 作用

prefetch_related()函数是Django ORM提供的用于表关联查询时减少查询次数的一个函数。当我们查询一个Model时，如果和其他Model有外键或多对多关系，那么默认情况下，Django ORM会分别查询这些关联的Model，这样很容易出现查询次数过多的问题。prefetch_related()的作用是把需要查询的关联Model都一次性查询出来，可以有效减少查询次数，提高性能。

1.2 使用方法

使用prefetch_related()函数需要满足以下条件：

当前Model必须有关联的其他Model
必须有外键或多对多关系

下面是使用prefetch_related()函数的基本语法：

Model.objects.prefetch_related('related_model1', 'related_model2', ...)

需要注意的是，prefetch_related()函数只能对关联的外键或多对多关系进行查询，不能对一对一关系进行查询。

2. prefetch_related()函数的使用示例

下面我们看两个实例来讲解prefetch_related()函数的使用方法和效果。

2.1 一对多示例

假设我们有两个Model，一个是Author（作者），另一个是Book（书籍），Author和Book之间是一对多的关系。我们现在要查询Author和他的所有Book，这时默认情况下，Django ORM会先查询Author，然后再为Author的每一本Book分别查询一次Book的信息。这样就会造成连续多次查询的情况，十分浪费时间和资源，在数据量大的情况下可能会导致网站卡顿或者无响应。下面是代码实现：

class Author(models.Model):
    name = models.CharField(max_length=100)

class Book(models.Model):
    name = models.CharField(max_length=100)
    author = models.ForeignKey(Author, on_delete=models.CASCADE)

查询Author和他所有的Book信息：

authors = Author.objects.all()
for author in authors:
    print(author.name, [b.name for b in author.book_set.all()])

使用prefetch_related()函数来查询Author以及他的所有Book信息：

authors = Author.objects.prefetch_related('book_set').all()
for author in authors:
    print(author.name, [b.name for b in author.book_set.all()])

可以看到，虽然使用prefetch_related()函数可以减小查询次数，但是并没有减小多少时间，因为在这个例子中，一本书的信息只包含一个作者的信息。如果需要查询的信息跨度更大，prefetch_related()函数的效果会更加明显。

2.2 多对多示例

现在我们有两个Model，一个是Student（学生），另一个是Class（班级），每个Student可能有多个Class，每个Class也可能有多个Student，这是一个典型的多对多关系。默认情况下，我们如果需要查询学生以及他参加的所有班级，需要先查询每个学生，然后再查询他的所有参加的班级信息。这很容易导致多次查询，从而影响性能。下面是代码实现：

class Student(models.Model):
    name = models.CharField(max_length=100)
    classes = models.ManyToManyField('Class')

class Class(models.Model):
    name = models.CharField(max_length=100)

查询学生以及他参加的所有班级：

students = Student.objects.all()
for student in students:
    print(student.name, [c.name for c in student.classes.all()])

使用prefetch_related()函数来查询学生以及他参加的所有班级：

students = Student.objects.prefetch_related('classes').all()
for student in students:
    print(student.name, [c.name for c in student.classes.all()])

结果显示，使用prefetch_related()函数可以大大减少多次查询的次数。