(总结)Django 高性能ORM 查询优化

导读

本文着重讲解对 Django ORM 操作的优化 以及 提高效率的常用方法

好文章 记得收藏+点赞+关注额 ！！！

---- Nick.Peng

一、QuerySet

1.1 可切片

使用 Python 的切片语法来限制查询集记录的数目 。它等同于 SQL 的LIMIT 和OFFSET 子句。

>>> Author.objects.all()[:5]      # (LIMIT 5)
>>> Author.objects.all()[5:10]    # (OFFSET 5 LIMIT 5)

但是不支持负的索引（例如：Author.objects.all()[-1]）。通常：查询集 的切片返回一个新的查询集 ，它不会执行数据库查询。

1.2 可迭代

authors = models.Author.objects.all()

for author in authors:
	print(author.name)
	

1.3 惰性查询

查询集 是惰性执行的 —— 创建查询集不会带来任何数据库的访问。直到查询集 需要求值时，Django 才会真正运行这个查询。

queryResult = models.Author.objects.all()	# 此时并没有操作数据库
 
print(queryResult)			 				# 调用时才执行查询操作
for article in queryResult:
    print(article.title)    				# 调用时才执行查询操作
    

一般来说，只有在“请求”查询集的结果时才会到数据库中去获取它们。当你确实需要结果时，查询集通过访问数据库来求值。

1.4 缓存机制（重点）

每个查询集都包含一个缓存来最小化对数据库的访问。它可以使得我们写出更高效的代码。

在一个新创建的查询集中，缓存为空。首次对查询集进行求值 —— 同时发生数据库查询 ——Django 将保存查询的结果到查询集的缓存中并返回明确请求的结果（例如，如果正在迭代查询集，则返回下一个结果）。接下来对该查询集 的求值将重用缓存的结果。下面举例说明：

案例一：

print([a.name for a in Author.objects.all()])
print([a.release_date for a in Author.objects.all()])

解析：

• 上述这意味着相同的数据库查询将执行两次，显然增加了数据库负载。
• 同时，还有可能两个结果列表并不包含相同的数据库记录，因为在两次请求期间有可能有添加或删除操作。为了避免这个问题，只需保存查询集并重新使用它即可，见案例二：

案例二：

queryResult = Author.objects.all()		# 保存查询集并重复使用它
print([a.name for a in queryResult])
print([a.release_date for a in queryResult])

1.5 何时查询集不会被缓存?

查询集不会永远缓存它们的结果。当只对查询集的部分进行求值时会检查缓存， 如果这个部分不在缓存中，那么接下来查询返回的记录都将不会被缓存。所以，这意味着使用切片或索引来限制查询集将不会填充缓存。

• 重复对查询集对象进行切片操作，将 每次都查询数据库，如下 ：

queryset = Author.objects.all()
print(queryset[5]) 		# 首次 执行查询数据库
print(queryset[5])		# 再次 执行查询数据库

• 然而，如果已经对全部查询集求值过，则将检查并执行缓存，如下：

queryset = Author.objects.all()
qs_list = [author for author in queryset] 		# 执行查询数据库
print(qs_list[5])					# 使用缓存
print(qs_list[5]) 					# 使用缓存

• 可将全部查询集求值并填充到缓存中常见方法：

# 方法1：
[author for author in queryset]
# 方法2：
bool(queryset)
# 方法3：
author in queryset
# 方法4：
list(queryset)

• 注意： 简单地打印查询集是不会填充缓存的。

queryResult=models.Article.objects.all()
print(queryResult) 		# 执行查询数据库
print(queryResult) 		# 执行查询数据库

二、exists() 与 iterator() 方法（重点）

2.1 exists

简单的使用if语句进行判断也会完全执行整个queryset并且把数据放入cache，虽然你并不需要这些 数据！为了避免这个，可以用exists()方法来检查是否有数据：

if queryResult.exists():
    print("exists...")

2.2 iterator

