在前端领域中，GraphQL 资源的使用越来越普遍，而在约定大于配置的背景下，针对 GraphQL 文件的管理和组织也成为一个需要解决的问题。针对这个问题，我们介绍一款 npm 包：require-graphql-dir。本文将深入探讨该 npm 包的使用教程和指导意义。
require-graphql-dir 是什么？
require-graphql-dir 是一个 Node.js 模块，它允许您轻松地从一个目录中导入并管理 GraphQL 文件。该模块支持将类型定义和解析器代码分别放在不同文件中的情况，例如：
-- -------------------- ---- -------
-
--- ------
- --- -------------
- --- ----------------
- --- -----
- --- ------------
- --- ----
--- ---------
--- --------
--- -----------在以上目录结构中，类型定义分别放在 schema 目录下，而解析器代码则分别放在 resolvers 目录下，使用 require-graphql-dir 可以轻松导入 GraphQL 文件。
如何使用 require-graphql-dir？
首先，我们需要使用 npm 安装 require-graphql-dir，可以通过以下命令完成安装：
npm install require-graphql-dir
接下来，我们在我们的代码中引用这个包：
const requireGraphQL = require('require-graphql-dir');接下来，我们需要告诉 requireGraphQL 包我们希望从哪个目录导入 GraphQL 文件：
const typeDefs = requireGraphQL('./schema');
const resolvers = requireGraphQL('./resolvers');在完成以上两行代码后，我们可以通过 typeDefs 和 resolvers 这两个变量获取到导入的 GraphQL 文件。
例如，我们可以将 typeDefs 和 resolvers 传递给 ApolloServer 或者其他 GraphQL 服务器，并启动一个 GraphQL API 服务。示例代码如下：
-- -------------------- ---- ------- ----- - ------------ - - ------------------------- ----- -------------- - ------------------------------- ----- -------- - --------------------------- ----- --------- - ------------------------------ ----- ------ - --- -------------- --------- --------- --- ----------------------- --- -- -- - -------------------- --- ------ ----- -- --------- ---
在这个示例代码中，我们可以看到 requireGraphQL 负责将我们希望导入的 GraphQL 文件在导入时编译（使用 graphql-tag 库），并返回一个导出了类型定义和解析器的对象。接着，我们可以将该对象传递给 ApolloServer 即可。
require-graphql-dir 的指导意义
require-graphql-dir 包的设计目的是方便我们处理分散的 GraphQL 文件，并遵循约定大于配置的理念。它支持不同 GraphQL 文件的导入方式，例如：
- 导入查询类型定义文件。
- 导入突变类型定义文件。
- 导入对象类型定义文件。
- 导入标量类型定义文件。
- 导入接口类型定义文件。
- 导入 Union 类型定义文件。
- 导入枚举类型定义文件。
同时，require-graphql-dir 还支持在解析器中更好的组织和导入 GraphQL 文件，您可以将一个 GraphQL 文件的解释器代码拆分为多个文件，并在 resolvers 目录中按约定导入，例如：
-- -------------------- ---- ------- -- -------- ----- - ---- - - ------------------- ----- ----- - - ------ -- -- ------------ --- -- -------------- - ------
使用 require-graphql-dir 时，这种拆分查询解释器代码的方法很常见。
总的来说，require-graphql-dir 对于许多团队来说是一个非常有用的工具，它使得组织并维护 GraphQL 代码库变得更容易，并且提供了一种约定简单且易于遵循的方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005775181e8991b448eacef