Node.js-Architektur: acht hilfreiche Tipps
Es gibt viele gute Gründe, warum man sich vor und während der Entwicklung einer Node.js-Applikation Gedanken über die Architektur machen sollte. Einer der wichtigsten Gründe ist, dass stetig neue Anforderungen an die eigene Applikation gestellt werden und sich diese im Lauf der Zeit auch ändern können. Deshalb sollte die Applikation mithilfe einer guten Node.js-Architektur über ein gewisses Maß an Flexibilität verfügen.
Nicht nur aus Anforderungssicht ist eine stabile und konsistente Architektur in einer Node.js-Applikation wichtig, sie hilft auch beim Umgang mit dem stetigen Wandel, dem Sie in der JavaScript-Welt gegenüberstehen. In diesem Artikel lernen Sie einige Aspekte von Node.js-Architekturen kennen, die Sie in Ihrer Applikation anwenden können, um Ihren Arbeitsalltag zu erleichtern.
Allgemein: Werkzeugunterstützung nutzen
Für zahlreiche Problemstellungen in der Entwicklung von Node.js-Applikationen gibt es mittlerweile einige Werkzeuge, die Sie bei der Arbeit unterstützen. Generell sollten Sie allerdings darauf achten, dass Sie sich wiederholende Aufgaben möglichst durch den Einsatz von Werkzeugen oder Bibliotheken automatisieren. Das spart Zeit und reduziert Fehlerpotenzial.
Ein Beispiel für ein solches Werkzeug ist ESLint, ein Werkzeug zur statischen Codeanalyse für JavaScript. ESLint lässt sich mit wenigen Handgriffen in ein Projekt einbinden und dann sowohl als Aktion im Build-Prozess der Applikation als auch direkt im Entwicklungsprozess als Plug-in der Entwicklungsumgebung integrieren. Einigen Sie sich im Projektteam auf einen Codestandard wie ihn beispielsweise der Airbnb Style Guide vorgibt, können Sie ESLint dazu verwenden, die Einhaltung des Codestandards sicherzustellen. Es gibt einige weitere Aspekte, die zu einer guten Node.js-Architektur beitragen – acht hilfreiche Tipps und Tricks habe ich zusammengetragen.
1. Modularisierung
Node.js verfügt über ein Modulsystem, mit dem Sie Ihre Applikation in kleinere Einheiten strukturieren können. Damit lässt sich das Single-Responsibility-Prinzip umsetzen. Es besagt, dass jedes Modul und jede Klasse nur eine bestimmte Verantwortung hat, sich nur um eine bestimmte Sache kümmern soll. Halten Sie das Prinzip ein, komponieren Sie Ihre Applikation aus einer Menge kleinerer Bausteine. Diese sollten untereinander in einer möglichst losen Verbindung stehen, um die Unabhängigkeit sicherzustellen. Bauen Sie Ihre Applikation nach diesem Prinzip auf, haben Sie die Möglichkeit, einzelne Module unabhängig von der Gesamtapplikation zu modernisieren oder auszutauschen.
Schon in den ersten Versionen von Node.js wurde ein solcher modularer Aufbau durch das Modulsystem unterstützt. Ursprünglich kam das CommonJS-Modulsystem mit der require-Funktion für den Import von Modulen und dem module.exports-Konstrukt zum Exportieren von Schnittstellen zum Einsatz. Seit einigen Versionen wird auch das ECMAScript-Modulsystem unterstützt. Dieses ist zunächst standardmäßig deaktiviert und muss von Ihnen durch die Option --experimental-modules aktiviert werden. Das Modulsystem arbeitet mit den Schlüsselwörtern import zum Laden von Modulen und export zur Definition von Schnittstellen. Die Dateien, die das ECMAScript-Modulsystem verwenden, müssen auf .mjs statt auf .js enden. Berücksichtigen Sie das nicht, erhalten Sie eine Fehlermeldung.
Im Gegensatz zu clientseitigem JavaScript müssen Sie sich bei Node.js nicht um Bundling oder die Optimierung von Quellcode kümmern, da der Quellcode auf dem Server zur Verfügung steht, wo er ausgeführt wird; der Transfer des Codes über eine Netzwerkverbindung entfällt. Das Node.js-Modulsystem weist außerdem Optimierungen auf, die dafür sorgen, dass durch eine Aufteilung in eine Vielzahl kleiner Dateien keine Performancenachteile entstehen. Ein Teil dieser Optimierungen stammt direkt aus dem Kern von Node.js. Beim Start der Applikation werden alle direkt erreichbaren Importe evaluiert, die Dateien von der JavaScript-Engine eingelesen und in Bytecode umgewandelt. Das führt allerdings dazu, dass Sie während des Entwicklungsprozesses den Node.js-Prozess neu starten müssen, damit die Änderungen wirksam werden.
Eine weitere Optimierung betrifft das Caching-Verhalten bei Modulen. Binden Sie ein Modul über import oder require ein, wird der Code ausgeführt. Das führt dazu, dass sämtliche Seiteneffekte wie beispielsweise Funktionsaufrufe direkt im Modul wirksam werden. Das Ergebnis der Modulausführung, also die öffentliche Schnittstelle, wird dann in den Modulcache geschrieben. Binden Sie dann das Modul ein zweites Mal an einer anderen Stelle in Ihrer Applikation ein, wird das Modul nicht erneut ausgeführt, sondern das Ergebnis aus dem Cache verwendet. Das führt dazu, dass keinerlei Seiteneffekte mehr auftreten. Statt den Modulcache zu leeren, sollten Sie für gewollte Seiteneffekte Funktionen exportieren und explizit ausführen, da Ihr Quellcode damit besser lesbar wird (Listing 1).
import {add} from './calculator';
export const summarize = (data) => data.reduce(
(prev, current) => add(prev, current),
0);Listing 1: Modularisierung mit dem ECMAScript-Modulsystem
2. Verzeichnisstruktur
Direkt mit der Modularisierung einer Applikation hängt die Strukturierung des Quellcodes im Dateisystem zusammen. In diesem Zusammenhang haben sich in den vergangenen Jahren einige Erfolgsmodelle herausgebildet, die allesamt das Ziel verfolgen, eine Applikation übersichtlich zu halten, auch wenn der Funktionsumfang stetig wächst. Allgemein sollten Sie mit einer möglichst flachen und einfachen Verzeichnisstruktur beginnen und diese erst bei Bedarf erweitern. Zur Strukturierung empfiehlt sich bei kleinen Applikationen mit wenig voneinander abgegrenzten Fachlichkeiten, die Dateien nach ihrem Zweck zu strukturieren. Bauen Sie Ihre Webapplikation beispielsweise nach dem MVC-Pattern auf, erzeugen Sie Verzeichnisse für Ihre Models, Views und Controller und sortieren dort die jeweiligen Dateien ein. Zusätzlich bietet es sich an, ein shared-Verzeichnis zu erstellen, in dem Sie Hilfskonstrukte ablegen können.
Weist Ihre Applikation einen größeren Funktionsumfang auf, bei dem Sie die einzelnen Fachlichkeiten deutlicher voneinander abgrenzen können, nutzen Sie dies als Strukturierungsmerkmal. Jeden Bereich bilden Sie dann durch ein eigenständiges Verzeichnis ab. So könnte beispielsweise die Benutzerverwaltung in einem user-Verzeichnis untergebracht werden. Je nach Umfang des Moduls können Sie zusätzliche Untermodule bilden oder die Dateien wieder nach ihrer technischen Struktur gruppieren.
Bei den Dateinamen sollten Sie auf Großschreibung verzichten und die Dateien nur mit Kleinbuchstaben benennen. Eine Alternative zur weit verbreiteten CamelCase-Schreibweise ist die Kebab-Case...

