Pycharm开发Django项目QuerySet API详细教程

QuerySet API：

我们通常做查询操作的时候，都是通过​<code>​模型名字.objects​</code>​的方式进行操作。其实​<code>​模型名字.objects​</code>​是一个​<code>​django.db.models.manager.Manager​</code>​对象，而​<code>​Manager​</code>​这个类是一个“空壳”的类，他本身是没有任何的属性和方法的。他的方法全部都是通过​<code>​Python​</code>​动态添加的方式，从​<code>​QuerySet​</code>​类中拷贝过来的。示例图如下：

所以我们如果想要学习​<code>​ORM​</code>​模型的查找操作，必须首先要学会​<code>​QuerySet​</code>​上的一些​<code>​API​</code>​的使用。

在使用​<code>​QuerySet​</code>​进行查找操作的时候，可以提供多种操作。比如过滤完后还要根据某个字段进行排序，那么这一系列的操作我们可以通过一个非常流畅的​<code>​链式调用​</code>​的方式进行。比如要从文章表中获取标题为​<code>​123​</code>​，并且提取后要将结果根据发布的时间进行排序，那么可以使用以下方式来完成：

可以看到​<code>​order_by​</code>​方法是直接在​<code>​filter​</code>​执行后调用的。这说明​<code>​filter​</code>​返回的对象是一个拥有​<code>​order_by​</code>​方法的对象。而这个对象正是一个新的​<code>​QuerySet​</code>​对象。因此可以使用​<code>​order_by​</code>​方法。

那么以下将介绍在那些会返回新的​<code>​QuerySet​</code>​对象的方法。

<code>filter</code>：将满足条件的数据提取出来，返回一个新的<code>QuerySet</code>。具体的<code>filter</code>可以提供什么条件查询。请见查询操作章节。

<code>exclude</code>：排除满足条件的数据，返回一个新的<code>QuerySet</code>。示例代码如下：

<code>Article.objects.exclude(title__contains='hello')</code>

以上代码的意思是提取那些标题不包含<code>hello</code>的图书。

<code>annotate</code>：给<code>QuerySet</code>中的每个对象都添加一个使用查询表达式（聚合函数、F表达式、Q表达式、Func表达式等）的新字段。示例代码如下：

<code>articles = Article.objects.annotate(author_name=F("author__name"))</code>

以上代码将在每个对象中都添加一个<code>author__name</code>的字段，用来显示这个文章的作者的年龄。

<code>order_by</code>：指定将查询的结果根据某个字段进行排序。如果要倒叙排序，那么可以在这个字段的前面加一个负号。示例代码如下：

<code># 根据创建的时间正序排序 articles = Article.objects.order_by("create_time") # 根据创建的时间倒序排序 articles = Article.objects.order_by("-create_time") # 根据作者的名字进行排序 articles = Article.objects.order_by("author__name") # 首先根据创建的时间进行排序，如果时间相同，则根据作者的名字进行排序 articles = Article.objects.order_by("create_time",'author__name')</code>

一定要注意的一点是，多个<code>order_by</code>，会把前面排序的规则给打乱，而使用后面的排序方式。比如以下代码：

<code>articles = Article.objects.order_by("create_time").order_by("author__name")</code>

他会根据作者的名字进行排序，而不是使用文章的创建时间。

<code>values</code>：用来指定在提取数据出来，需要提取哪些字段。默认情况下会把表中所有的字段全部都提取出来，可以使用<code>values</code>来进行指定，并且使用了<code>values</code>方法后，提取出的<code>QuerySet</code>中的数据类型不是模型，而是在<code>values</code>方法中指定的字段和值形成的字典：

<code>articles = Article.objects.values("title",'content') for article in articles: print(article)</code>

以上打印出来的<code>article</code>是类似于<code>{"title":"abc","content":"xxx"}</code>的形式。

如果在<code>values</code>中没有传递任何参数，那么将会返回这个恶模型中所有的属性。

<code>values_list</code>：类似于<code>values</code>。只不过返回的<code>QuerySet</code>中，存储的不是字典，而是元组。示例代码如下：

<code>articles = Article.objects.values_list("id","title") print(articles)</code>

那么在打印<code>articles</code>后，结果为<code>&lt;QuerySet [(1,'abc'),(2,'xxx'),...]&gt;</code>等。

如果在<code>values_list</code>中只有一个字段。那么你可以传递<code>flat=True</code>来将结果扁平化。示例代码如下：

<code>articles1 = Article.objects.values_list("title") &gt;&gt; &lt;QuerySet [( "abc",),("xxx",),...]&gt; articles2 = Article.objects.values_list( "title",flat=True) &gt;&gt; &lt;QuerySet [ "abc",'xxx',...]&gt;</code>

<code>all</code>：获取这个<code>ORM</code>模型的<code>QuerySet</code>对象。

