前言
GraphQL 是一种用于 API 的查询语言和运行时环境，是由 Facebook 在2012年开发并于2015年开源。其目标是提供客户端所需的关系数据，让客户端能够根据需要精确地获取数据。
在前端领域中，我们经常需要使用 GraphQL 来进行数据请求。而对于 GraphQL 的服务端，我们可能在使用 Apollo Server 等类似的 API 框架时，需要对 gql 语法进行异常监控，以便于我们快速解决问题。那么，今天就给大家介绍一款基于 Node.js 的 npm 包——graphql-radar。
graphql-radar 的安装
安装这个 npm 包比较简单，直接使用以下命令即可：
npm install graphql-radar -D
安装完成之后，我们就可以在需要的地方使用它了。
graphql-radar 的使用
在使用 graphql-radar 时，我们需要在 Apollo Server 的 setup 中进行配置。这个配置使用起来比较简单，只需要按照以下方式使用即可：
import { ApolloServer } from "apollo-server";
import { RadarPlugin } from 'graphql-radar';
const server = new ApolloServer({
typeDefs,
resolvers,
plugins: [RadarPlugin()],
});在上面的代码中，我们导入了 ApolloServer，RadarPlugin，并在 ApolloServer 的 setup 中进行配置。
接下来，我们可以使用 graphql-radar 来监控我们代码中的 gql 语句。在我们完成配置之后，如果我们的 gql 语句出错了，就会抛出异常，这让我们能够快速定位出问题的原因。
graphql-radar 的深入学习
在使用 graphql-radar 时，我们需要了解以下两点：
- 错误原因的定位
- 如何处理错误
错误原因的定位
当我们在使用 graphql-radar 时，如果 gql 语句出现了错误，我们需要如何找到错误的原因呢？
实际上，只要我们在编辑器中设置了相应的快捷键，就能轻松地找到错误所在的地方。比如在 VS Code 中，我们可以在 settings.json 文件中添加以下代码：
-- -------------------- ---- -------
-
-------------------------- -
---------- ----
--
-------------------------- --------
----------------------- -----
------------------ -----
------------------------ -----
----------------- --
--------------------------- -----
-------------------------------------------- -----
----------------------------- -------
---------------------------------- -------
------------------------------------ ---
-在上面的代码中，我们添加了一个名为 graphql.radar.viewer.highlightQueryErrors 的配置项，它会使得代码中出现的错误标红，这样能够让我们找到错误很方便。
如何处理错误
当我们使用 graphql-radar 进行 gql 监控时，有可能遇到如下错误：
Error: GraphQL Error (Code: 400): Syntax Error: Unexpected Name "Get" (line 3, column 3):
2 |
3 | Get
| ^
4 | customers {出现这个错误是因为我们在写 gql 语句的时候，拼写出现了错误。
出现这种情况后，我们需要先进行代码审查，找到错别字或者写错字段的地方。一般情况下，这种错误都是可修复的。
如果你不知道怎么写出正确的 gql 语句，可以参考以下示例。
示例代码
在下面的代码中，我们会使用 graphql-radar 来监控我们写的 gql 语句。
我们首先需要安装项目所需要的依赖：
npm install graphql apollo-server graphql-radar
在安装完成后，我们就可以开始我们的代码实现了：
index.js
-- -------------------- ---- -------
----- - ------------- --- - - -------------------------
----- - ----------- - - -------------------------
----- -------- - ----
---- ----- -
------ ------
-
--
----- --------- - -
------ -
------ -- -- --------
--
--
----- ------ - --- --------------
---------
----------
-------- ----------------
---
----------------------- --- -- -- -
------------------- ----- -- ---------
---我们启动程序后，可以在终端上看到以下信息：
Server ready at http://localhost:4000/
我们现在就可以在浏览器中访问 http://localhost:4000/，看到我们运行时返回的响应。
以上就是关于 graphql-radar 的使用教程和示例代码了，需要注意的是，使用这个工具只是监控错误，我们仍需要使用正确规范的 gql 语句来保证程序的正确性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006734e890c4f72775837d0