Django Graphene 如何将分散筛选参数封装为统一入参对象实现过滤
实现方案
这种参数封装形式完全可行,是Graphene框架中处理多筛选参数的标准化工程实现方式,完全符合GraphQL入参设计规范,具体实现步骤如下:
1. 定义独立的输入类型对象
GraphQL规范要求,作为接口入参的复杂嵌套对象,必须使用专门的InputObjectType类型定义,不能直接复用普通业务输出对象类型。把原来分散的筛选参数统一迁移到这个独立输入类中:
import graphene # 定义封装好的筛选入参对象 class DocumentNumberFilterInput(graphene.InputObjectType): # 原有分散的筛选参数全部迁移到此处 doc__number__in = graphene.List(graphene.String, required=False) doc__supplier__delivery__in = graphene.List(graphene.String, required=False) doc__supplier__number__in = graphene.List(graphene.String, required=False)
2. 替换字段定义中的分散入参
修改原ConnectionField的参数声明,删除三个分散的筛选参数,替换为我们定义的独立入参对象:
class Document(graphene.ObjectType): number = graphene.relay.ConnectionField( ReportDocumentNumberConnection, # 用封装好的入参对象替换原来的三个零散参数 inputFilter=DocumentNumberFilterInput(required=False), )
3. 补充Resolve逻辑实现筛选
原来的筛选逻辑是直接从入参中读取单个字段,现在需要从inputFilter对象中取出所有筛选条件,对接原有ORM查询逻辑:
def resolve_number(self, info, **kwargs): # 取出封装的筛选入参,为空时默认传空字典 filter_conditions = kwargs.get("inputFilter") or {} # 替换为你项目中原有的基础查询集初始化逻辑 base_queryset = ReportDocumentNumber.objects.all() # 因为入参字段名和Django ORM查询语法完全匹配,可直接解包透传到filter filtered_queryset = base_queryset.filter(**filter_conditions) # 返回处理后的查询集,ConnectionField会自动处理分页逻辑 return filtered_queryset
效果说明
实现完成后,即可直接使用你期望的嵌套入参形式发起查询,和原有业务逻辑完全兼容:
{ allDocuments{ number(inputFilter: { doc_Number_In: "TVF" doc_Supplier_Delivery_In: "Q23" }) { edges { node { # 原有字段查询逻辑保持不变 } } } } }
注意事项
- 该实现不会改动原有的参数命名映射规则:Graphene默认会把Python侧的snake_case字段名自动转换为GraphQL端对应的camelCase格式,和你原来零散参数的字段映射逻辑完全一致,不会出现参数匹配失效的问题。
- 后续新增筛选条件时,只需要在
DocumentNumberFilterInput类中补充对应字段、同步更新ORM查询逻辑即可,不需要改动字段定义层的代码,维护成本更低。
内容的提问来源于stack exchange,提问作者Headmaster
相关产品推荐
相关产品推荐

