Django Ninja 中缓存分页查询集的最佳实践

在使用 Django Ninja 开发 API 时，我们经常会遇到需要缓存分页查询结果的需求。本文将深入探讨如何高效地缓存包含 prefetch_related 和 select_related 的分页查询集。

缓存分页查询集的常见问题

当开发者尝试缓存包含关联查询的分页结果时，经常会遇到 PicklingError 异常。这是因为 Django 的查询集对象包含了一些无法被 pickle 序列化的内部状态，特别是当使用了 prefetch_related 时。

典型的错误表现为：

_pickle.PicklingError: Can't pickle <function QuerySet._clone at 0x1328ea340>: it's not the same object as django.db.models.query.QuerySet._clone

解决方案对比

方案一：强制转换为列表

最简单的解决方案是将查询集强制转换为列表：

data = {"count": queryset.count(), "items": list(paginated_queryset)}

这种方法适用于简单的查询集和 select_related，但对于 prefetch_related 可能仍然会失败，因为预取缓存中的某些属性可能无法被 pickle。

方案二：使用 Django 内置的缓存装饰器

更推荐的解决方案是分离分页和缓存逻辑，使用 Django 内置的 cache_page 装饰器：

from ninja.decorators import decorate_view
from ninja.pagination import paginate
from django.views.decorators.cache import cache_page

@http_get("", response=NinjaPaginationResponseSchema[StockItemSupplierSchemaOut])
@decorate_view(cache_page(5 * 60))
@paginate
def get_all_suppliers(self, request, **kwargs):
    return StockItemSupplier.objects.filter(deleted_at=None)
        .order_by("name")
        .prefetch_related("phone_numbers", "addresses")

方案优势分析

使用 cache_page 装饰器有以下优势：

1. 自动处理序列化：Django 的缓存框架已经内置了对各种数据类型的序列化支持
2. 灵活的缓存键控制：可以通过 vary 头部基于用户认证状态或其他条件区分缓存
3. 内置缓存前缀管理：可以方便地管理缓存键命名空间
4. 与 Django 缓存系统深度集成：支持各种缓存后端和失效策略

缓存清除策略

当使用 cache_page 时，如果需要批量清除缓存，可以通过缓存后端的模式匹配功能实现。例如在使用 django-redis 时：

cache.delete_pattern("*my_key_prefix*")

结论

对于 Django Ninja 项目中的分页查询缓存需求，推荐使用 Django 内置的 cache_page 装饰器方案。它不仅解决了 prefetch_related 和 select_related 的序列化问题，还提供了更完善的缓存管理功能。对于需要更细粒度控制的场景，可以结合使用 vary 头部和自定义缓存键前缀来实现灵活的缓存策略。