用实例详解Python中的Django框架中prefetch_related()函数对数据库查询的优化

实例的背景说明

假定一个个人信息系统，需要记录系统中各个人的故乡、居住地、以及到过的城市。数据库设计如下：

models.py 内容如下：
 

from django.db import models
 
class province(models.model):
 name = models.charfield(max_length=10)
 def __unicode__(self):
  return self.name
 
class city(models.model):
 name = models.charfield(max_length=5)
 province = models.foreignkey(province)
 def __unicode__(self):
  return self.name
 
class person(models.model):
 firstname = models.charfield(max_length=10)
 lastname = models.charfield(max_length=10)
 visitation = models.manytomanyfield(city, related_name = "visitor")
 hometown = models.foreignkey(city, related_name = "birth")
 living  = models.foreignkey(city, related_name = "citizen")
 def __unicode__(self):
  return self.firstname + self.lastname

注1：创建的app名为“qsoptimize”

注2：为了简化起见，`qsoptimize_province` 表中只有2条数据：湖北省和广东省，`qsoptimize_city`表中只有三条数据：武汉市、十堰市和广州市

prefetch_related()

对于多对多字段（manytomanyfield）和一对多字段，可以使用prefetch_related()来进行优化。或许你会说，没有一个叫onetomanyfield的东西啊。实际上 ，foreignkey就是一个多对一的字段，而被foreignkey关联的字段就是一对多字段了。

 
作用和方法

prefetch_related()和select_related()的设计目的很相似，都是为了减少sql查询的数量，但是实现的方式不一样。后者是通过join语句，在sql查询内解决问题。但是对于多对多关系，使用sql语句解决就显得有些不太明智，因为join得到的表将会很长，会导致sql语句运行时间的增加和内存占用的增加。若有n个对象，每个对象的多对多字段对应mi条，就会生成σ(n)mi 行的结果表。

prefetch_related()的解决方法是，分别查询每个表，然后用python处理他们之间的关系。继续以上边的例子进行说明，如果我们要获得张三所有去过的城市，使用prefetch_related()应该是这么做：
 

>>> zhangs = person.objects.prefetch_related('visitation').get(firstname=u"张",lastname=u"三")
>>> for city in zhangs.visitation.all() :
...  print city
...

上述代码触发的sql查询如下：
 

select `qsoptimize_person`.`id`, `qsoptimize_person`.`firstname`,
`qsoptimize_person`.`lastname`, `qsoptimize_person`.`hometown_id`, `qsoptimize_person`.`living_id`
from `qsoptimize_person`
where (`qsoptimize_person`.`lastname` = '三' and `qsoptimize_person`.`firstname` = '张');
 
select (`qsoptimize_person_visitation`.`person_id`) as `_prefetch_related_val`, `qsoptimize_city`.`id`,
`qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where `qsoptimize_person_visitation`.`person_id` in (1);

第一条sql查询仅仅是获取张三的person对象，第二条比较关键，它选取关系表`qsoptimize_person_visitation`中`person_id`为张三的行，然后和`city`表内联（inner join 也叫等值连接）得到结果表。
 

+----+-----------+----------+-------------+-----------+
| id | firstname | lastname | hometown_id | living_id |
+----+-----------+----------+-------------+-----------+
| 1 | 张    | 三    |      3 |     1 |
+----+-----------+----------+-------------+-----------+
1 row in set (0.00 sec)
 
+-----------------------+----+-----------+-------------+
| _prefetch_related_val | id | name   | province_id |
+-----------------------+----+-----------+-------------+
|           1 | 1 | 武汉市  |      1 |
|           1 | 2 | 广州市  |      2 |
|           1 | 3 | 十堰市  |      1 |
+-----------------------+----+-----------+-------------+
3 rows in set (0.00 sec)

显然张三武汉、广州、十堰都去过。

又或者，我们要获得湖北的所有城市名，可以这样：
 

>>> hb = province.objects.prefetch_related('city_set').get(name__iexact=u"湖北省")
>>> for city in hb.city_set.all():
...  city.name
...

触发的sql查询：
 

select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`name` like '湖北省' ;
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
where `qsoptimize_city`.`province_id` in (1);

得到的表：
 

+----+-----------+
| id | name   |
+----+-----------+
| 1 | 湖北省  |
+----+-----------+
1 row in set (0.00 sec)
 
+----+-----------+-------------+
| id | name   | province_id |
+----+-----------+-------------+
| 1 | 武汉市  |      1 |
| 3 | 十堰市  |      1 |
+----+-----------+-------------+
2 rows in set (0.00 sec)

我们可以看见，prefetch使用的是 in 语句实现的。这样，在queryset中的对象数量过多的时候，根据数据库特性的不同有可能造成性能问题。

 
使用方法
*lookups 参数

prefetch_related()在django < 1.7 只有这一种用法。和select_related()一样，prefetch_related()也支持深度查询，例如要获得所有姓张的人去过的省：
 

>>> zhangs = person.objects.prefetch_related('visitation__province').filter(firstname__iexact=u'张')
>>> for i in zhangs:
...  for city in i.visitation.all():
...   print city.province
...

触发的sql：
 

select `qsoptimize_person`.`id`, `qsoptimize_person`.`firstname`,
`qsoptimize_person`.`lastname`, `qsoptimize_person`.`hometown_id`, `qsoptimize_person`.`living_id`
from `qsoptimize_person`
where `qsoptimize_person`.`firstname` like '张' ;
 
select (`qsoptimize_person_visitation`.`person_id`) as `_prefetch_related_val`, `qsoptimize_city`.`id`,
`qsoptimize_city`.`name`, `qsoptimize_city`.`province_id` from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where `qsoptimize_person_visitation`.`person_id` in (1, 4);
 
select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`id` in (1, 2);

获得的结果：
 

+----+-----------+----------+-------------+-----------+
| id | firstname | lastname | hometown_id | living_id |
+----+-----------+----------+-------------+-----------+
| 1 | 张    | 三    |      3 |     1 |
| 4 | 张    | 六    |      2 |     2 |
+----+-----------+----------+-------------+-----------+
2 rows in set (0.00 sec)
 
+-----------------------+----+-----------+-------------+
| _prefetch_related_val | id | name   | province_id |
+-----------------------+----+-----------+-------------+
|           1 | 1 | 武汉市  |      1 |
|           1 | 2 | 广州市  |      2 |
|           4 | 2 | 广州市  |      2 |
|           1 | 3 | 十堰市  |      1 |
+-----------------------+----+-----------+-------------+
4 rows in set (0.00 sec)
 
+----+-----------+
| id | name   |
+----+-----------+
| 1 | 湖北省  |
| 2 | 广东省  |
+----+-----------+
2 rows in set (0.00 sec)

值得一提的是，链式prefetch_related会将这些查询添加起来，就像1.7中的select_related那样。

要注意的是，在使用queryset的时候，一旦在链式操作中改变了数据库请求，之前用prefetch_related缓存的数据将会被忽略掉。这会导致django重新请求数据库来获得相应的数据，从而造成性能问题。这里提到的改变数据库请求指各种filter()、exclude()等等最终会改变sql代码的操作。而all()并不会改变最终的数据库请求，因此是不会导致重新请求数据库的。

举个例子，要获取所有人访问过的城市中带有“市”字的城市，这样做会导致大量的sql查询：
 

plist = person.objects.prefetch_related('visitation')
[p.visitation.filter(name__icontains=u"市") for p in plist]

因为数据库中有4人，导致了2+4次sql查询：
 

select `qsoptimize_person`.`id`, `qsoptimize_person`.`firstname`, `qsoptimize_person`.`lastname`,
`qsoptimize_person`.`hometown_id`, `qsoptimize_person`.`living_id`
from `qsoptimize_person`;
 
select (`qsoptimize_person_visitation`.`person_id`) as `_prefetch_related_val`, `qsoptimize_city`.`id`,
`qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where `qsoptimize_person_visitation`.`person_id` in (1, 2, 3, 4);
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where(`qsoptimize_person_visitation`.`person_id` = 1 and `qsoptimize_city`.`name` like '%市%' );
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where (`qsoptimize_person_visitation`.`person_id` = 2 and `qsoptimize_city`.`name` like '%市%' );
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where (`qsoptimize_person_visitation`.`person_id` = 3 and `qsoptimize_city`.`name` like '%市%' );
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
inner join `qsoptimize_person_visitation` on (`qsoptimize_city`.`id` = `qsoptimize_person_visitation`.`city_id`)
where (`qsoptimize_person_visitation`.`person_id` = 4 and `qsoptimize_city`.`name` like '%市%' );