当queryset非常巨大时，cache就会成为问题。
当处理成千上万的记录时，将它们一次装入内存是很浪费的。更糟糕的是，巨大的queryset可能会锁住系统进程，让你的程序濒临崩溃。要避免在遍历数据的同时产生queryset cache，可以使用iterator()方法 来获取数据，处理完数据就将其丢弃。

objs = Book.objects.all().iterator()
# iterator() 可以一次只从数据库获取少量数据，这样可以节省内存
for obj in objs:
    print(obj.title)
# 当你再次遍历时，没有打印结果，因为迭代器已经在上一次遍历(next)到最后一次了，没得遍历了
for obj in objs:
    print(obj.title)

当然，使用iterator()方法来防止生成cache，意味着遍历同一个queryset时会重复执行查询。所以使用iterator()的时候要当心，确保你的代码在操作一个大的queryset时没有重复执行查询。

2.3 总结:

• queryset的cache是用于减少程序对数据库的查询，在通常的使用下会保证只有在需要的时候才会查询数据库。
• 使用exists()和iterator()方法可以优化程序对内存的使用。不过，由于它们并不会生成queryset cache，可能 会造成额外的数据库查询。
  
  

三、查询优化（重点）

3.1 select_related(基于连表查询，一对一/多外键)

3.1.1 一对一简单使用

• 对于一对一字段（OneToOneField）和外键字段（ForeignKey），可以使用select_related来对QuerySet进行优化。
• select_related 返回一个QuerySet，当执行它的查询时，它沿着外键关系查询关联的对象的数据。它会生成一个复杂的查询并引起性能的损耗，但是在以后使用外键关系时将不需要数据库查询。
• 简单说，在对QuerySet使用select_related()函数后，Django会获取相应外键对应的对象，从而在之后需要的时候不必再查询数据库了。

下面的例子解释了普通查询和select_related() 查询的区别。

• 查询id=2的文章的分类名称,下面是一个标准的查询：

# Hits the database.
book = Book.objects.get(id=2)
# Hits the database again to get the related Blog object.
print(book.category.title)

• 对应SQL：

SELECT
    "blog_article"."id",
    "blog_article"."title",
    "blog_article"."desc",
    "blog_article"."read_count",
    "blog_article"."comment_count",
    "blog_article"."up_count",
    "blog_article"."down_count",
    "blog_article"."category_id",
    "blog_article"."create_time",
    "blog_article"."blog_id",
    "blog_article"."article_type_id"
             FROM "blog_article"
             WHERE "blog_article"."id" = 2; args=(2,)

SELECT
     "blog_category"."id",
     "blog_category"."title",
     "blog_category"."blog_id"
              FROM "blog_category"
              WHERE "blog_category"."id" = 4; args=(4,)
              

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

books = Book.objects.select_related("category").all()
for obj in books:
     #  Doesn't hit the database, because obj.category
     #  has been prepopulated in the previous query.
     print(obj.category.title)
     

• 对应SQL：

SELECT
     "blog_article"."id",
     "blog_article"."title",
     "blog_article"."desc",
     "blog_article"."read_count",
     "blog_article"."comment_count",
     "blog_article"."up_count",
     "blog_article"."down_count",
     "blog_article"."category_id",
     "blog_article"."create_time",
     "blog_article"."blog_id",
     "blog_article"."article_type_id",

     "blog_category"."id",
     "blog_category"."title",
     "blog_category"."blog_id"

FROM "blog_article"
LEFT OUTER JOIN "blog_category" ON ("blog_article"."category_id" = "blog_category"."id");

3.1.2 多外键查询

这是针对 category 的外键查询，如果是另外一个外键呢？让我们一起看下：

books = Book.objects.select_related("category").get(id=1)
print(books.bookdetail)

观察logging结果，发现依然需要查询两次，所以需要改为：

books = Book.Article.objects.select_related("category","bookdetail").get(id=1)
print(books.bookdetail)

或者：

books = Book.objects
　　　　　　　　　　　.select_related("category")
　　　　　　　　　　　.select_related("bookdetail")
　　　　　　　　　　　.get(id=1)  		# django 1.7 支持链式操作
print(books.bookdetail)

