博客

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

  • Post category:Python

prefetch_related()是Django ORM提供的一个高效查询优化工具，它可以通过预先获取与查询集相关联的外键或者多对多关系的数据，减少数据库的查询次数，优化查询效率，提高网站的响应速度。下面我们来详细讲解Django的prefetch_related()函数的作用与使用方法。

prefetch_related()函数的作用

Django的ORM是基于懒加载机制实现的，也就是说，在默认情况下，一条查询语句只会查询出主对象的信息，而不会查询出与之相关联的外键或多对多关联对象的信息。这种懒加载机制在一定程度上减少了内存占用和查询的时间，同时，也增加了程序的复杂度和开发难度。例如，你想查询一个宠物店的所有宠物和宠主信息，需要用到如下代码：

class Owner(models.Model):
    name = models.CharField(max_length=100)
    age = models.IntegerField()

class Pet(models.Model):
    name = models.CharField(max_length=100)
    kind = models.CharField(max_length=100)
    owner = models.ForeignKey(Owner, on_delete=models.CASCADE)

owners = Owner.objects.all()
pets = [owner.pet_set.filter() for owner in owners]

这段代码使用了两条查询语句分别获取了所有的宠主和他们的所有宠物信息。尽管它们都是关联查询，但是它们依然是两个查询，因此在处理某些数据集的时候，获取外键或者多对多关系的数据会变得非常耗时和低效。而这时，prefetch_related()函数就可以很好地解决这个问题。

prefetch_related的使用方法

prefetch_related()函数作用是获取与查询集相关联的外键或多对多关系的数据，具体使用方法如下：

  1. 简单用法
queryset.prefetch_related('relation_name')

prefetch_related()方法中接收参数为用逗号分隔的外键或多对多关系字段名称字符串，支持多个字段同时查询。例如，如果我们想查询所有的宠主信息和他们所有的宠物信息，我们可以按照如下方式实现：

owners = Owner.objects.prefetch_related('pet_set').all()

这样就可以快速地获取所有宠主和宠物信息，而不用像之前那样需要使用for循环执行多次数据库查询了。

  1. 多级关联查询

如果要进行多层级关联查询，则需要使用双下划线，例如：

queryset.prefetch_related('relation_name__second_relation_name')

例如，我们现在想查询宠物店的所有宠物、宠主及宠主所属的城市，可以这样做：

owners = Owner.objects.prefetch_related('pet_set', 'city').all()

这样就可以获取到所有宠物、宠主及宠主所属的城市的信息，而且只需要两条查询语句。

prefetch_related的实例

下面两个实例演示了使用prefetch_related()函数进行优化查询所带来的效果：

  1. 帖子查询

我们有如下的两个模型：

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

class Post(models.Model):
    title = models.CharField(max_length=400)
    author = models.ForeignKey(Author, on_delete=models.CASCADE, related_name='author_post', db_index=True)
    tags = models.ManyToManyField("Tag", related_name='post_tag', db_index=True)

class Tag(models.Model):
    tag_name = models.CharField(max_length=50, db_index=True)

这三个模型中Post和Tag模型之间是多对多关系，Post和Author模型之间是一对多关系。现在我们需要查询所有带有标签名为'Python'的帖子的作者信息，可以这样实现：

authors = Author.objects.filter(author_post__tags__tag_name='Python')

但是这种方法并没有获取到该作者的所有帖子，如果需要获取该作者的所有帖子，可以在查询时使用prefetch_related()函数，可以避免执行多次查询语句，代码如下：

authors = Author.objects.filter(author_post__tags__tag_name='Python').prefetch_related('author_post')
  1. 评论查询

我们有一个Comment模型，这个模型有两个外键，一个外键是指向Post类的，另一个外键是指向Reply类的，如下所示：

class Post(models.Model):
    title = models.CharField(max_length=100)
    content = models.TextField()

class Comment(models.Model):
    post = models.ForeignKey(Post, on_delete=models.CASCADE, related_name='post_comment')
    reply = models.ForeignKey('self', on_delete=models.SET_NULL, null=True, blank=True, related_name='comment_reply',
                                db_index=True)  # 回复别人的Id
    content = models.TextField()

现在我们要查询所有的评论及其回复信息，可以按照如下代码使用prefetch_related()函数：

comments = Comment.objects.all().prefetch_related('comment_reply')

这样就能获取到所有评论及其对应的回复信息了。

总的来说，使用prefetch_related()函数能够让程序在查询时更加高效快捷，减少不必要的数据库查询次数，提高程序性能。

Tags: