随着 Web 应用程序越来越复杂，前端开发人员通常需要使用一些数据结构校验工具（例如 PropTypes），以确保代码中的数据结构是正确的，从而避免运行时错误。然而，这些工具通常只能在前端代码中使用，并且可能无法满足后端服务的需要。
这正是 GraphQL 出现的原因之一。GraphQL 是一种新兴的 Web 服务协议，通过提供一个强大的类型系统，可以轻松地实现数据结构校验。本文将讨论如何在 GraphQL 中实现数据结构校验，并提供一些代码示例。
GraphQL 中的类型系统
GraphQL 是一种描述数据模型的语言，它使用类型系统来定义数据模型。在 GraphQL 中，一个类型可以是以下几种之一：
- 标量类型：例如字符串、数字、布尔值等。
- 对象类型：是包含其他类型的类型，类似于 JavaScript 中的对象或 JSON 中的对象。
- 枚举类型：是一组固定值的类型。
- 接口类型：在 GraphQL 中用于描述对象类型之间的公共字段和操作的抽象类型。
- 联合类型：是将多个对象类型集成为单个类型的机制。
在定义一个 GraphQL 模式时，您需要定义所有的类型和它们之间的关系。在定义类型时，您可以指定每个字段的类型和是否允许为空。
在 GraphQL 中实现数据结构校验
如果您需要在 GraphQL 中实现数据结构校验，则需要使用输入类型。输入类型是一种特殊的类型，用于描述传递给 GraphQL 操作（例如查询或变异）的参数的数据结构。输入类型可以包含标量类型、枚举类型、其他输入类型和非空类型。
下面是一个示例 GraphQL 查询：
query GetUser($id: ID!, $email: String!) {
user(id: $id, email: $email) {
id
name
email
}
}在这个查询中，我们可以看到 id 和 email 是查询的参数，它们都具有特定的类型。在 GraphQL 模式中定义这些类型时，我们可以使用输入类型来指定这些查询参数。
下面是一个使用输入类型的示例：
// javascriptcn.com 代码示例
input UserInput {
id: ID!
email: String!
}
type Query {
user(input: UserInput!): User
}
type User {
id: ID!
name: String
email: String!
}在这个示例中，我们定义了一个名为 UserInput 的输入类型，它包含一个 ID 类型的 id 字段和一个 String 类型的 email 字段，并且这两个字段都是非空的。我们得到了一个名为 user 的查询，该查询接受一个名为 input 的 UserInput 参数，并返回一个 User 类型的对象。
在这个示例中，我们已经成功地定义了一个输入类型，并且可以在查询中使用它来指定参数。如果一个传递给查询的参数不符合输入类型的规范，GraphQL 将会返回一个错误。
GraphQL 中的输入类型校验
GraphQL 为输入类型提供了内置的数据结构校验。如果一个传递给查询的参数不符合输入类型的规范，GraphQL 将会返回一个错误并说明错误的原因。这使得错误检测和调试变得更加容易。
下面是一个使用错误参数的示例：
query GetUser($id: ID!, $email: String!) {
user(input: { id: "1" email: $email }) {
id
name
email
}
}在这个查询中，我们将 id 参数设置为字符串而不是 ID 类型。由于这个参数不符合 UserInput 输入类型的规范，GraphQL 将会返回以下错误：
// javascriptcn.com 代码示例
{
"errors": [
{
"message": "Variable 'id' got invalid value '1'; Expected type ID at value.id.",
"locations": [],
"path": [
"user",
"id"
]
}
]
}通过阅读这个错误信息，我们知道了哪里出了问题以及问题的原因。这使得调试和错误检测变得非常容易。
自定义输入类型的校验
除了默认的输入类型校验之外，GraphQL 还允许我们自定义输入类型的校验规则。对于某些复杂的数据结构，自定义校验规则非常有用。
GraphQL提供了一些内置指令，可以在GraphQL架构中自定义输入类型校验。其中一个常用的指令是 @constraint，它允许您定义一个简单的表达式，用于检查输入的值是否满足要求。例如，假设我们有一个名为 PhoneNumber 的输入类型，它包含一个 String 类型的 number 字段，我们可以使用 @constraint 指令来定义一个表达式，该表达式用于验证电话号码。
下面是一个示例代码：
input PhoneNumber {
number: String! @constraint(format: "phoneNumber")
}
type Query {
phone(input: PhoneNumber!): String
}在这个示例中，我们定义了一个 PhoneNumber 输入类型，它包含一个必填的字符串类型的 number 字段。我们使用 @constraint 指令来验证 number 字段是否满足一个名为 "phoneNumber" 的规则。在这个规则中，我们可以使用一个正则表达式来验证电话号码是否有效。
总结
数据结构校验在现代 Web 开发中变得越来越重要。GraphQL 提供了一种强大的类型系统，它可以轻松地实现数据结构校验。使用 GraphQL 的输入类型，我们可以定义数据模型的结构并验证传递给 GraphQL 操作的参数是否符合结构的规范。在 GraphQL 中，我们还可以使用自定义的校验规则来满足特定需求。通过这些功能，我们可以减少运行时错误并提高 Web 应用程序的质量。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/652e1f9f7d4982a6ebf2e15f