Module in Node.js

Die Node.js-Umbebung verfügt über ein einfaches Modul-System. Ein Modul ist dabei ein Programm dessen Bestimmung darin liegt, von einem anderem Programm aus aufgerufen und verwendet zu werden.

Zum einem besitzt Node.js bereits Basis-Module die fest in die Umgebung integriert sind. Und zum anderem können auch weitere Module nachinstalliert, oder gar selbst geschrieben werden. Im folgenden gehe ich auf alle 3 Arten von Modulen genauer ein.

Basis-Module #

Alle Basis-Module sind Funktions-Biblioteken, die grundlegende Aufgaben wie z.B. den Umgang mit dem Betriebsystem, Netzwerk-Technologien oder Verschlüsselungen abdecken.

Um ein Modul in ein Node.js-Programm zu laden, verwendet man die Funktion require(). Sie erwartet als Parameter einen String, der den Pfad des Modules enthält, im Falle von Basis-Modulen reicht dazu der Name.

Beispiel #

Das folgende Beispiel schreibt den Namen der Plattform, unter der es ausgeführt wird, in die Konsole. Dabei wird das Basis-Modul os verwendet:

var os = require('os');
var platform = os.platform();
console.log(platform);

In der ersten Zeile wird in die Variable os das gleichnamige Modul os geladen. In der zweiten Zeile wird der Name der Plattform mit der Funktion os.platform() ermittelt, und in die Variable platform gespeichert. Und in der dritten Zeile wird die Variable platform nun in die Konsole geschrieben, dazu wird die Funktion console.log() verwendet.

Module installieren mit NPM

Bei der Installation von Node.js wird standardmäßig der Paketmanager NPM (Abkürzung für Node Packaged Modules) mit installiert. Er ermöglich das einfache installieren, verwalten und veröffentlichen von Modulen. Abhängigkeiten von Modulen untereinander werden beachtet: benötigt ein Modul ein anderes Modul, wird es bei der Installation gleich mit installiert.

Während die meisten Basis-Module nur grundlegende Bereiche abdecken, können wir nachinstallierte Modulen auch für spezielle Einsatzgebiete verwenden. Häufig basieren diese auf den Basis-Modulen.

Beispiel #

Als Beispiel wollen wir die Konsolenausgabe farblich hervorheben, wozu wir das Modul colors verwenden.

Um das Modul zu verwenden, muss es zunächst installiert werden. Dazu nehmen wir den Konsolen-Befehl npm install, der ein Modul in angewähltem Verzeichnis installiert:

npm install colors

Nach erfolgreich-abgeschlossener Installation können wir das soeben installierte Modul verwenden. Unser Beispiel-Code sieht wie folgt aus:

var colors = require('colors');
console.log('Ein standard Text');
console.log('Ein roter Text'.red);
console.log('Und ein Regenbogen'.rainbow);

In der ersten Zeile wird das Modul colors in die gleichnamige Variable colors geladen. In der zweiten, dritten und vierten Zeile wird die Funktion console.log() aufgerufen. Beim ersten mal mit der standard-Textfarbe, beim zweiten mal in roter- und beim dritten mal in Regenbogen-Farbe.

Wenn wir nun das Programm ausführen, bekommen wir die drei Zeilen Text in der Konsole angezeigt (siehe Screenshot). Weitere Node.js-Module findest du hier.

Module selbst schreiben #

Als letztes wollen wir ein eigenes Node.js-Modul schreiben, wozu innerhalb eines Modules das Objekt exports zur Verfügung steht. In der Dokumentation befindet sich dazu das Beispiel-Modul circle.js:

var PI = Math.PI;

exports.area = function (r) {
  return PI * r * r;
};

exports.circumference = function (r) {
  return 2 * PI * r;
};

Dieses Modul stellt die zwei Funktionen area() und circumference() bereit. Es kann beispielsweise in dem Programm foo.js aufgerufen werden:

var circle = require('./circle.js');
console.log( 'The area of a circle of radius 4 is '
           + circle.area(4));

Im Unterschied zu den Basis- oder nachinstallierten Modulen, müssen wir bei selbst geschriebenen Modulen nicht nur den Namen, sondern auch den Pfad in dem sich das Modul befindet an die Funktion require() übergeben. Da sich im Beispiel das Modul circle.js im selbem Verzeichnis wie foo.js befindet, übergeben wir in der ersten Zeile an die Funktion require() den Dateipfad ./circle.js.

module.exports #

Falls das Modul jedoch nur eine Funktion enthalten soll, oder man aus sonstigen Gründen Zugriff auf das komplette Exports-Objekt braucht, kann man anstelle von exports die Variable module.exports verwenden.

Auch hierfür gibt es ein Beispiel, das Modul square.js:

module.exports = function(width) {
  return {
    area: function() {
      return width * width;
    }
  };
}

Diesmal kann die Variable square direkt als Funktion aufgerufen werden, was in der zweiten Zeile geschieht:

var square = require('./square.js');
var mySquare = square(2);
console.log('The area of my square is ' + mySquare.area());