Node.js module.exports vs. exports, mit Beispielen

module.exports ist der Wert, den eine Node.js-Datei jeder anderen Datei gibt, die sie mit require() lädt. Es beginnt als leeres Objekt: Füg ihm Eigenschaften hinzu, um mehrere Dinge zu exportieren, oder weis ihm einen neuen Wert zu (eine Funktion, eine Klasse), um eine Sache zu exportieren. exports ist eine Kurzform-Variable, die auf dasselbe Objekt zeigt, exports.add = ... funktioniert also, aber exports = ... kappt die Verbindung und exportiert nichts.

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

Es hat 5 20 3.14159 ausgegeben, dann [ 'add', 'multiply', 'PI' ]. Alle drei Zeilen in math.js haben Eigenschaften zum selben Objekt hinzugefügt, egal ob über module.exports oder exports, und require('./math') hat dieses Objekt zurückgegeben.

Eine Funktion, eine Klasse oder ein Objekt exportieren

Wenn ein Modul eine Hauptsache hat, weis sie direkt module.exports zu. Der Aufrufer bekommt dann die Funktion selbst, kein Objekt drumherum:

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

Es hat Hello, Ada und Grace (user) ausgegeben. Wenn du TypeError: greet is not a function siehst, hat der Aufrufer die falsche Form benutzt: Schreib const { greet } = require(...) für eine Objekteigenschaft und const greet = require(...) für einen zugewiesenen Wert.

module.exports vs. exports: die Falle bei Neuzuweisung

Bevor deine Datei läuft, setzt Node.js exports = module.exports. Beide Namen zeigen auf ein Objekt, und require gibt module.exports zurück. Ein neuer Wert für exports ändert nur die lokale Variable:

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 hat {} exportiert, weil exports jetzt auf ein neues Objekt zeigt, das niemand zurückgibt. working.js hat { version: 2 } exportiert.

Die einfachste Regel: Schreib immer module.exports. Das funktioniert in jedem Fall, und der Code sagt, was er tut.

require gibt dasselbe gecachte Objekt zurück

Node.js führt den Code eines Moduls einmal aus, beim ersten require, und cacht module.exports. Jedes spätere require derselben Datei gibt genau dieses Objekt zurück, Zustand in einem Modul wird also von jeder Datei geteilt, die es lädt:

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 erschien einmal, b.next() gab 3 zurück, und a === b ist true, weil der Cache-Schlüssel der aufgelöste Dateipfad ist und ./counter und ./counter.js auf dieselbe Datei zeigen. Deshalb wird eine Datenbankverbindung oder ein Config-Objekt, das in einem Modul erstellt wird, in der ganzen App geteilt.

module.exports und ES-Module

ES-Module nutzen stattdessen export und import. Die Formen entsprechen sich so:

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

Ein ES-Modul kann eine CommonJS-Datei mit import laden: Ihr module.exports kommt als Default-Import an. Seit Node.js 22.12 kann require() auch ein ES-Modul ohne Top-Level-await laden. Wann du welches nimmst, steht unter CommonJS vs. ES-Module.

Häufige Fehler

exports.x und module.exports = ... in einer Datei mischen. Die Zuweisung ersetzt das Objekt, jedes exports.x, das davor steht, ist also weg. Nimm einen Stil pro Datei.

Einen Wert exportieren, der sich später ändert. module.exports = { count } kopiert die Zahl beim Laden; wenn das Modul count aktualisiert, sehen Aufrufer weiterhin den alten Wert. Exportier eine Funktion, die ihn zurückgibt, wie counter.js oben.

./ weglassen. require('math') sucht ein Paket in node_modules, nicht math.js neben deiner Datei. Lokale Dateien beginnen immer mit ./ oder ../.