module.exports vs exports w Node.js, z przykładami

module.exports to wartość, którą plik Node.js daje każdemu innemu plikowi, który wczyta go przez require(). Na początku to pusty obiekt: dodaj do niego właściwości, żeby wyeksportować kilka rzeczy, albo przypisz mu nową wartość (funkcję, klasę), żeby wyeksportować jedną. exports to skrótowa zmienna wskazująca ten sam obiekt, więc exports.add = ... działa, ale exports = ... zrywa powiązanie i niczego nie eksportuje.

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

Wypisało 5 20 3.14159, a potem [ 'add', 'multiply', 'PI' ]. Wszystkie trzy linie w math.js dodały właściwości do tego samego obiektu, niezależnie od tego, czy przez module.exports, czy przez exports, a require('./math') zwróciło ten obiekt.

Eksport funkcji, klasy albo obiektu

Gdy moduł ma jedną główną rzecz, przypisz ją bezpośrednio do module.exports. Wywołujący dostaje wtedy samą funkcję, a nie obiekt wokół niej:

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

Wypisało Hello, Ada i Grace (user). Jeśli widzisz TypeError: greet is not a function, wywołujący użył złego kształtu: pisz const { greet } = require(...) dla właściwości obiektu i const greet = require(...) dla przypisanej wartości.

module.exports vs exports: pułapka z przypisaniem

Zanim twój plik się wykona, Node.js ustawia exports = module.exports. Obie nazwy wskazują jeden obiekt, a require zwraca module.exports. Przypisanie nowej wartości do exports zmienia tylko lokalną zmienną:

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 wyeksportował {}, bo exports wskazuje teraz nowy obiekt, którego nikt nie zwraca. working.js wyeksportował { version: 2 }.

Najprostsza zasada: zawsze pisz module.exports. Działa w każdym przypadku, a kod mówi, co robi.

require zwraca ten sam obiekt z cache

Node.js wykonuje kod modułu raz, przy pierwszym require, i zapisuje w cache module.exports. Każde kolejne require tego samego pliku zwraca ten sam obiekt, więc stan wewnątrz modułu jest wspólny dla każdego pliku, który go wczytuje:

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 pojawiło się raz, b.next() zwróciło 3, a a === b to true, bo kluczem cache jest rozwiązana ścieżka pliku, a ./counter i ./counter.js wskazują ten sam plik. Dlatego połączenie z bazą danych albo obiekt konfiguracji utworzony w jednym module jest wspólny dla całej aplikacji.

module.exports i moduły ES

Moduły ES używają zamiast tego export i import. Formy odpowiadają sobie tak:

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

Moduł ES może zaimportować plik CommonJS przez import: jego module.exports przychodzi jako import domyślny. Od Node.js 22.12 require() potrafi też wczytać moduł ES bez await na najwyższym poziomie. Kiedy wybrać które, przeczytasz w CommonJS vs moduły ES.

Częste błędy

Mieszanie exports.x z module.exports = ... w jednym pliku. Przypisanie zastępuje obiekt, więc każde exports.x zapisane wcześniej przepada. Wybierz jeden styl na plik.

Eksportowanie wartości, która później się zmienia. module.exports = { count } kopiuje liczbę w chwili wczytania; gdy moduł zaktualizuje count, wywołujący nadal widzą starą wartość. Eksportuj funkcję, która ją zwraca, jak counter.js powyżej.

Pomijanie ./. require('math') szuka pakietu w node_modules, a nie pliku math.js obok twojego pliku. Lokalne pliki zawsze zaczynają się od ./ albo ../.