3.1.3 深层查询

# 查询id=1的文章的用户姓名
books = Book.objects.select_related("blog").get(id=1)
print(books.blog.user.username)

这是因为第一次查询没有query到userInfo表，所以，修改如下：

books = Book.objects.select_related("blog__user").get(id=1)
print(books.blog.user.username)

对应SQL：

SELECT

"blog_article"."id", "blog_article"."title",
......

 "blog_blog"."id", "blog_blog"."title",
......

 "blog_userinfo"."password", "blog_userinfo"."last_login",
......

FROM "blog_article"

INNER JOIN "blog_blog" ON ("blog_article"."blog_id" = "blog_blog"."id")

INNER JOIN "blog_userinfo" ON ("blog_blog"."user_id" = "blog_userinfo"."id")
WHERE "blog_article"."id" = 1;

3.1.4 总结：

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

3.2 prefetch_related(基于子查询，多对多/一对多)

• 对于多对多字段（ManyToManyField）和一对多字段，可以使用prefetch_related()来进行优化。
• prefetch_related()和select_related()的设计目的很相似，都是为了减少SQL查询的数量，但是实现的方式不一样。后者是通过JOIN语句，在SQL查询内解决问题。但是对于多对多关系，使用SQL语句解决就显得有些不太明智，因为JOIN得到的表将会很长，会导致SQL语句运行时间的增加和内存占用的增加。若有n个对象，每个对象的多对多字段对应Mi条，就会生成Σ(n)Mi 行的结果表。
• prefetch_related()的解决方法是，分别查询每个表，然后用Python处理他们之间的关系。

# 查询所有文章关联的所有标签
book_obj = Book.objects.all()
for i in book_obj:
    print(i.tags.all())  # 4篇文章: hits database 5

改为prefetch_related：

# 查询所有文章关联的所有标签
book_obj = Book.objects.prefetch_related("tags").all()
for i in book_obj:
    print(i.tags.all())  # 4篇文章: hits database 2

对应SQL：

SELECT "blog_article"."nid",
               "blog_article"."title",
               ......
FROM "blog_article";

SELECT
  ("blog_article2tag"."article_id") AS "_prefetch_related_val_article_id",
  "blog_tag"."nid",
  "blog_tag"."title",
  "blog_tag"."blog_id"
   FROM "blog_tag"
  INNER JOIN "blog_article2tag" ON ("blog_tag"."nid" = "blog_article2tag"."tag_id")
  WHERE "blog_article2tag"."article_id" IN (1, 2, 3, 4);

四、extra的使用

extra(select=None, where=None, params=None, 
tables=None, order_by=None, select_params=None)

• 有些情况下，Django的查询语法难以简单的表达复杂的 WHERE 子句，对于这种情况, Django 提供了 extra() QuerySet修改机制，它能在 QuerySet生成的SQL从句中注入新子句
• extra可以指定一个或多个 参数,例如 select, where or tables. 这些参数都不是必须的，但是你至少要使用一个!要注意这些额外的方式对不同的数据库引擎可能存在移植性问题.(因为你在显式的书写SQL语句),除非万不得已,尽量避免这样做

4.1 参数之select

The select 参数可以让你在 SELECT 从句中添加其他字段信息，它应该是一个字典，存放着属性名到 SQL 从句的映射。

queryResult = Book.objects.extra(select={'is_recent': "create_time > '2017-09-05'"})

结果集中每个 Entry 对象都有一个额外的属性is_recent, 它是一个布尔值，表示 Article对象的create_time 是否晚于2017-09-05.
练习：

# in sqlite:
    book_obj = Book.objects
　　　　　　　　　　　　　　.filter(nid=1)
　　　　　　　　　　　　　　.extra(select={"standard_time":"strftime('%%Y-%%m-%%d',create_time)"})
　　　　　　　　　　　　　　.values("standard_time","id","title")
    print(book_obj)
    # <QuerySet [{'title': 'MongoDb 入门教程', 'standard_time': '2017-09-03', 'id': 1}]>

4.2 参数之where / tables

