首页
/ KeystoneJS 中 GraphQL Schema 的非空字段配置解析

KeystoneJS 中 GraphQL Schema 的非空字段配置解析

2025-05-24 16:39:59作者:牧宁李

在 KeystoneJS 项目中,开发者经常会遇到 GraphQL Schema 中字段默认可为空的问题。本文将深入探讨这一现象的原因,并提供解决方案。

问题现象

当使用 KeystoneJS 定义数据模型时,即使字段设置了 validation: { isRequired: true },生成的 GraphQL Schema 中对应字段仍然可能被标记为可空。例如:

type Novel {
  id: ID!
  title: String  # 即使设置了 isRequired: true,仍然可为空
  originalTitle: String
}

原因分析

KeystoneJS 的字段验证(validation)和 GraphQL Schema 的非空标记(!)是两个独立的配置层面:

  1. 验证层面validation.isRequired控制的是应用层的数据验证
  2. Schema 层面:GraphQL 类型系统中的非空标记需要通过专门的配置实现

解决方案

KeystoneJS 提供了 graphql.isNonNull 配置选项来显式控制 Schema 中的非空标记:

const Novel = list({
  fields: {
    title: text({ 
      validation: { isRequired: true },
      graphql: {
        isNonNull: { read: true, create: true }  // 在读取和创建时都设为非空
      }
    }),
  }
});

关系字段的特殊处理

对于关系字段,KeystoneJS 也提供了类似的配置方式:

const Featured = list({
  fields: {
    novels: relationship({
      ref: 'Novel',
      many: true,
      graphql: {
        isNonNull: { read: true }  // 确保返回数组不为null
      }
    })
  }
});

最佳实践

  1. 明确区分验证和类型系统:理解应用层验证和GraphQL类型系统的不同作用
  2. 一致性配置:对于必填字段,同时设置validation.isRequiredgraphql.isNonNull
  3. 显式优于隐式:不要依赖默认行为,明确指定需要的非空约束

通过合理配置这些选项,开发者可以构建出类型更加精确、使用更安全的GraphQL API。

登录后查看全文
热门项目推荐
相关项目推荐