前言
GraphQL 是现代 Web 应用开发中的重要技术，其能使前端和后端开发者更快速更高效地协作开发。而 GraphQL Code Generator 则是一个非常有用的工具，它可以帮助开发者将 GraphQL 语言转换为可用的代码。我们今天要介绍的 npm 包 graphql-codegen-time 就是其中的一种。
graphql-codegen-time 可以生成一个 GraphQL 客户端的请求时间戳，帮助你检测 GraphQL API 响应时间，并可以将这些时间戳发送到指定的日志服务器中。有了它，前端工程师可以更加深入了解 GraphQL API 的性能。
在本篇文章中，我们将介绍如何使用 graphql-codegen-time 这个 npm 包，来对 GraphQL API 的响应时间进行监测。
什么是 GraphQL Code Generator
为了说明 graphql-codegen-time，我们必须先讲讲 GraphQL Code Generator 这个工具。GraphQL Code Generator 可以通过解析 GraphQL 的 schema 和 query 文档，来生成相应的代码，包括查询、类型定义和 TypeScript typings 等等。
它能够生成与 GraphQL schema 和 query 相关的代码和注释。同时，它也提供了许多模板选项，以使开发者能够轻松地生成他们所需要的代码。
该工具可以大大减少手动编写 GraphQL 相关代码的工作量，并且还会自动生成代码，因此开发者可以专注于开发基于 GraphQL 的应用程序。
什么是 graphql-codegen-time
graphql-codegen-time 是 GraphQL Code Generator 的一个插件。它可以在生成代码时为每个 GraphQL 查询添加一个请求时间戳，并将其发送到指定的日志服务器中。
它可以帮助开发人员更好地了解 GraphQL API 的性能，并寻找潜在的瓶颈。graphql-codegen-time 可以与许多日志服务器集成，例如 Logstash、Kibana 和 Elasticsearch 等。
如何使用 graphql-codegen-time
下面的步骤将向您展示如何安装和使用 graphql-codegen-time 的 npm 包。
1. 安装 GraphQL Code Generator
要使用 graphql-codegen-time，您需要先安装 GraphQL Code Generator 这个工具。在终端中输入以下命令：
npm install -g graphql-code-generator
2. 安装 graphql-codegen-time 插件
在终端中输入以下命令：
npm install graphql-codegen-time --save-dev
3. 创建配置文件
在项目根目录下创建一个名为 graphql.codegen.yaml 的文件，并添加以下内容：
-- -------------------- ---- -------
---------- ----
------- -----------------------------
---------- ------------------
----------
----------------------------
--------
- ----------
- ---------------------
- -----------------------
- --------------------
-------
---------------------
------------- ------------------------------这个配置文件告诉 GraphQL Code Generator 在 ./src/**/*.graphql 的所有文件中查找所有的 GraphQL 查询文件，并使用 typescript-operations 和 typescript-react-apollo 两个插件来生成相关的 TypeScript 代码和 React Hooks，还使用 graphql-codegen-time 插件生成请求时间戳和将其发送到日志服务器的代码。
注意，在 config 部分中，我们需要指定我们的日志服务器 URL，以便 graphql-codegen-time 可以将时间戳发送到它。
4. 运行 GraphQL Code Generator
在终端中输入以下命令：
graphql-codegen --config graphql.codegen.yaml
这个命令将根据上面配置文件所示的内容，生成相关的代码，并将请求时间戳发送到日志服务器。
5. 查看生成的代码
在 ./src/generated/ 目录下，您将会看到生成的代码文件（在这个例子里我们使用的是 graphql.tsx 文件）。这个文件中将包含所有查询操作和请求时间戳记录的代码。
示例代码
下面是一个示例的 GraphQL 查询和对应的 TypeScript 代码：
query getUser($id: ID!) {
user(id: $id) {
id
name
}
}-- -------------------- ---- -------
------ ---- --------------------- - -
--- --------------
--
------ ---- ------------ - -
- ------------ ------- -
- - ------ -------
- ------------ ------ -
- ---------- ---- - -------
-- -
- - -----------------------可以看到，graphql-codegen-time 插件在生成的 TypeScript 代码中添加了一个名为 GraphQLCodegenTimeData 的对象，这个对象包含了请求时间戳相关的数据。
结语
GraphQL Code Generator 是一个非常有用的工具，而 graphql-codegen-time 插件能够让我们更加深入地了解我们的 GraphQL API 表现，同时也可以帮助我们找出潜在的瓶颈点。在使用这个插件之前，我们需要安装 GraphQL Code Generator 和 graphql-codegen-time，然后配置生成 GraphQL 代码的细节并运行该命令即可。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedad41b5cbfe1ea0610c2a