利用Python的Django框架中的ORM建立查询API

摘要 在这篇文章里，我将以反模式的角度来直接讨论Django的低级ORM查询方法的使用。作为一种替代方式，我们需要在包含业务逻辑的模型层建立与特定领域相关的查询API，这些在Django中做起来不是非常容易，但通过深入地了解ORM的内容原理，我将告诉你一些简捷的方式来达到这个目的。 概览 当编写Django应用程序时，我们已经习惯通过添加方法到模型里以此达到封装业务逻辑并隐藏实现细节。这种方法看起来是非常的自然，而且实际上它也用在Django的内建应用中。   >>> from django.contrib.auth.models import User >>> user = User.o 在Python的Django框架中，ORM（对象关系映射）是一种强大的工具，它允许开发者以面向对象的方式处理数据库操作，而无需直接编写SQL语句。本文将探讨如何利用Django ORM构建更高效的查询API，特别是在模型层封装业务逻辑，以提高代码的可读性、可维护性和可复用性。 Django ORM的核心概念包括Model、Manager和QuerySet。Model是数据库表的抽象，定义了字段和行为；Manager是用于操作Model实例的类，提供了数据库查询的方法；QuerySet则是表示一组数据库查询结果的对象，它具有缓存和延迟执行的特性。 在Django中，每个Model都默认有一个Manager，名为`objects`，它提供了诸如`get()`, `filter()`, `all()`等方法。然而，当查询变得复杂时，这些基础方法可能会导致代码冗长且难以理解。例如，如描述中所示的`dashboard`视图，使用了多次`filter()`来获取特定条件的Todos，这并不符合DRY（Don't Repeat Yourself）原则。 为了解决这个问题，我们可以自定义Manager和QuerySet。Manager是Model类的一个属性，可以添加额外的查询方法。QuerySet是Manager的主要工作对象，可以扩展其功能以满足特定需求。在Todo模型中，我们可以创建一个新的Manager，比如`TodoManager`，并在这个Manager中定义一个新的方法，比如`high_priority_not_done_by_user()`，这样就可以简化视图中的查询： ```python from django.db import models from django.contrib.auth.models import User PRIORITY_CHOICES = [(1, 'High'), (2, 'Low')] class TodoManager(models.Manager): def high_priority_not_done_by_user(self, user): return self.filter(owner=user, is_done=False, priority=1) class Todo(models.Model): content = models.CharField(max_length=100) is_done = models.BooleanField(default=False) owner = models.ForeignKey(User) priority = models.IntegerField(choices=PRIORITY_CHOICES, default=1) objects = TodoManager() # ...其他模型方法... ``` 现在，我们的视图可以简化为： ```python def dashboard(request): todos = request.user.todo_set.high_priority_not_done_by_user() return render(request, 'todos/list.html', {'todos': todos}) ``` 这样做有几个优点： 1. **代码简洁**：我们把复杂的查询逻辑封装在Manager中，使得视图函数更易读。 2. **隐藏实现细节**：更改模型字段类型或查询逻辑不会影响视图，因为它们是在Manager中定义的。 3. **意图明确**：方法名`high_priority_not_done_by_user`清晰地表达了查询的意图。 4. **避免重复**：如果有多个地方需要用到相同的查询，只需调用这个方法即可，无需复制代码。 此外，通过这种方式，我们还可以在Manager中加入更多的业务逻辑，比如验证、过滤或者与其他服务的交互，进一步提升代码的复用性。利用Django的ORM构建自定义查询API，可以有效提高代码质量，降低维护成本，同时让代码更符合领域特定语言（DSL），使得代码更接近业务需求。