使用 GraphQL Validation 对查询和数据做校验

GraphQL 是一种查询语言,它是一种描述和查询数据模型的语言。在前端开发中,GraphQL 被广泛应用于客户端的数据获取和后端 API 的设计。虽然 GraphQL 提供了非常完善的查询语法和类型系统,但是我们仍然需要对查询和数据做一些校验,以保证系统的稳定性和可靠性。GraphQL Validation 是一个非常好的工具,它可以用于对查询和数据进行校验,避免了一些常见的问题。

什么是 GraphQL Validation?

GraphQL Validation 是一个 JavaScript 库,它可以用于对 GraphQL 查询和数据进行校验。它可以在客户端和服务端同时使用,对于服务端来说,它可以在执行查询前对查询进行校验,对于客户端来说,它可以在发送查询前对查询进行校验。GraphQL Validation 内置了许多规则,可以用于校验查询和数据。例如,它可以检查查询中使用的字段是否和定义的类型匹配,是否缺少必要的参数,是否有重复的字段等。

如何使用 GraphQL Validation?

下面是一个简单的例子,展示了如何使用 GraphQL Validation 来校验查询:

------ - --------- -------------- - ---- ----------

----- ----- - -
  ----- ------------ ---- -
    -------- ---- -
      ----
      ---
    -
  -
--

----- --------- - -
  --- ----
--

----- ------ - ---------
  -------
  -------------
  ---------------
  ----------
--

-- ------- -- -------------- -
  --------------------
- ---- -
  ------------------ -- --------
-

在这个例子中,我们首先定义了一个查询,然后定义了一个变量 id,这个变量会在查询中被使用。然后我们使用 validate 函数对查询进行校验,这个函数接受四个参数:schema 表示 GraphQL 的 schema,parse(query) 表示解析查询语句,specifiedRules 表示要校验的规则,variables 表示查询中要用到的变量。如果校验结果有错误,我们就会得到一个错误数组,可以根据错误数组中的信息来调试代码。

GraphQL Validation 的规则

GraphQL Validation 内置了许多规则,这些规则可以用于校验查询和数据。下面是一些常用的规则:

  • NoSchemaIntrospectionCustomRule:禁止通过 Introspection 查询 Schema。
  • NoUnusedFragmentsCustomRule:禁止定义未使用的 fragment。
  • NoUnusedVariablesCustomRule:禁止定义未使用的变量。
  • NoUndefinedVariablesCustomRule:禁止使用未定义的变量。
  • NoFragmentCyclesCustomRule:禁止使用循环引用的 fragment。
  • KnownFragmentNamesCustomRule:打印未被引用的 fragment。
  • KnownDirectivesCustomRule:打印未被使用的指令。
  • NoUnusedFragmentsCustomRule:禁止使用未被引用的 fragment。
  • ProvidedNonNullArgumentsCustomRule:强制要求必填参数传参。

除了上面列出的规则之外,还有许多其他的规则可以用于校验 GraphQL 查询和数据。如果有兴趣的话,可以去查看官方文档。

结论

GraphQL Validation 是一个非常好用的工具,它可以用于检验 GraphQL 查询和数据的正确性。使用它可以避免很多常见的问题,提高系统的稳定性和可靠性。在使用 GraphQL 的过程中,我们应该充分发挥 GraphQL Validation 的作用,这能够使我们的代码更加健壮和可靠。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/671f6e1a2e7021665efd90c7