Node.js Express实现URL触发返回对应JSON文件的优化方案

这是个很常见的重复代码问题，咱们可以通过动态读取目录+自动生成路由的方式彻底解决，以后新增JSON文件再也不用手动写路由了！核心思路是：让程序自动扫描指定目录下的JSON文件，为每个文件生成对应的/api/[文件名]路由，完全省去硬编码的麻烦。

实现步骤（以Express框架为例） #

假设你的项目结构如下（把所有JSON文件统一放在data目录下）：

your-project/
├── data/          # 存放所有JSON数据文件
│   ├── user.json
│   ├── product.json
│   └── order.json
├── app.js         # 主服务文件
└── package.json

1. 核心代码实现 #

在app.js中编写以下代码，它会自动读取data目录下的JSON文件并注册路由：

const express = require('express');
const fs = require('fs/promises');
const path = require('path');
const app = express();
const PORT = 8081;

// 定义JSON文件的存放目录（绝对路径，避免相对路径问题）
const JSON_DATA_DIR = path.join(__dirname, 'data');

// 缓存JSON数据（如果文件不频繁修改，缓存能大幅提升请求性能）
const jsonDataCache = {};

// 加载所有JSON文件到缓存
async function loadJsonDataToCache() {
  try {
    // 读取目录下的所有文件
    const files = await fs.readdir(JSON_DATA_DIR);
    // 过滤出仅JSON后缀的文件
    const jsonFiles = files.filter(file => path.extname(file) === '.json');

    for (const file of jsonFiles) {
      // 提取路由名称（去掉.json后缀）
      const routeName = path.basename(file, '.json');
      // 读取文件内容并解析为JSON
      const filePath = path.join(JSON_DATA_DIR, file);
      const jsonContent = await fs.readFile(filePath, 'utf8');
      jsonDataCache[routeName] = JSON.parse(jsonContent);
      console.log(`Loaded data for route: /api/${routeName}`);
    }
  } catch (err) {
    console.error('Failed to load JSON data:', err);
  }
}

// 动态注册路由
async function registerDynamicRoutes() {
  await loadJsonDataToCache();

  // 遍历缓存中的数据，为每个条目创建路由
  for (const [routeName, data] of Object.entries(jsonDataCache)) {
    const routePath = `/api/${routeName}`;
    app.get(routePath, (req, res) => {
      res.json(data);
    });
    console.log(`Registered route: ${routePath}`);
  }
}

// 先加载数据并注册路由，再启动服务器
registerDynamicRoutes().then(() => {
  app.listen(PORT, () => {
    console.log(`Server running at http://localhost:${PORT}`);
  });
});

2. 新增JSON文件的操作 #

以后你只需要把新的JSON文件（比如settings.json）放到data目录下，重启服务器（或者用nodemon实现热重载），程序就会自动注册/api/settings路由，无需编写任何额外代码。

额外优化建议 #

• 热重载支持：如果不想每次新增文件都重启服务器，可以用fs.watch监听data目录的变化，当文件新增/修改时自动更新缓存和路由。示例代码片段：

  // 监听data目录变化
  fs.watch(JSON_DATA_DIR, async (eventType, filename) => {
    if (filename && path.extname(filename) === '.json') {
      const routeName = path.basename(filename, '.json');
      const filePath = path.join(JSON_DATA_DIR, filename);
      const jsonContent = await fs.readFile(filePath, 'utf8');
      jsonDataCache[routeName] = JSON.parse(jsonContent);
      // 更新路由（如果已存在则先删除再重新注册）
      app._router.stack = app._router.stack.filter(layer => layer.path !== `/api/${routeName}`);
      app.get(`/api/${routeName}`, (req, res) => res.json(jsonDataCache[routeName]));
      console.log(`Updated route: /api/${routeName}`);
    }
  });
  

• 错误处理增强：可以添加JSON解析失败、文件不存在等场景的错误响应，比如当某个JSON文件格式不合法时，返回500错误并提示具体信息。
• 原生HTTP模块适配：如果你不用Express，用Node.js原生http模块也能实现类似逻辑，核心是解析请求URL，匹配缓存中的路由名称并返回对应数据。

内容的提问来源于stack exchange，提问作者I am a Student