您可以使用where定义显式SQL WHERE子句 - 也许执行非显式连接。您可以使用tables手动将表添加到SQL FROM子句。
where和tables都接受字符串列表。所有where参数均为“与”任何其他搜索条件。
举例来讲：

queryResult = Book.objects.extra(where=['id in (1,3) OR title like "py%" ','id>2'])

五、整体插入

创建对象时，尽可能使用bulk_create()来减少SQL查询的数量。例如：

Book.objects.bulk_create([
    Book(headline="Python 3.0 Released"),
    Book(headline="Python 3.1 Planned")
])

…更优于：

Book.objects.create(headline="Python 3.0 Released")
Book.objects.create(headline="Python 3.1 Planned")

注意该方法有很多注意事项，所以确保它适用于你的情况。
这也可以用在ManyToManyFields中，所以：

my_band.members.add(me, my_friend)

…更优于：

my_band.members.add(me)
my_band.members.add(my_friend)

…其中Bands和Book具有多对多关联。

六、中介模型

处理类似搭配 pizza 和 topping 这样简单的多对多关系时，使用标准的ManyToManyField 就可以了。但是，有时你可能需要关联数据到两个模型之间的关系上。
例如，有这样一个应用，它记录音乐家所属的音乐小组。我们可以用一个ManyToManyField 表示小组和成员之间的多对多关系。但是，有时你可能想知道更多成员关系的细节，比如成员是何时加入小组的。
对于这些情况，Django 允许你指定一个中介模型来定义多对多关系。 你可以将其他字段放在中介模型里面。源模型的ManyToManyField 字段将使用through 参数指向中介模型。对于上面的音乐小组的例子，代码如下：

from django.db import models
 
class Person(models.Model):
    name = models.CharField(max_length=128)
 
    def __str__(self):              # __unicode__ on Python 2
        return self.name
 
class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(Person, through='Membership')
 
    def __str__(self):              # __unicode__ on Python 2
        return self.name
 
class Membership(models.Model):
    person = models.ForeignKey(Person)
    group = models.ForeignKey(Group)
    date_joined = models.DateField()
    invite_reason = models.CharField(max_length=64)

既然你已经设置好ManyToManyField 来使用中介模型（在这个例子中就是Membership），接下来你要开始创建多对多关系。你要做的就是创建中介模型的实例：

>>> ringo = Person.objects.create(name="Ringo Starr")
>>> paul = Person.objects.create(name="Paul McCartney")
>>> beatles = Group.objects.create(name="The Beatles")
>>> m1 = Membership(person=ringo, group=beatles,
...     date_joined=date(1962, 8, 16),
...     invite_reason="Needed a new drummer.")
>>> m1.save()
>>> beatles.members.all()
[<Person: Ringo Starr>]
>>> ringo.group_set.all()
[<Group: The Beatles>]
>>> m2 = Membership.objects.create(person=paul, group=beatles,
...     date_joined=date(1960, 8, 1),
...     invite_reason="Wanted to form a band.")
>>> beatles.members.all()
[<Person: Ringo Starr>, <Person: Paul McCartney>]

与普通的多对多字段不同，你不能使用add、 create和赋值语句（比如，beatles.members = [...]）来创建关系：

# THIS WILL NOT WORK
>>> beatles.members.add(john)
# NEITHER WILL THIS
>>> beatles.members.create(name``=``"George Harrison"``)
# AND NEITHER WILL THIS
>>> beatles.members ``=` `[john, paul, ringo, george]

为什么不能这样做？ 这是因为你不能只创建 Person和 Group之间的关联关系，你还要指定 Membership模型中所需要的所有信息；而简单的add、create 和赋值语句是做不到这一点的。所以它们不能在使用中介模型的多对多关系中使用。此时，唯一的办法就是创建中介模型的实例。
remove()方法被禁用也是出于同样的原因。但是clear() 方法却是可用的。它可以清空某个实例所有的多对多关系：

>>> # Beatles have broken up
>>> beatles.members.clear()
>>> # Note that this deletes the intermediate model instances
>>> Membership.objects.all()
[]