<code>select_related</code>：在提取某个模型的数据的同时，也提前将相关联的数据提取出来。比如提取文章数据，可以使用<code>select_related</code>将<code>author</code>信息提取出来，以后再次使用<code>article.author</code>的时候就不需要再次去访问数据库了。可以减少数据库查询的次数。示例代码如下：

<code>article = Article.objects.get(pk=1) &gt;&gt; article.author # 重新执行一次查询语句 article = Article.objects.select_related("author").get(pk=2) &gt;&gt; article.author # 不需要重新执行查询语句了</code>

<code>select_related</code>只能用在<code>一对多</code>或者<code>一对一</code>中，不能用在<code>多对多</code>或者<code>多对一</code>中。比如可以提前获取文章的作者，但是不能通过作者获取这个作者的文章，或者是通过某篇文章获取这个文章所有的标签。

<code>prefetch_related</code>：这个方法和<code>select_related</code>非常的类似，就是在访问多个表中的数据的时候，减少查询的次数。这个方法是为了解决<code>多对一</code>和<code>多对多</code>的关系的查询问题。比如要获取标题中带有<code>hello</code>字符串的文章以及他的所有标签，示例代码如下：

<code>from django.db import connection articles = Article.objects.prefetch_related( "tag_set").filter(title__contains='hello') print(articles.query) # 通过这条命令查看在底层的SQL语句 for article in articles: print( "title:",article.title) print(article.tag_set.all()) # 通过以下代码可以看出以上代码执行的sql语句 for sql in connection.queries: print(sql)</code>

但是如果在使用<code>article.tag_set</code>的时候，如果又创建了一个新的<code>QuerySet</code>那么会把之前的<code>SQL</code>优化给破坏掉。比如以下代码：

<code>tags = Tag.obejcts.prefetch_related("articles") for tag in tags: articles = tag.articles.filter(title__contains= 'hello') #因为filter方法会重新生成一个QuerySet，因此会破坏掉之前的sql优化 # 通过以下代码，我们可以看到在使用了filter的，他的sql查询会更多，而没有使用filter的，只有两次sql查询 for sql in connection.queries: print(sql)</code>

那如果确实是想要在查询的时候指定过滤条件该如何做呢，这时候我们可以使用<code>django.db.models.Prefetch</code>来实现，<code>Prefetch</code>这个可以提前定义好<code>queryset</code>。示例代码如下：

<code>tags = Tag.objects.prefetch_related(Prefetch("articles",queryset=Article.objects.filter(title__contains='hello'))).all() for tag in tags: articles = tag.articles.all() for article in articles: print(article) for sql in connection.queries: print( '='*30) print(sql)</code>

因为使用了<code>Prefetch</code>，即使在查询文章的时候使用了<code>filter</code>，也只会发生两次查询操作。

<code>defer</code>：在一些表中，可能存在很多的字段，但是一些字段的数据量可能是比较庞大的，而此时你又不需要，比如我们在获取文章列表的时候，文章的内容我们是不需要的，因此这时候我们就可以使用<code>defer</code>来过滤掉一些字段。这个字段跟<code>values</code>有点类似，只不过<code>defer</code>返回的不是字典，而是模型。示例代码如下：

<code>articles = list(Article.objects.defer("title")) for sql in connection.queries: print( '='*30) print(sql)</code>

在看以上代码的<code>sql</code>语句，你就可以看到，查找文章的字段，除了<code>title</code>，其他字段都查找出来了。当然，你也可以使用<code>article.title</code>来获取这个文章的标题，但是会重新执行一个查询的语句。示例代码如下：

<code>articles = list(Article.objects.defer("title")) for article in articles: # 因为在上面提取的时候过滤了title # 这个地方重新获取title，将重新向数据库中进行一次查找操作 print(article.title) for sql in connection.queries: print( '='*30) print(sql)</code>

<code>defer</code>虽然能过滤字段，但是有些字段是不能过滤的，比如<code>id</code>，即使你过滤了，也会提取出来。

<code>only</code>：跟<code>defer</code>类似，只不过<code>defer</code>是过滤掉指定的字段，而<code>only</code>是只提取指定的字段。

<code>get</code>：获取满足条件的数据。这个函数只能返回一条数据，并且如果给的条件有多条数据，那么这个方法会抛出<code>MultipleObjectsReturned</code>错误，如果给的条件没有任何数据，那么就会抛出<code>DoesNotExit</code>错误。所以这个方法在获取数据的只能，只能有且只有一条。

<code>create</code>：创建一条数据，并且保存到数据库中。这个方法相当于先用指定的模型创建一个对象，然后再调用这个对象的<code>save</code>方法。示例代码如下：

<code>article = Article(title='abc') article.save() # 下面这行代码相当于以上两行代码 article = Article.objects.create(title='abc')</code>

<code>get_or_create</code>：根据某个条件进行查找，如果找到了那么就返回这条数据，如果没有查找到，那么就创建一个。示例代码如下：

<code>obj,created= Category.objects.get_or_create(title='默认分类')</code>

如果有标题等于<code>默认分类</code>的分类，那么就会查找出来，如果没有，则会创建并且存储到数据库中。

