GraphQL Schema 应定义何种参数类型,可将入参透传至 MongoDB find
通用Mongo查询透传的GraphQL实现方案
GraphQL没有内置的“任意结构JSON”类型,无法直接承载动态结构的Mongo查询参数,需要通过自定义标量类型实现参数透传,具体实现步骤如下:
1. 实现支持任意JSON结构的自定义标量类型
直接基于graphql包原生提供的标量能力实现,可兼容任意嵌套结构、基础值、数组类型,完全适配Mongo查询对象的结构要求:
const { GraphQLScalarType, Kind } = require('graphql'); const GraphQLJSON = new GraphQLScalarType({ name: 'JSON', description: '支持任意合法JSON结构的标量类型,用于透传MongoDB查询参数', // 服务端返回数据时的序列化逻辑 serialize(value) { return value; }, // 客户端通过变量传入参数时的解析逻辑 parseValue(value) { return value; }, // 客户端通过内联字面量传入参数时的递归解析逻辑 parseLiteral(ast) { switch (ast.kind) { case Kind.STRING: case Kind.BOOLEAN: return ast.value; case Kind.INT: case Kind.FLOAT: return parseFloat(ast.value); case Kind.OBJECT: { const parsedObj = Object.create(null); ast.fields.forEach(field => { parsedObj[field.name.value] = this.parseLiteral(field.value); }); return parsedObj; } case Kind.LIST: return ast.values.map(item => this.parseLiteral(item)); case Kind.NULL: return null; default: return undefined; } }, });
2. 替换Schema里的query参数类型占位符
把你原有Schema里query字段的类型替换为上面定义的自定义JSON类型,resolve逻辑里直接把query参数透传给Mongoose的find方法即可:
todosQuerable: { type: new graphql.GraphQLList(TodoType), args: { // 原占位符替换为自定义的GraphQLJSON类型 query: { type: GraphQLJSON }, }, resolve: async (source, { query }) => { // 直接透传查询参数给Mongoose,和Mongo shell的查询逻辑完全对齐 return TODO.find(query).exec(); } }
注意:原来的回调式find写法完全兼容,这里只是换成了更简洁的async/await写法,不影响功能。
3. 实现效果
配置完成后,你可以直接在GraphQL请求里传入任意结构的查询条件,比如:
query { todosQuerable(query: {title: "Andare a Novellara"}) { _id title completed } }
传入的query对象会被原封不动传给Todo.find()方法,和在Mongo shell执行db.Todo.find({title: 'Andare a Novellara'})的查询结果完全一致,也支持$gt、$in、$regex等所有Mongo查询运算符,不需要为每个运算符单独定义入参。
生产环境注意事项
- 必须对传入的query参数做权限校验,避免开放任意查询带来的未授权数据访问、全表扫描性能问题
- 如果需要支持ObjectId、正则等非纯JSON类型的查询值,可以在自定义标量的解析逻辑中增加对应类型的自动转换,避免Mongoose查询时报类型错误
- 不要使用提前定义字段的
GraphQLInputObjectType承载这类通用查询参数:这类类型要求提前写死所有可传字段,要支持全量Mongo查询运算符需要定义极多层嵌套结构,完全无法满足“透传任意查询条件”的需求
内容的提问来源于stack exchange,提问作者Franco Rondini
相关产品推荐
相关产品推荐

