如何保持GraphQL API整洁？Express+GraphQL项目结构优化问询

我完全懂你的痛点——手动挨个导入每个业务模块的types.js、queries.js和mutations.js，随着模块越来越多，index.js很快就会变成一个臃肿难维护的“大杂烩”。下面是几个实用方案，帮你自动化处理导入逻辑，让代码保持整洁：

方案一：用Node.js原生fs模块自动遍历目录 #

借助Node.js的fs和path模块，我们可以自动扫描api下的所有子目录，批量加载目标文件并合并到根查询/变更中。

具体实现： #

在index.js中替换原有手动导入的代码，改成以下逻辑：

const fs = require('fs');
const path = require('path');
const { GraphQLObjectType, GraphQLSchema } = require('graphql');

// 封装加载指定类型文件的工具函数
const loadModuleFiles = (targetFileType) => {
  const mergedExports = {};
  // 遍历api下的所有业务子目录
  fs.readdirSync(__dirname).forEach((folder) => {
    const folderPath = path.join(__dirname, folder);
    // 跳过非目录文件（比如index.js本身）
    if (!fs.statSync(folderPath).isDirectory()) return;
    
    const targetFilePath = path.join(folderPath, `${targetFileType}.js`);
    // 如果目录下存在目标文件，就导入并合并导出内容
    if (fs.existsSync(targetFilePath)) {
      const moduleContent = require(targetFilePath);
      Object.assign(mergedExports, moduleContent);
    }
  });
  return mergedExports;
};

// 批量加载所有类型、查询、变更
const allTypes = loadModuleFiles('types');
const allQueries = loadModuleFiles('queries');
const allMutations = loadModuleFiles('mutations');

// 构建根查询和根变更
const RootQuery = new GraphQLObjectType({
  name: 'RootQuery',
  fields: allQueries,
});

const RootMutation = new GraphQLObjectType({
  name: 'RootMutation',
  fields: allMutations,
});

// 导出最终Schema
module.exports = new GraphQLSchema({
  query: RootQuery,
  mutation: RootMutation,
});

同时要保证每个业务模块的文件导出结构统一，比如entry/queries.js要导出包含查询字段的对象：

module.exports = {
  getSingleEntry: {
    // 你的查询定义逻辑...
  },
  listAllEntries: {
    // 你的查询定义逻辑...
  }
};

以后新增业务模块时，只要按现有目录结构创建types.js、queries.js、mutations.js，index.js会自动加载它们，完全不用手动修改。

方案二：用glob工具简化目录匹配 #

如果觉得原生fs的遍历逻辑有点繁琐，可以用glob包来更简洁地匹配文件路径：

1. 先安装依赖：

npm install glob

2. 修改index.js的加载逻辑：

const glob = require('glob');
const path = require('path');
const { GraphQLObjectType, GraphQLSchema } = require('graphql');

const loadModules = (filePattern) => {
  const mergedExports = {};
  // 匹配所有子目录下的目标文件
  glob.sync(filePattern, { cwd: __dirname }).forEach((filePath) => {
    const moduleContent = require(path.resolve(__dirname, filePath));
    Object.assign(mergedExports, moduleContent);
  });
  return mergedExports;
};

// 一行代码匹配所有对应文件
const allTypes = loadModules('./**/types.js');
const allQueries = loadModules('./**/queries.js');
const allMutations = loadModules('./**/mutations.js');

// 后续构建Schema的代码和方案一一致...

glob的通配符./**/types.js会自动递归匹配所有子目录下的types.js文件，代码更简洁直观。

注意事项 #

• 要避免不同模块的字段命名冲突（比如两个模块都定义了getItem查询），可以给字段名加上模块前缀，比如getEntryItem、getCategoryItem。
• 如果你的项目用ES模块（import/export），可以把require换成import()动态导入，配合Promise.all处理异步加载逻辑。

这样改造后，index.js就能一直保持简洁，新增模块也不用再手动维护导入列表啦！

内容的提问来源于stack exchange，提问作者user9583005