这个方法的返回值是一个元组，元组的第一个参数<code>obj</code>是这个对象，第二个参数<code>created</code>代表是否创建的。

<code>bulk_create</code>：一次性创建多个数据。示例代码如下：

<code>Tag.objects.bulk_create([ Tag(name= '111'), Tag(name= '222'), ])</code>

<code>count</code>：获取提取的数据的个数。如果想要知道总共有多少条数据，那么建议使用<code>count</code>，而不是使用<code>len(articles)</code>这种。因为<code>count</code>在底层是使用<code>select count(*)</code>来实现的，这种方式比使用<code>len</code>函数更加的高效。

<code>first</code>和<code>last</code>：返回<code>QuerySet</code>中的第一条和最后一条数据。

<code>aggregate</code>：使用聚合函数。

<code>exists</code>：判断某个条件的数据是否存在。如果要判断某个条件的元素是否存在，那么建议使用<code>exists</code>，这比使用<code>count</code>或者直接判断<code>QuerySet</code>更有效得多。示例代码如下：

<code>if Article.objects.filter(title__contains='hello').exists(): print( True) 比使用count更高效： if Article.objects.filter(title__contains='hello').count() &gt; 0: print( True) 也比直接判断QuerySet更高效： if Article.objects.filter(title__contains='hello'): print( True)</code>

<code>distinct</code>：去除掉那些重复的数据。这个方法如果底层数据库用的是<code>MySQL</code>，那么不能传递任何的参数。比如想要提取所有销售的价格超过80元的图书，并且删掉那些重复的，那么可以使用<code>distinct</code>来帮我们实现，示例代码如下：

<code>books = Book.objects.filter(bookorder__price__gte=80).distinct()</code>

需要注意的是，如果在<code>distinct</code>之前使用了<code>order_by</code>，那么因为<code>order_by</code>会提取<code>order_by</code>中指定的字段，因此再使用<code>distinct</code>就会根据多个字段来进行唯一化，所以就不会把那些重复的数据删掉。示例代码如下：

<code>orders = BookOrder.objects.order_by("create_time").values("book_id").distinct()</code>

那么以上代码因为使用了<code>order_by</code>，即使使用了<code>distinct</code>，也会把重复的<code>book_id</code>提取出来。

<code>update</code>：执行更新操作，在<code>SQL</code>底层走的也是<code>update</code>命令。比如要将所有<code>category</code>为空的<code>article</code>的<code>article</code>字段都更新为默认的分类。示例代码如下：

<code>Article.objects.filter(category__isnull=True).update(category_id=3)</code>

注意这个方法走的是更新的逻辑。所以更新完成后保存到数据库中不会执行<code>save</code>方法，因此不会更新<code>auto_now</code>设置的字段。

<code>delete</code>：删除所有满足条件的数据。删除数据的时候，要注意<code>on_delete</code>指定的处理方式。

切片操作：有时候我们查找数据，有可能只需要其中的一部分。那么这时候可以使用切片操作来帮我们完成。<code>QuerySet</code>使用切片操作就跟列表使用切片操作是一样的。示例代码如下：

<code>books = Book.objects.all()[1:3] for book in books: print(book)</code>

切片操作并不是把所有数据从数据库中提取出来再做切片操作。而是在数据库层面使用<code>LIMIE</code>和<code>OFFSET</code>来帮我们完成。所以如果只需要取其中一部分的数据的时候，建议大家使用切片操作。

生成一个​<code>​QuerySet​</code>​对象并不会马上转换为​<code>​SQL​</code>​语句去执行。

比如我们获取​<code>​Book​</code>​表下所有的图书：

我们可以看到在打印​<code>​connection.quries​</code>​的时候打印的是一个空的列表。说明上面的​<code>​QuerySet​</code>​并没有真正的执行。

在以下情况下​<code>​QuerySet​</code>​会被转换为​<code>​SQL​</code>​语句执行：

迭代：在遍历<code>QuerySet</code>对象的时候，会首先先执行这个<code>SQL</code>语句，然后再把这个结果返回进行迭代。比如以下代码就会转换为<code>SQL</code>语句：

<code>for book in Book.objects.all(): print(book)</code>

使用步长做切片操作：<code>QuerySet</code>可以类似于列表一样做切片操作。做切片操作本身不会执行<code>SQL</code>语句，但是如果如果在做切片操作的时候提供了步长，那么就会立马执行<code>SQL</code>语句。需要注意的是，做切片后不能再执行<code>filter</code>方法，否则会报错。

调用<code>len</code>函数：调用<code>len</code>函数用来获取<code>QuerySet</code>中总共有多少条数据也会执行<code>SQL</code>语句。

调用<code>list</code>函数：调用<code>list</code>函数用来将一个<code>QuerySet</code>对象转换为<code>list</code>对象也会立马执行<code>SQL</code>语句。

判断：如果对某个<code>QuerySet</code>进行判断，也会立马执行<code>SQL</code>语句。