Node.js module.exports 与 exports 的区别及示例

module.exports 是一个 Node.js 文件交给其他用 require() 加载它的文件的值。它一开始是一个空对象：给它添加属性可以导出多个东西，给它赋一个新值（一个函数、一个类）则只导出一个东西。exports 是一个指向同一个对象的简写变量，所以 exports.add = ... 有效，但 exports = ... 会切断这个联系，什么也导出不了。

const fs = require('fs');

// setup: write a second module next to index.js
fs.writeFileSync('math.js', `
module.exports.add = (a, b) => a + b;
exports.multiply = (a, b) => a * b;
module.exports.PI = 3.14159;
`);

const math = require('./math');

console.log(math.add(2, 3), math.multiply(4, 5), math.PI);
console.log(Object.keys(math));

它打印了 5 20 3.14159，然后是 [ 'add', 'multiply', 'PI' ]。math.js 中的三行都是在给同一个对象添加属性，无论是通过 module.exports 还是 exports，而 require('./math') 返回的正是这个对象。

导出一个函数、类或对象

当模块只有一个主要内容时，直接把它赋给 module.exports。这样调用者拿到的就是这个函数本身，而不是包着它的对象：

const fs = require('fs');

// setup: two modules, one exports a function, one a class
fs.writeFileSync('greet.js', `
module.exports = function greet(name) {
    return 'Hello, ' + name;
};
`);
fs.writeFileSync('user.js', `
class User {
    constructor(name) { this.name = name; }
    describe() { return this.name + ' (user)'; }
}
module.exports = User;
`);

const greet = require('./greet');
const User = require('./user');

console.log(greet('Ada'));
console.log(new User('Grace').describe());

它打印了 Hello, Ada 和 Grace (user)。如果你看到 TypeError: greet is not a function，说明调用者用错了形式：对象属性要写 const { greet } = require(...)，直接赋的值要写 const greet = require(...)。

module.exports 与 exports：重新赋值的陷阱

在你的文件运行之前，Node.js 会先设置 exports = module.exports。两个名字指向同一个对象，而 require 返回的是 module.exports。给 exports 赋一个新值，只会改变这个局部变量：

const fs = require('fs');

// setup: the same export written two ways
fs.writeFileSync('broken.js', 'exports = { version: 2 };');
fs.writeFileSync('working.js', 'module.exports = { version: 2 };');

console.log('broken:', require('./broken'));
console.log('working:', require('./working'));

broken.js 导出的是 {}，因为 exports 现在指向一个新对象，而没有任何东西返回它。working.js 导出的是 { version: 2 }。

最简单的规则：永远写 module.exports。它在任何情况下都有效，代码也能清楚地表达它在做什么。

require 返回同一个缓存对象

Node.js 只在模块第一次被 require 时运行一次它的代码，并缓存 module.exports。之后对同一个文件的每次 require 都返回同一个对象，所以模块内部的状态由所有加载它的文件共享：

const fs = require('fs');

// setup: a module that counts and logs when it loads
fs.writeFileSync('counter.js', `
console.log('counter.js is running');
let count = 0;
module.exports = { next: () => ++count };
`);

const a = require('./counter');
const b = require('./counter.js');

a.next();
a.next();
console.log('b sees', b.next());
console.log('same object:', a === b);

counter.js is running 只出现了一次，b.next() 返回 3，a === b 为 true，因为缓存的键是解析后的文件路径，而 ./counter 和 ./counter.js 解析到的是同一个文件。这就是为什么在一个模块中创建的数据库连接或配置对象会在整个应用中共享。

module.exports 与 ES 模块

ES 模块改用 export 和 import。两种写法的对应关系如下：

// CommonJS                              // ES modules
module.exports = greet;                  export default greet;
module.exports.add = add;                export { add };
const greet = require('./greet');        import greet from './greet.js';
const { add } = require('./math');       import { add } from './math.js';

ES 模块可以 import 一个 CommonJS 文件：它的 module.exports 会作为默认导入传过来。从 Node.js 22.12 开始，require() 也能加载没有顶层 await 的 ES 模块。什么时候选哪一种，请看 CommonJS 与 ES 模块。

常见错误

在同一个文件里混用 exports.x 和 module.exports = ...。 赋值会替换整个对象，所以在它之前写的每个 exports.x 都没了。每个文件只选一种写法。

导出一个之后会变化的值。 module.exports = { count } 在加载时复制了这个数字；当模块更新 count 时，调用者看到的仍是旧值。像上面的 counter.js 那样，导出一个返回该值的函数。

漏写了 ./。 require('math') 会去 node_modules 里找一个包，而不是找你文件旁边的 math.js。本地文件总是以 ./ 或 ../ 开头。