GraphQL 是一种用于构建 API 的查询语言和运行时，它使得应用程序能够更好地描述其数据要求，而且具备强大的类型系统，易于让开发者快速迭代应用程序。在开始使用 GraphQL 前，一个非常重要的任务就是如何设计一个好的 GraphQL Schema。本文将介绍一些 GraphQL Schema 的设计指南，并且针对各个方面给出了示例代码。
定义 GraphQL Schema
GraphQL Schema 定义了应用程序的数据模型和数据查询接口。设计一个好的 GraphQL Schema 不仅仅是让应用程序更加高效，也是让使用 GraphQL 的开发者更加容易理解应用程序。以下是一个简单的示例代码：
---- ----- - -------- ------ ---- - ---- ---- - --- ---- ------ ------ ------- ------ -
在这个示例代码中，定义了一个 Query 类型和一个 Book 类型。Query 类型包含了一个名为 book 的查询接口，它接受一个 id 参数，并返回一个 Book 对象。Book 类型包含了一个 id 字段和两个可选的字段 title 和 author。
建立对 Type 的依赖关系
在一个复杂的数据模型中，可能存在许多类型之间的依赖关系。如何建立这些依赖关系是设计一个好的 GraphQL Schema 的关键。下面是一个示例代码：
---- ----- - ---------- ------ ------ -------- ------ ---- - ---- ------ - --- ---- ----- ------ ------ ------ - ---- ---- - --- ---- ------ ------ ------- ------ -
在这个示例代码中，定义了一个 Query 类型和一个 Author 类型和一个 Book 类型。Query 类型包含了两个查询接口，一个是 author，一个是 book。Author 类型包含了一个 id 字段、一个 name 字段和一个 books 字段，它会返回一个由多个 Book 对象组成的数组。Book 类型包含了一个 id 字段、一个 title 字段和一个 author 字段，它会返回一个由单个 Author 对象组成的数组。
这个示例代码中表明，一个 Author 对象和多个 Book 对象是有关系的，而一个 Book 对象和一个 Author 对象也是有关系的。这种关系的建立，让我们在查询数据时更加灵活，也让应用程序更加易于理解。
定义字段的默认值
GraphQL 允许我们为每个字段定义默认值，这对于创建一个可复用的接口非常有用。例如，下面是一个示例代码：
---- ----- - -------- ------ ---- - ---- ---- - --- ---- ------ ------ ------- ------ ------- ------ - ----------- -
在这个示例代码中，定义了一个 Query 类型和一个 Book 类型。Query 类型包含了一个名为 book 的查询接口。Book 类型包含了一个 status 字段，并且已经为它定义了一个默认值 "published"。如果在查询时没有指定这个字段，GraphQL 将返回 "published"。
使用 Fragments 获取数据
Fragments 是 GraphQL 中一个非常重要的概念，它可以让我们在多个查询之间共享代码。下面是一个示例代码：
-------- ---------- -- ---- - -- ----- ------ - ---- ----- - -------- ------ ---- - ---- ---- - ------------- -
在这个示例代码中，定义了一个名为 BookFields 的 Fragment，它包含了一个 Book 类型中的 id 字段、title 字段和 author 字段。然后，Book 类型使用 ...BookFields 引用了这个 Fragment，这样查询一个 Book 对象时，我们只需要输入 BookFields 部分的代码，就可以轻松地获取到我们需要的数据。
使用 Input Types 简化 Mutation
Mutation 是 GraphQL 中用于修改数据的方式，但往往传递的参数过多。为了简化 Mutation 的参数传递，我们可以使用 Input Types。下面是一个示例代码：
---- ----- - -------- ------ ---- - ---- -------- - -------------- ------------ ---- - ---- ---- - --- ---- ------ ------ ------- ------ - ----- --------- - ------ ------- ------- ------- -
在这个示例代码中，定义了一个 Query 类型和一个 Mutation 类型和一个 Book 类型。Query 类型包含了一个名为 book 的查询接口。Mutation 类型包含了一个 addBook 接口，它接受一个 input 参数，这个参数是一个 BookInput 类型。BookInput 类型只有 title 字段和 author 字段，当执行 addBook 接口时，我们只需要传递一个 BookInput 对象，就可以完成一个 Book 对象的插入操作。
结论
在设计 GraphQL Schema 时，需考虑到使用的业务场景和代码结构等多个因素。本文介绍了一些设计指南，并给出了相应的示例代码，希望可以为读者提供一些参考和帮助。当然，如何设计才能让 GraphQL Schema 更好地满足您的需求，还需要进一步的实践和经验积累。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/670f7b3b5f5512810264c419