本文档旨在指导开发者如何在 Express.js 项目中，将传统的 `require` 语句替换为 ES 模块的 `import` 语法，特别是在 `app.use()` 中动态引入路由模块的场景下，解决在使用 `type: "module"` 时遇到的问题，并提供清晰的代码示例和注意事项。
在 Node.js 项目中使用 ES 模块 (ESM) 可以带来更好的代码组织和模块化能力。当你的 package.json 中设置了 type: "module" 时，你需要使用 import 语句代替 require。然而，在某些情况下，例如在 app.use() 中动态引入路由，直接替换可能会遇到问题。本文将介绍如何正确地使用 import 来实现类似的功能。
使用 import 动态加载路由
原先使用 require 的代码如下：
import express from "express";
import fs from "fs";
const app = express();
fs.readdirSync("./routes").map((r) =>
app.use("/api", require(`./routes/${r}`)));
app.listen(8000, () => console.log(`Server running on port ${port}`));这段代码读取 ./routes 目录下的所有文件，并将它们作为路由中间件添加到 Express 应用中。 要将 require 替换为 import，需要使用 import() 函数，它返回一个 Promise，因此需要使用 await 关键字。 此外，ES 模块导出的通常是一个对象，其中包含 default 属性，该属性指向模块的默认导出。
以下是修改后的代码：
import express from"express"; import fs from "fs"; const app = express(); async function loadRoutes() { for (const r of fs.readdirSync("./routes")) { const module = await import(`./routes/${r}`); app.use("/api", module.default); } } loadRoutes(); app.listen(8000, () => console.log(`Server running on port 8000`));
"express";
import fs from "fs";
const app = express();
async function loadRoutes() {
for (const r of fs.readdirSync("./routes")) {
const module = await import(`./routes/${r}`);
app.use("/api", module.default);
}
}
loadRoutes();
app.listen(8000, () => console.log(`Server running on port 8000`));代码解释:
- async function loadRoutes(): 定义一个异步函数，用于加载路由。这是因为 await 只能在异步函数中使用。
- for...of 循环: 使用 for...of 循环遍历 fs.readdirSync("./routes") 返回的数组。 map 方法在这里并不合适，因为它会立即执行所有异步操作，可能导致路由加载顺序不确定。
- await import(\./routes/\${r}`)`: 使用 import() 函数动态导入路由模块。 await 关键字确保在模块加载完成后再执行后续代码。
- module.default: 由于 ES 模块的默认导出通常存储在 default 属性中，所以使用 module.default 来获取路由中间件。
- loadRoutes(): 调用 loadRoutes() 函数，启动路由加载过程。
路由模块的导出
确保你的路由模块使用 export default 导出路由：
import express from "express";
import { register, login } from "../controllers/auth.js";
const router = express.Router();
router.post("/register", register);
router.post("/login", login);
export default router;注意事项
- 异步加载: 由于 import() 是一个异步操作，因此路由的加载是异步的。确保你的应用在所有路由加载完成后再开始监听端口。
- 错误处理: 在实际应用中，应该添加错误处理机制，以处理模块加载失败的情况。
- 模块路径: 确保模块路径正确，并且相对于当前文件的位置。
- type: "module": 确认 package.json 中已经设置 type: "module"。
- 兼容性: 确保你的 Node.js 版本支持 ES 模块。
总结
通过使用 import() 和 await 关键字，我们可以很容易地将 require 替换为 import，并在 Express.js 应用中动态加载路由模块。 记住，ES 模块的默认导出通常存储在 default 属性中，因此需要使用 module.default 来获取路由中间件。 此外，确保处理异步加载和潜在的错误情况。
