如何在GraphQL中为参数添加指令实现入参校验
问题原因
- 方法入参理解错误:
visitArgumentDefinition方法接收的第一个参数是参数定义对象(ArgumentDefinition),不是字段对象,该对象本身不存在resolve属性,你给它挂载resolve的操作本身就是无效的。 - GraphQL执行规则限制:GraphQL执行流程中只会触发字段的resolver逻辑,不会为参数定义执行单独的逻辑,即便你给参数定义挂载了resolver也不会被调用。
- 字段级指令能正常触发是因为你修改的是字段本身的resolver,符合GraphQL的执行规则。
解决方案
你需要在访问参数定义时,将校验逻辑绑定到所属字段的resolver执行链上,修改后的实现代码如下:
const { SchemaDirectiveVisitor } = require('apollo-server-express'); const { defaultFieldResolver } = require('graphql'); class InputValidationDirective extends SchemaDirectiveVisitor { visitArgumentDefinition(argDef, { field }) { // 初始化字段的待校验参数列表,同时重写字段resolver统一处理校验 if (!field.validatedArgs) { field.validatedArgs = []; const originalResolve = field.resolve || defaultFieldResolver; field.resolve = async function (parent, args, context, info) { // 执行所有参数校验逻辑 for (const argName of field.validatedArgs) { const argValue = args[argName]; // 此处可扩展自定义校验规则,示例为非空校验 if (argValue == null) { throw new Error(`参数${argName}不能为空`); } } // 校验通过后执行原resolver return originalResolve(parent, args, context, info); }; } // 将当前标记了@validate的参数加入校验列表 field.validatedArgs.push(argDef.name); } visitFieldDefinition(field) { // 保留原有字段级校验逻辑 const originalResolve = field.resolve || defaultFieldResolver; field.resolve = async function (...args) { const result = await originalResolve.apply(this, args); console.log('字段级校验触发', result); return result; } } }
如果使用的是Apollo Server v3及以上版本,SchemaDirectiveVisitor已经被官方废弃,可通过createGraphQLSchema的transforms配置,或者graphql-middleware库实现相同的参数校验能力。
内容的提问来源于stack exchange,提问作者Andreas Köberle
相关产品推荐
相关产品推荐

