实例具体解释Django的 select_related 和 prefetch_related 函数对 QuerySet 查询的优化

Posted 2020-09-11 liguangsunls

这是本系列的第二篇，内容是 prefetch_related() 函数的用途、实现途径、以及用法。

本系列的第一篇在这里

第三篇在这里

3. 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对象的特征：

1. 一个Prefetch对象仅仅能指定一项prefetch操作。

2. Prefetch对象对字段指定的方式和prefetch_related中的參数同样。都是通过双下划线连接的字段名完毕的。
3. 能够通过 queryset 參数手动指定prefetch使用的QuerySet。

4. 能够通过 to_attr 參数指定prefetch到的属性名。

5. 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。