在 Django 的 ORM 中,可以通过 自定义模型管理器(Custom Manager) 和 自定义 QuerySet 方法 来扩展查询功能,从而封装常用查询逻辑,提升代码复用性和可维护性。以下是具体实现方法和典型应用场景:
一、实现方法
1.自定义 QuerySet 并绑定到模型管理器
通过定义继承自 models.QuerySet
的自定义查询集类,添加可链式调用的查询方法,再将其绑定到模型管理器。
步骤:
- 创建自定义
QuerySet
类,添加查询方法。 - 创建自定义
Manager
类,覆盖get_queryset
方法返回自定义 QuerySet。 - 将自定义管理器绑定到模型。
示例代码:
# models.py
from django.db import models
class CustomQuerySet(models.QuerySet):
def active_users(self):
"""返回活跃用户(is_active=True)"""
return self.filter(is_active=True)
def with_profile(self):
"""预取关联的 Profile 数据,避免 N+1 查询"""
return self.select_related('profile')
class UserManager(models.Manager):
def get_queryset(self):
return CustomQuerySet(self.model, using=self._db)
class User(models.Model):
username = models.CharField(max_length=100)
is_active = models.BooleanField(default=True)
profile = models.ForeignKey('Profile', on_delete=models.CASCADE)
# 使用自定义管理器替换默认的 objects
objects = UserManager()
class Profile(models.Model):
bio = models.TextField()
使用方式:
# 链式调用自定义方法
active_users = User.objects.active_users().with_profile()
2.直接为模型管理器添加方法
如果不需要链式调用,可以直接在管理器类中定义方法。
示例代码:
class UserManager(models.Manager):
def get_admins(self):
"""返回管理员用户"""
return self.filter(role='admin')
class User(models.Model):
role = models.CharField(max_length=20)
objects = UserManager()
# 使用
admins = User.objects.get_admins()
3.在模型类中添加自定义方法
为模型实例添加业务逻辑方法,操作当前实例的数据。
示例代码:
class User(models.Model):
first_name = models.CharField(max_length=100)
last_name = models.CharField(max_length=100)
last_login = models.DateTimeField(null=True)
def get_full_name(self):
"""返回用户全名"""
return f"{self.first_name} {self.last_name}"
def update_last_login(self):
"""更新最后登录时间"""
self.last_login = timezone.now()
self.save()
# 使用
user = User.objects.get(id=1)
print(user.get_full_name())
user.update_last_login()
4.使用 @classmethod 或 @staticmethod
定义类方法或静态方法,直接通过模型类调用。
示例代码:
class Product(models.Model):
name = models.CharField(max_length=100)
price = models.DecimalField(max_digits=10, decimal_places=2)
@classmethod
def get_expensive_products(cls, threshold=1000):
"""返回价格高于阈值的产品"""
return cls.objects.filter(price__gt=threshold)
@staticmethod
def calculate_average_price():
"""计算所有产品的平均价格"""
from django.db.models import Avg
return Product.objects.aggregate(avg_price=Avg('price'))['avg_price']
# 使用
expensive_products = Product.get_expensive_products(threshold=500)
average_price = Product.calculate_average_price()
二、应用场景
1.复用复杂查询逻辑
- 场景:多个视图需要相同的过滤条件(如“最近 7 天活跃用户”)。
- 优势:避免重复代码,统一查询逻辑。
class CustomQuerySet(models.QuerySet):
def recent_active_users(self):
return self.filter(
is_active=True,
last_login__gte=timezone.now() - timedelta(days=7)
)
# 在任意位置调用
users = User.objects.recent_active_users()
- 优化数据库查询
- 场景:减少 N+1 查询问题。
- 优势:通过 select_related 或 prefetch_related 预取关联数据。
class CustomQuerySet(models.QuerySet):
def with_related_data(self):
return self.select_related('profile').prefetch_related('orders')
# 一次查询获取用户及其配置和订单
users = User.objects.with_related_data()
3.封装业务逻辑
- 场景:处理模型实例的特定操作(如“用户发送通知”)。
- 优势:保持视图层简洁,逻辑集中到模型。
class User(models.Model):
def send_welcome_email(self):
"""发送欢迎邮件"""
send_mail(
subject="Welcome!",
message=f"Hello {self.username}!",
recipient_list=[self.email]
)
# 视图中直接调用
user.send_welcome_email()
4.提供统计或计算功能
- 场景:计算聚合值(如“订单总金额”)。
- 优势:隐藏复杂聚合逻辑,简化调用。
class OrderManager(models.Manager):
def total_sales(self):
return self.aggregate(total=models.Sum('amount'))['total']
class Order(models.Model):
amount = models.DecimalField(max_digits=10, decimal_places=2)
objects = OrderManager()
# 获取所有订单的总销售额
total = Order.objects.total_sales()
5.权限或状态过滤
- 场景:根据用户角色过滤数据(如“仅管理员可见的内容”)。
- 优势:集中权限控制,避免安全漏洞。
class ArticleManager(models.Manager):
def visible_to_user(self, user):
if user.is_staff:
return self.all()
return self.filter(status='published')
# 视图中根据用户权限过滤文章
articles = Article.objects.visible_to_user(request.user)
三、最佳实践
- 优先使用 QuerySet 方法:支持链式调用,更灵活。
- 避免在管理器方法中处理业务逻辑:业务逻辑应放在模型或服务层。
- 保持方法命名清晰:如 active_users() 比 filter_active() 更直观。
- 编写单元测试:确保自定义方法的行为符合预期。
四、总结
通过自定义 Django ORM 方法,可以将重复查询逻辑封装为可复用的组件,提升代码质量。典型实现方式包括:
- 自定义 QuerySet 和 Manager:适用于链式查询和全局过滤。
- 模型实例方法:封装单个对象的操作。
- 类方法/静态方法:提供与模型相关的工具函数。
合理使用这些技术,能显著提高开发效率并降低维护成本。