详细分析一下这些请求事件。

众所周知，queryset是lazy的，要用的时候才会去访问数据库。运行到第二行python代码时，for循环将plist看做iterator，这会触发数据库查询。最初的两次sql查询就是prefetch_related导致的。

虽然已经查询结果中包含所有所需的city的信息，但因为在循环体中对person.visitation进行了filter操作，这显然改变了数据库请求。因此这些操作会忽略掉之前缓存到的数据，重新进行sql查询。

但是如果有这样的需求了应该怎么办呢？在django >= 1.7，可以通过下一节的prefetch对象来实现，如果你的环境是django < 1.7，可以在python中完成这部分操作。
 

plist = person.objects.prefetch_related('visitation')
[[city for city in p.visitation.all() if u"市" in city.name] for p in plist]

prefetch 对象

在django >= 1.7，可以用prefetch对象来控制prefetch_related函数的行为。

注：由于我没有安装1.7版本的django环境，本节内容是参考django文档写的，没有进行实际的测试。

prefetch对象的特征：

•     一个prefetch对象只能指定一项prefetch操作。
•     prefetch对象对字段指定的方式和prefetch_related中的参数相同，都是通过双下划线连接的字段名完成的。
•     可以通过 queryset 参数手动指定prefetch使用的queryset。
•     可以通过 to_attr 参数指定prefetch到的属性名。
•     prefetch对象和字符串形式指定的lookups参数可以混用。

继续上面的例子，获取所有人访问过的城市中带有“武”字和“州”的城市：
 

wus = city.objects.filter(name__icontains = u"武")
zhous = city.objects.filter(name__icontains = u"州")
plist = person.objects.prefetch_related(
  prefetch('visitation', queryset = wus, to_attr = "wu_city"),
  prefetch('visitation', queryset = zhous, to_attr = "zhou_city"),)
[p.wu_city for p in plist]
[p.zhou_city for p in plist]

注：这段代码没有在实际环境中测试过，若有不正确的地方请指正。

顺带一提，prefetch对象和字符串参数可以混用。
none

可以通过传入一个none来清空之前的prefetch_related。就像这样：

>>> prefetch_cleared_qset = qset.prefetch_related(none)

小结

1.     prefetch_related主要针一对多和多对多关系进行优化。
2.     prefetch_related通过分别获取各个表的内容，然后用python处理他们之间的关系来进行优化。
3.     可以通过可变长参数指定需要select_related的字段名。指定方式和特征与select_related是相同的。
4.     在django >= 1.7可以通过prefetch对象来实现复杂查询，但低版本的django好像只能自己实现。
5.     作为prefetch_related的参数，prefetch对象和字符串可以混用。
6.     prefetch_related的链式调用会将对应的prefetch添加进去，而非替换，似乎没有基于不同版本上区别。
7.     可以通过传入none来清空之前的prefetch_related。