GraphQL 是一种用于 API 的查询语言,它通过定义类型和字段来描述 API 中允许查询和修改的数据。与 RESTful API 相比,GraphQL 具有更高的灵活性和可扩展性。Apollo Server 是一个流行的 GraphQL 服务器库,它支持多种数据源、插件和中间件。
在本文中,我们将介绍如何使用 Apollo Server 构建一个 GraphQL 服务器,并使用它来查询和修改数据。我们将从安装 Apollo Server 开始,然后定义 GraphQL Schema、实现查询和修改操作、使用中间件和插件、以及处理错误和异常。
安装 Apollo Server
安装 Apollo Server 可以使用 npm 或 yarn:
npm install apollo-server
yarn add apollo-server
安装完成之后,我们可以创建一个最简单的 Apollo Server 实例:
-- -------------------- ---- ------- ----- - ------------- --- - - ------------------------- ----- -------- - ---- ---- ----- - ------ ------ - -- ----- --------- - - ------ - ------ -- -- ------- ------- - -- ----- ------ - --- -------------- --------- --------- --- ----------------------- --- -- -- - ------------------- ----- -- --------- ---
这个例子定义了一个名为 hello
的查询,它返回一个字符串。我们可以使用 GraphiQL 工具来测试这个查询,GraphiQL 是一个 GraphQL 开发工具,它提供了查询编辑器、结构文档、变量输入等功能。
打开浏览器并访问 http://localhost:4000/graphql
,可以看到 GraphiQL 页面。在编辑器中输入以下查询:
query { hello }
然后按下运行按钮,你会看到返回值为:
{ "data": { "hello": "Hello, world!" } }
这个例子非常简单,但它演示了 Apollo Server 的基本用法。接下来,我们将介绍如何定义 GraphQL Schema、实现查询和修改操作,以及使用更多的功能。
定义 GraphQL Schema
GraphQL Schema 定义了 GraphQL API 的类型和字段,它是一个基于类型系统的协议。我们可以使用 GraphQL Schema Language 来定义 Schema。
例如,我们可以定义一个类型为 Book
,包括 title
和 author
两个字段:
type Book { title: String author: String }
我们还可以定义一个类型为 Query
,包括 books
和 book
两个查询:
type Query { books: [Book] book(id: Int!): Book }
其中,books
返回一个数组类型,每个元素是 Book
类型;book
接收 id
参数,返回一个 Book
类型。
我们可以把这些类型定义存储在一个字符串中,并传递给 Apollo Server 实例:
-- -------------------- ---- ------- ----- -------- - ---- ---- ---- - ------ ------ ------- ------ - ---- ----- - ------ ------ -------- ------ ---- - -- ----- --------- - - ------ - ------ -- -- --- ----- -------- - -- -- -- -- --- ------ ------- ------- -------- -- - --
这个例子中的 resolvers
对象中定义了 Query
的实现,books
返回一个空数组,book
返回一个包含 id
、title
和 author
字段的对象。
现在,我们可以测试这个 Schema,例如查询所有的书籍:
query { books { title author } }
我们会得到一个空数组。
实现查询和修改操作
除了查询外,GraphQL 还支持修改操作。我们可以定义一个类型为 Mutation
的根节点,它包括多个可变操作。例如,我们可以定义一个 createBook
操作:
type Mutation { createBook(input: BookInput!): Book } input BookInput { title: String! author: String! }
其中,createBook
接收一个 BookInput
类型的参数,并返回一个 Book
类型的结果。
我们可以在 resolvers
中定义 Mutation
的实现,例如使用一个数组来存储书籍:
-- -------------------- ---- ------- ----- -------- - ---- ---- ---- - ------ ------ ------- ------ - ----- --------- - ------ ------- ------- ------- - ---- ----- - ------ ------ -------- ------ ---- - ---- -------- - ----------------- ------------ ---- - -- ----- ----- - --- ----- --------- - - ------ - ------ -- -- ------ ----- -------- - -- -- -- --------- -- --------- - ----------- -------- - ----- -- -- - ----- ---- - - --------- --- ------------ -- ----------------- ------ ----- - - --
这个例子中,books
数组保存书籍,createBook
实现通过将输入对象添加到数组中来创建新书籍。我们可以测试这个操作,例如创建一本新书:
mutation { createBook(input: { title: "Title", author: "Author" }) { id title author } }
这个操作会返回一个包含 id
、title
和 author
字段的对象。
使用中间件和插件
Apollo Server 支持使用中间件和插件来扩展功能。中间件指的是在请求处理过程中执行的函数,例如身份验证、日志记录、缓存等。插件是 Apollo Server 的扩展,可以添加新的功能,例如支持数据源、文档生成、错误处理等。
我们可以使用 ApolloServer
的 applyMiddleware
和 applyPlugins
方法来添加中间件和插件。例如,我们可以添加 cors
中间件和 ApolloServerPluginSchemaReporting
插件:
-- -------------------- ---- ------- ----- - ------------- --- - - ------------------------- ----- ---- - ---------------- ----- - --------------------------------- - - ------------------------------ ----- -------- - ---- - --- -- ----- --------- - - - --- -- ----- ----- - --- ----- ------ - --- -------------- --------- ---------- -------- - ----------------------------------- - --- ------------------------ ---- ----- ---- ---
这个例子中,我们使用 cors
中间件允许跨域请求,使用 ApolloServerPluginSchemaReporting
插件收集 GraphQL Schema 相关指标。
处理错误和异常
最后,我们需要处理错误和异常,以便客户端能够得到明确的错误信息。在 GraphQL 中,我们可以使用 GraphQLNonNull
类型来定义非空字段,并使用 GraphQLScalarType
类型来验证输入类型。
例如,我们可以修改上面的 BookInput
类型,强制 title
和 author
字段不能为 null:
input BookInput { title: String! author: String! }
这个修改之后,如果客户端不提供 title
或 author
字段,服务端就会返回一个错误,而不是返回一个值为 null 的字段。如果我们想定制错误信息,可以定义一个自定义的错误类型:
-- -------------------- ---- ------- ----- - ------------- ---- ----------- - - ------------------------- ----- -------- - ---- - --- -- ----- --------- - - --------- - ----------- -------- - ----- -- -- - -- ------------- -- -------------- - ----- --- ------------------- ------- ----- --- -------- ----------------- - ----- ---- - - --------- --- ------------ -- ----------------- ------ ----- - - --
这个例子中,我们在 createBook
实现中检查 input
是否缺少 title
或 author
字段,如果是,则抛出一个带有错误信息和错误码的 ApolloError
错误。
总结
本文介绍了如何使用 Apollo Server 构建一个 GraphQL 服务器,并使用它来查询和修改数据。我们学习了如何定义 GraphQL Schema、实现查询和修改操作、使用中间件和插件、以及处理错误和异常。无论是构建 Web 应用、移动应用还是其他类型的应用,GraphQL 都是一个非常有用的 API 技术,特别是在数据模型复杂和需要多种数据源的情况下。如果你还没有尝试过 GraphQL,不妨试一试,相信它会让你的开发更加高效和愉悦。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/65b8e0e3add4f0e0ff170e1a