Node.js模块应通过module.exports精确导出API,避免exports重赋值;优先导出工厂函数、单例或命名空间,用闭包隐藏私有类,并通过index.js统一暴露稳定接口。

在 Node.js 模块系统中,exports(或 module.exports)是控制模块对外暴露接口的唯一出口。它不只决定“哪些变量能被 require”,更关键的是——**通过精心设计 exports 结构,你可以完全隐藏内部类、工具函数、中间状态等实现细节,只暴露稳定、语义清晰的 API**。
用 module.exports 替代 exports 赋值,避免引用丢失
exports 本质是 module.exports 的快捷引用,但一旦你对 exports 重新赋值(比如 exports = {...}),就会切断这个引用,导致外部 require 得到空对象。要精确控制暴露内容,必须统一使用 module.exports:
- ✅ 正确:直接赋值
module.exports = { init, createClient } - ❌ 错误:
exports = { init, createClient }(此时require()返回{}) - ⚠️ 可用但易错:
exports.init = init+exports.createClient = createClient(仅适用于逐步挂载)
只暴露构造函数或工厂方法,不导出类本身
如果你有一个核心类 DatabaseConnection,不要直接 module.exports = DatabaseConnection。这会让使用者依赖具体类名、继承结构甚至私有属性命名,破坏封装性。应提供语义化入口:
- 导出工厂函数:
module.exports = { createConnection: (config) => new DatabaseConnection(config) } - 导出单例实例(如配置中心):
module.exports = new ConfigManager()(内部已封装初始化逻辑) - 导出命名空间对象,含方法和常量:
module.exports = { Client: { connect(), disconnect() }, STATUS: { READY, ERROR } }
用闭包隔离私有实现,禁止外部访问底层类
将类定义放在模块顶层作用域内,但不将其挂到 module.exports 上。借助函数作用域,让导出的方法能访问这些“私有类”,而外部无法 require 或 new 它们:
const ConnectionPool = class { /* 内部连接池实现 */ };const QueryExecutor = class { /* 内部执行器 */ };module.exports = { createClient(config) { const pool = new ConnectionPool(config); return { execute: (sql) => new QueryExecutor(pool).run(sql) }; }};
这里 ConnectionPool 和 QueryExecutor 在模块外不可见,用户只能通过 createClient 获取抽象后的客户端对象。
配合 index.js 统一导出,隐藏子模块路径
当项目结构变复杂(如 lib/connection/Pool.js、lib/query/Executor.js),别让用户 require('mydb/lib/connection/Pool')。在 index.js 中集中 import 并筛选导出:
- 只 re-export 稳定接口:
const { createClient } = require('./lib/client'); - 绝不导出内部模块:
// ❌ 不写:const Pool = require('./lib/connection/Pool'); - 可导出类型定义(TypeScript)或文档常量,但不暴露实现类

















