Python的Django框架中的select_related函数对QuerySet 查询的优化

1. 实例的背景说明

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

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`表中只有三条数据：武汉市、十堰市和广州市
2. select_related()

对于一对一字段（onetoonefield）和外键字段（foreignkey），可以使用select_related 来对queryset进行优化
作用和方法

在对queryset使用select_related()函数后，django会获取相应外键对应的对象，从而在之后需要的时候不必再查询数据库了。以上例说明，如果我们需要打印数据库中的所有市及其所属省份，最直接的做法是：
 

>>> citys = city.objects.all()
>>> for c in citys:
...  print c.province
...

这样会导致线性的sql查询，如果对象数量n太多，每个对象中有k个外键字段的话，就会导致n*k+1次sql查询。在本例中，因为有3个city对象就导致了4次sql查询：
 

select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`
from `qsoptimize_city`
 
select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`id` = 1 ;
 
select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`id` = 2 ;
 
select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`id` = 1 ;

注：这里的sql语句是直接从django的logger:‘django.db.backends'输出出来的

如果我们使用select_related()函数：
 

>>> citys = city.objects.select_related().all()
>>> for c in citys:
...  print c.province
...

就只有一次sql查询，显然大大减少了sql查询的次数：
 

select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`,
`qsoptimize_city`.`province_id`, `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from`qsoptimize_city`
inner join `qsoptimize_province` on (`qsoptimize_city`.`province_id` = `qsoptimize_province`.`id`) ;

这里我们可以看到，django使用了inner join来获得省份的信息。顺便一提这条sql查询得到的结果如下：
 

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

 
使用方法
函数支持如下三种用法：
*fields 参数

select_related() 接受可变长参数，每个参数是需要获取的外键（父表的内容）的字段名，以及外键的外键的字段名、外键的外键的外键…。若要选择外键的外键需要使用两个下划线“__”来连接。

例如我们要获得张三的现居省份，可以用如下方式：
 

>>> zhangs = person.objects.select_related('living__province').get(firstname=u"张",lastname=u"三")
>>> zhangs.living.province

触发的sql查询如下：
 

select `qsoptimize_person`.`id`, `qsoptimize_person`.`firstname`,
`qsoptimize_person`.`lastname`, `qsoptimize_person`.`hometown_id`, `qsoptimize_person`.`living_id`,
`qsoptimize_city`.`id`, `qsoptimize_city`.`name`, `qsoptimize_city`.`province_id`, `qsoptimize_province`.`id`,
`qsoptimize_province`.`name`
from `qsoptimize_person`
inner join `qsoptimize_city` on (`qsoptimize_person`.`living_id` = `qsoptimize_city`.`id`)
inner join `qsoptimize_province` on (`qsoptimize_city`.`province_id` = `qsoptimize_province`.`id`)
where (`qsoptimize_person`.`lastname` = '三' and `qsoptimize_person`.`firstname` = '张' );

可以看到，django使用了2次 inner join 来完成请求，获得了city表和province表的内容并添加到结果表的相应列，这样在调用 zhangs.living的时候也不必再次进行sql查询。
 

+----+-----------+----------+-------------+-----------+----+-----------+-------------+----+-----------+
| id | firstname | lastname | hometown_id | living_id | id | name   | province_id | id | name   |
+----+-----------+----------+-------------+-----------+----+-----------+-------------+----+-----------+
| 1 | 张    | 三    |      3 |     1 | 1 | 武汉市  |  1     | 1 | 湖北省  |
+----+-----------+----------+-------------+-----------+----+-----------+-------------+----+-----------+
1 row in set (0.00 sec)

然而，未指定的外键则不会被添加到结果中。这时候如果需要获取张三的故乡就会进行sql查询了：
 

>>> zhangs.hometown.province
 
select `qsoptimize_city`.`id`, `qsoptimize_city`.`name`,
`qsoptimize_city`.`province_id`
from `qsoptimize_city`
where `qsoptimize_city`.`id` = 3 ;
 
select `qsoptimize_province`.`id`, `qsoptimize_province`.`name`
from `qsoptimize_province`
where `qsoptimize_province`.`id` = 1

同时，如果不指定外键，就会进行两次查询。如果深度更深，查询的次数更多。

值得一提的是，从django 1.7开始，select_related()函数的作用方式改变了。在本例中，如果要同时获得张三的故乡和现居地的省份，在1.7以前你只能这样做：
 

>>> zhangs = person.objects.select_related('hometown__province','living__province').get(firstname=u"张",lastname=u"三")
>>> zhangs.hometown.province
>>> zhangs.living.province

但是1.7及以上版本，你可以像和queryset的其他函数一样进行链式操作：
 

>>> zhangs = person.objects.select_related('hometown__province').select_related('living__province').get(firstname=u"张",lastname=u"三")
>>> zhangs.hometown.province
>>> zhangs.living.province

如果你在1.7以下版本这样做了，你只会获得最后一个操作的结果，在本例中就是只有现居地而没有故乡。在你打印故乡省份的时候就会造成两次sql查询。
depth 参数

select_related() 接受depth参数，depth参数可以确定select_related的深度。django会递归遍历指定深度内的所有的onetoonefield和foreignkey。以本例说明：
 

>>> zhangs = person.objects.select_related(depth = d)

d=1  相当于 select_related(‘hometown','living')

d=2  相当于 select_related(‘hometown__province','living__province')
无参数

select_related() 也可以不加参数，这样表示要求django尽可能深的select_related。例如：zhangs = person.objects.select_related().get(firstname=u”张”,lastname=u”三”)。但要注意两点：

    django本身内置一个上限，对于特别复杂的表关系，django可能在你不知道的某处跳出递归，从而与你想的做法不一样。具体限制是怎么工作的我表示不清楚。
    django并不知道你实际要用的字段有哪些，所以会把所有的字段都抓进来，从而会造成不必要的浪费而影响性能。

 
小结

1.     select_related主要针一对一和多对一关系进行优化。
2.     select_related使用sql的join语句进行优化，通过减少sql查询的次数来进行优化、提高性能。
3.     可以通过可变长参数指定需要select_related的字段名。也可以通过使用双下划线“__”连接字段名来实现指定的递归查询。没有指定的字段不会缓存，没有指定的深度不会缓存，如果要访问的话django会再次进行sql查询。
4.     也可以通过depth参数指定递归的深度，django会自动缓存指定深度内所有的字段。如果要访问指定深度外的字段，django会再次进行sql查询。
5.     也接受无参数的调用，django会尽可能深的递归查询所有的字段。但注意有django递归的限制和性能的浪费。
6.     django >= 1.7，链式调用的select_related相当于使用可变长参数。django < 1.7，链式调用会导致前边的select_related失效，只保留最后一个。