.filter() 与 .get() 对于单个对象？ （姜戈）

Question

我和一些同事就这个问题进行了辩论。 当您只需要一个对象时，是否有一种首选方法可以在 Django 中检索对象？

两种明显的方法是：

try:
    obj = MyModel.objects.get(id=1)
except MyModel.DoesNotExist:
    # We have no object! Do something...
    pass

并且：

objs = MyModel.objects.filter(id=1)

if len(objs) == 1:
    obj = objs[0]
else:
    # We have no object! Do something...
    pass

第一种方法在行为上似乎更正确，但在控制流中使用异常，这可能会带来一些开销。 第二个更加迂回，但永远不会引发异常。

对于其中哪一个更可取有什么想法吗？ 哪个更有效率？

Answer 1

get()提供了 专门针对此案例。 用它。

选项 2 几乎正是 get() 方法在 Django 中实际实现的方式，因此不应该有“性能”差异（并且您正在考虑它的事实表明您违反了一个编程的基本规则，即在编写和分析代码之前尝试优化代码 - 直到您拥有代码并可以运行它，您不知道它将如何执行，并且在此之前尝试优化是一条路径的疼痛）。

Answer 2

您可以安装一个名为 django-annoying 的模块，然后执行以下操作：

from annoying.functions import get_object_or_None

obj = get_object_or_None(MyModel, id=1)

if not obj:
    #omg the object was not found do some error stuff

Answer 3

1 是正确的。 在 Python 中，异常与返回具有相同的开销。 对于简化的证明，您可以查看 这个。

2 这就是 Django 在后端所做的事情。 get 调用 filter 并在未找到任何项目或找到多个对象时引发异常。

Answer 4

我来晚了一点，但在 Django 1.6 中，查询集上有 first() 方法。

https://docs. djangoproject.com/en/dev/ref/models/querysets/#django.db.models.query.QuerySet.first

---

返回查询集匹配的第一个对象，如果没有匹配的对象，则返回 None。 如果查询集没有定义排序，则查询集将自动按主键排序。

例子：

p = Article.objects.order_by('title', 'pub_date').first()
Note that first() is a convenience method, the following code sample is equivalent to the above example:

try:
    p = Article.objects.order_by('title', 'pub_date')[0]
except IndexError:
    p = None

Answer 5

为什么这一切都有效？ 用 1 个内置快捷方式替换 4 行。 （这会执行自己的尝试/例外。）

from django.shortcuts import get_object_or_404

obj = get_object_or_404(MyModel, id=1)

Answer 6

我无法谈论 Django 的任何经验，但选项 #1 清楚地告诉系统您正在请求 1 个对象，而第二个选项则不然。 这意味着选项#1 可以更轻松地利用缓存或数据库索引，特别是在您要过滤的属性不能保证唯一的情况下。

另外（再次推测）第二个选项可能必须创建某种结果集合或迭代器对象，因为 filter() 调用通常可以返回许多行。 你可以用 get() 绕过这个。

最后，第一个选项更短，并且省略了额外的临时变量——只有微小的差异，但每一点都有帮助。

Answer 7

有关例外的更多信息。 如果不筹集，它们几乎不需要花费任何成本。 因此，如果您知道可能会得到结果，请使用异常，因为使用条件表达式无论如何都会付出每次检查的成本。 另一方面，当它们被引发时，它们的成本比条件表达式要高一些，因此，如果您预计不会以某种频率得到结果（例如，如果没记错的话，30％的时间），则条件检查结果是要便宜一点。

但这是 Django 的 ORM，并且可能到数据库的往返，甚至是缓存的结果，可能会主导性能特征，因此有利于可读性，在这种情况下，因为您只期望一个结果，所以使用 get ()。

Answer 8

我稍微研究了一下这个问题，发现选项 2 执行两个 SQL 查询，这对于这样一个简单的任务来说是过多的。 请参阅我的注释：

objs = MyModel.objects.filter(id=1) # This does not execute any SQL
if len(objs) == 1: # This executes SELECT COUNT(*) FROM XXX WHERE filter
    obj = objs[0]  # This executes SELECT x, y, z, .. FROM XXX WHERE filter
else: 
    # we have no object!  do something
    pass

执行单个查询的等效版本是：

items = [item for item in MyModel.objects.filter(id=1)] # executes SELECT x, y, z FROM XXX WHERE filter
count = len(items) # Does not execute any query, items is a standard list.
if count == 0:
   return None
return items[0]

通过切换到这种方法，我能够大大减少应用程序执行的查询数量。

Answer 9

.get()

返回与给定查找参数匹配的对象，该对象应该
采用字段查找中描述的格式。

如果有多个对象被调用，get() 会引发 MultipleObjectsReturned
成立。 MultipleObjectsReturned 异常是
模型类。

如果找不到对象，get() 会引发DoesNotExist 异常
给定的参数。 这个异常也是模型的一个属性
类。

.filter()

返回一个新的查询集，其中包含与给定查找匹配的对象
参数。

注意

当你想要获取单个唯一对象时，使用 get() ，而 filter()
当您想要获取与查找参数匹配的所有对象时。

Answer 10

有趣的问题，但对我来说，选项#2 带有过早优化的味道。 我不确定哪个性能更高，但选项 #1 对我来说确实看起来和感觉更Pythonic。

Answer 11

我建议采用不同的设计。

如果您想对可能的结果执行函数，您可以从 QuerySet 派生，如下所示： http://djangosnippets .org/snippets/734/

结果非常棒，您可以例如：

MyModel.objects.filter(id=1).yourFunction()

这里，过滤器返回一个空查询集或包含单个项目的查询集。 您的自定义查询集函数也是可链接和可重用的。 如果您想对所有条目执行此操作：MyModel.objects.all().yourFunction()。

它们也非常适合用作管理界面中的操作：

def yourAction(self, request, queryset):
    queryset.yourFunction()

Answer 12

选项 1 更优雅，但一定要使用 try.. except。

根据我自己的经验，我可以告诉您，有时您确定数据库中不可能有多个匹配对象，但实际上会有两个......（当然，通过主键获取对象时除外）。

Answer 13

很抱歉在这个问题上再添加一个，但我正在使用 django 分页器，并且在我的数据管理应用程序中，允许用户选择要查询的内容。 有时，这是一个文档的 ID，但除此之外，它是一个返回多个对象（即查询集）的通用查询。

如果用户查询 id，我可以运行：

Record.objects.get(pk=id)

这会在 django 的分页器中引发错误，因为它是记录而不是记录的查询集。

我需要运行：

Record.objects.filter(pk=id)

它返回一个包含一项的查询集。 然后分页器就可以正常工作了。

Answer 14

get() 返回一个对象，如下所示：

{
  "name": "John",
  "age": "26",
  "gender": "Male"
}

< a href="https://docs.djangoproject.com/en/4.2/ref/models/querysets/#filter" rel="nofollow noreferrer">filter() 返回 QuerySet 具有一个或多个对象，如下所示：

[
  {
    "name": "John",
    "age": "26",
    "gender": "Male"
  },
  {
    "name": "Tom",
    "age": "18",
    "gender": "Male"
  },
  {
    "name": "Marry",
    "age": "22",
    "gender": "Female"
  }
]