Django如何修改已定义Prefetch对象的Queryset实现多条件关联预取
需要对已存在的Prefetch对象追加查询限制,未找到明确的实现方法。
class MyUser(AbstractUser): pass class Absence(Model): employee = ForeignKey(MyUser, related_name='absences', on_delete=PROTECT) start_date = DateField() end_date = DateField()
class UserAbsencesListAPIView(ListAPIView): queryset = MyUser.objects.order_by('first_name') serializer_class = serializers.UserWithAbsencesSerializer filterset_class = filters.UserAbsencesFilterSet
class UserAbsencesFilterSet(FilterSet): first_name = CharFilter(lookup_expr='icontains', field_name='first_name') from_ = DateFilter(method='filter_from', distinct=True) to = DateFilter(method='filter_to', distinct=True)
接口请求会携带from_和to两个日期参数,需要返回用户列表,且仅预取落在指定日期间隔内的Absence关联记录。单参数过滤场景下,可直接通过Prefetch对象指定absences的过滤查询集实现,示例代码如下:
def filter_from(self, queryset, name, value): return queryset.prefetch_related( Prefetch( 'absences', Absence.objects.filter(Q(start_date__gte=value) | Q(start_date__lte=value, end_date__gte=value)), ) )
to参数的单过滤逻辑与上述实现类似。
但当需要同时使用两个参数做范围过滤时,两个过滤方法会分别执行,重复调用prefetch_related会抛出异常:ValueError: 'absences' lookup was already seen with a different queryset. You may need to adjust the ordering of your lookups.
尝试过使用to_attr参数解决,但无法在未求值的查询集上访问对应属性。已知可以通过查询集的_prefetch_related_lookups属性找到已定义的Prefetch对象,需要确认是否有方案可以给已有Prefetch追加过滤条件,或直接替换为新的Prefetch对象,最终实现同时满足两个日期条件的关联预取效果,目标查询逻辑如下:
queryset.prefetch_related( Prefetch( 'absences', Absence.objects.filter( Q(Q(start_date__gte=from_) | Q(start_date__lte=from_, end_date__gte=from_)) & Q(Q(end_date__lte=to) | Q(start_date__lte=to, end_date__gte=to)) ), ) )
最稳妥的实现方式是不要把两个日期过滤的逻辑拆到两个独立的filter方法里分别加Prefetch,统一在FilterSet的filter_queryset入口方法里组装过滤条件,只生成一次Prefetch即可,完全不需要绕弯去适配多次prefetch的冲突问题。
参考实现代码:
class UserAbsencesFilterSet(FilterSet): first_name = CharFilter(lookup_expr='icontains', field_name='first_name') from_ = DateFilter(distinct=True) to = DateFilter(distinct=True) def filter_queryset(self, queryset): # 先执行原有普通字段的过滤逻辑 queryset = super().filter_queryset(queryset) from_val = self.form.cleaned_data.get('from_') to_val = self.form.cleaned_data.get('to') absence_filters = Q() if from_val: absence_filters &= Q(start_date__gte=from_val) | Q(start_date__lte=from_val, end_date__gte=from_val) if to_val: absence_filters &= Q(end_date__lte=to_val) | Q(start_date__lte=to_val, end_date__gte=to_val) # 仅当传了日期过滤参数时,才追加带过滤条件的Prefetch if absence_filters: # 先清除同路径下已存在的Prefetch配置,避免冲突 queryset._prefetch_related_lookups = tuple( lookup for lookup in queryset._prefetch_related_lookups if not (isinstance(lookup, Prefetch) and lookup.prefetch_to == 'absences') ) queryset = queryset.prefetch_related( Prefetch('absences', queryset=Absence.objects.filter(absence_filters)) ) return queryset
实现说明:
- 直接操作
_prefetch_related_lookups清理同路径旧Prefetch的方式是稳定可用的,Django内部处理prefetch冲突时也用了类似逻辑,这个内部属性从Prefetch特性上线至今结构没有过破坏性变更,生产环境可以放心用。 - 不要在单个字段的过滤方法里单独绑定Prefetch:django-filter的字段过滤是按定义顺序执行的,单个方法执行时拿不到其他字段的最终过滤值,没法拼出完整的查询条件,统一在
filter_queryset里处理所有日期参数逻辑最稳妥。 - 没有传任何日期参数时不要追加带过滤条件的Prefetch,避免破坏原有默认的关联查询逻辑。
如果你确实需要在已有Prefetch基础上追加条件,也可以直接遍历_prefetch_related_lookups找到对应absences路径的Prefetch实例,直接修改它的queryset属性追加过滤条件即可,Prefetch实例持有的queryset是普通QuerySet对象,链式调用filter会直接生效:
for lookup in queryset._prefetch_related_lookups: if isinstance(lookup, Prefetch) and lookup.prefetch_to == 'absences': lookup.queryset = lookup.queryset.filter(absence_filters) break else: # 没找到对应Prefetch时直接新增 queryset = queryset.prefetch_related(Prefetch('absences', Absence.objects.filter(absence_filters)))
内容的提问来源于stack exchange,提问作者Eugene

