module.exports và exports trong Node.js qua ví dụ

module.exports là giá trị mà một tệp Node.js trao cho bất kỳ tệp nào khác nạp nó bằng require(). Ban đầu nó là một object rỗng: thêm thuộc tính vào nó để export nhiều thứ, hoặc gán cho nó một giá trị mới (một hàm, một lớp) để export một thứ duy nhất. exports là một biến viết tắt trỏ đến cùng object đó, nên exports.add = ... vẫn hoạt động, nhưng exports = ... cắt đứt liên kết và không export gì cả.

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));

Chương trình in ra 5 20 3.14159, rồi [ 'add', 'multiply', 'PI' ]. Cả ba dòng trong math.js đều thêm thuộc tính vào cùng một object, dù đi qua module.exports hay exports, và require('./math') trả về chính object đó.

Export một hàm, một lớp hoặc một object

Khi module có một thứ chính, hãy gán nó trực tiếp cho module.exports. Nơi gọi khi đó nhận chính hàm đó, không phải một object bọc quanh nó:

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());

Chương trình in ra Hello, Ada và Grace (user). Nếu bạn gặp TypeError: greet is not a function, nơi gọi đã dùng sai dạng: viết const { greet } = require(...) cho thuộc tính của object và const greet = require(...) cho giá trị được gán trực tiếp.

module.exports và exports: cái bẫy khi gán lại

Trước khi tệp của bạn chạy, Node.js đặt exports = module.exports. Cả hai tên trỏ đến một object, và require trả về module.exports. Gán giá trị mới cho exports chỉ thay đổi biến cục bộ:

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 export ra {}, vì exports giờ trỏ đến một object mới mà không ai trả về. working.js export ra { version: 2 }.

Quy tắc đơn giản nhất: luôn viết module.exports. Cách này đúng trong mọi trường hợp, và code nói rõ nó làm gì.

require trả về cùng một object đã cache

Node.js chạy code của module một lần, ở lần đầu tiên nó được require, và cache module.exports. Mọi lần require sau đó với cùng tệp đều trả về chính object đó, nên trạng thái bên trong module được chia sẻ cho mọi tệp nạp nó:

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 chỉ xuất hiện một lần, b.next() trả về 3, và a === b là true, vì khóa của cache là đường dẫn tệp đã được phân giải, và ./counter với ./counter.js cùng trỏ tới một tệp. Đó là lý do một kết nối cơ sở dữ liệu hay một object cấu hình tạo trong một module được dùng chung cho cả app.

module.exports và ES module

ES module dùng export và import thay thế. Các dạng tương ứng với nhau như sau:

// 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';

Một ES module có thể import tệp CommonJS: module.exports của tệp đó trở thành default import. Từ Node.js 22.12, require() cũng nạp được ES module không có await ở cấp cao nhất. Để biết khi nào chọn cái nào, xem CommonJS và ES module.

Lỗi thường gặp

Trộn exports.x với module.exports = ... trong một tệp. Phép gán thay thế object, nên mọi exports.x viết trước đó đều mất. Hãy chọn một kiểu cho mỗi tệp.

Export một giá trị sẽ thay đổi sau này. module.exports = { count } sao chép con số tại thời điểm nạp; khi module cập nhật count, nơi gọi vẫn thấy giá trị cũ. Hãy export một hàm trả về giá trị đó, như counter.js ở trên.

Bỏ sót ./. require('math') tìm một package trong node_modules, không phải math.js nằm cạnh tệp của bạn. Tệp cục bộ luôn bắt đầu bằng ./ hoặc ../.