mitmario.dev

Module

JavaScript Im Browser 4 Min Lesezeit 4 BeispieleLektion 4 von 7

Hundert Zeilen in einer Datei sind schnell beisammen. Die Stoppuhr aus Lektion 15.7 hat in ihrer app.js an die hundert, mit Zustand, Anzeige, drei Buttons und dem Aufräumen. Willst du dort nur an der Anzeige etwas ändern, scrollst du an allem anderen vorbei. Module schneiden so eine Datei in Teile, die einander nur zeigen, was sie hergeben.

export und import

Das Modul, das etwas hergibt
// Datei: werkzeuge.js

// Benannter Export. Davon darf es beliebig viele geben.
export function grossAnfang(text) {
  return text.charAt(0).toUpperCase() + text.slice(1);
}

export function kuerzen(text, laenge) {
  return text.length <= laenge ? text : text.slice(0, laenge) + "...";
}

// Auch Werte lassen sich exportieren.
export const MAXLAENGE = 40;

// Was nicht exportiert wird, bleibt im Modul.
// Von außen gibt es keinen Weg hierher.
function intern(text) {
  return text.trim();
}

// Der Standardexport. Höchstens einer je Datei, und im
// Alltag brauchst du ihn selten.
export default function aufraeumen(text) {
  return kuerzen(grossAnfang(intern(text)), MAXLAENGE);
}

export markiert, was eine Datei nach außen hergibt. Alles andere bleibt drin. Mit import holst du es in einer anderen Datei herein. Benannte Importe stehen in geschweiften Klammern und heißen genau wie der Export.

Das Modul, das es holt
// Datei: app.js
// Eingebunden mit: <script src="app.js" type="module"></script>

// Benannte Importe stehen in geschweiften Klammern und
// heißen genau wie der Export.
import { grossAnfang, kuerzen, MAXLAENGE } from "./werkzeuge.js";

// Der Standardexport bekommt seinen Namen erst hier.
import aufraeumen from "./werkzeuge.js";

// Der Pfad fängt mit ./ an und hat die Endung. Ohne ./
// nimmt der Browser ihn nicht an, ohne Endung fehlt die Datei.

console.log(grossAnfang("hallo"));
console.log(kuerzen("Ein ziemlich langer Satz für dieses Feld", 20));
console.log("Grenze:", MAXLAENGE);
console.log(aufraeumen("  eine notiz  "));

// intern gibt es hier nicht. Es wurde nicht exportiert,
// und dieser Zugriff wäre ein Fehler.
// console.log(intern("x"));

Neben den benannten Exporten gibt es den Standardexport mit export default. Davon kann es höchstens einen je Datei geben, und seinen Namen bekommt er erst an der Stelle, an der er geholt wird.

Im Alltag nimmt man benannte Exporte. Der Grund ist banal und wiegt trotzdem. Benannte Exporte heißen überall gleich, ein Standardexport kann dagegen in jeder Datei anders heißen, und dann suchst du denselben Code unter drei Namen.

Der eigentliche Gewinn

Dasselbe ohne Module
const MAXLAENGE = 40;

function intern(text) {
  return text.trim();
}

function grossAnfang(text) {
  return text.charAt(0).toUpperCase() + text.slice(1);
}

function kuerzen(text, laenge) {
  return text.length <= laenge ? text : text.slice(0, laenge) + "...";
}

function aufraeumen(text) {
  return kuerzen(grossAnfang(intern(text)), MAXLAENGE);
}

console.log(grossAnfang("hallo"));
console.log(kuerzen("Ein ziemlich langer Satz für dieses Feld", 20));
console.log("Grenze:", MAXLAENGE);
console.log(aufraeumen("  eine notiz  "));

// Der Unterschied: hier liegt alles im selben Raum.
// Eine zweite Datei mit einer Funktion namens kuerzen
// würde diese hier still ersetzen.

Jedes Modul hat seinen eigenen Gültigkeitsbereich. Was darin kuerzen heißt, gehört dem Modul. Eine andere Datei darf eine völlig andere Funktion mit demselben Namen haben, und die beiden wissen nichts voneinander. Was ohne Module passiert, steht im dritten Beispiel im letzten Kommentar.

Mehrere gewöhnliche <script>-Tags teilen sich dagegen einen einzigen Raum. Haben zwei Dateien eine Funktion mit demselben Namen, ersetzt die später geladene still die frühere. Kein Fehler, keine Warnung, nur seltsames Verhalten an einer dritten Stelle. Dafür gibt es Module, der Rest ist Beiwerk.

Vier Eigenheiten

  • Der Pfad fängt mit ./, ../ oder / an und hat die Endung. werkzeuge.js allein nimmt der Browser gar nicht erst an, und ohne .js fragt er nach einer Datei, die es nicht gibt. Die Gewohnheit, beides wegzulassen, kommt vom alten require in Node und von den Bundlern. Das sind Werkzeuge, die viele Dateien zu wenigen zusammenfassen, und sie kommen in der nächsten Lektion dran. Mit import verlangt auch Node die Endung, und wie Node seine Module findet, steht im Node-Kurs im Abschnitt über Module.
  • Module laufen wie der Klassenblock automatisch im strikten Modus. Eine Zuweisung an eine nie deklarierte Variable ist dort ein Fehler und legt keine neue globale Variable an, und this ohne Objekt davor ist undefined. Außerdem warten Module von sich aus auf das fertige Dokument. Ein defer bei type="module" ist deshalb überflüssig.
  • Ein Modul wird nur einmal ausgewertet. Auch wenn zehn Dateien es importieren, läuft sein Code genau einmal, und alle zehn bekommen dasselbe Ergebnis. Für gemeinsamen Zustand ist das praktisch. Wer mit einem frischen Anfang rechnet, fällt darauf herein.
  • In einem Modul darf await ganz oben stehen, außerhalb jeder Funktion. Das heißt Top-Level-Await und geht nur dort, nicht in einem gewöhnlichen Skript.

Warum das hier nicht läuft

Die ersten beiden Beispiele laufen hier nicht.

Solange index.html die Datei app.js nicht selbst nennt, hängt die Seite sie als gewöhnliches <script> ein, ohne type="module". In den ersten beiden Beispielen nennt sie niemand. Damit ist app.js ein Skript und kein Modul, import und export gibt es dort schlicht nicht, und der Browser bricht schon beim Einlesen ab.

In der Console steht beim ersten Beispiel Uncaught SyntaxError: Unexpected token 'export' mit der Fundstelle app.js:4:1, beim zweiten Uncaught SyntaxError: Cannot use import statement outside a module mit app.js:6:1. Firefox sagt es in eigenen Worten (export declarations may only appear at top level of a module, import declarations may only appear at top level of a module), mit denselben Fundstellen. Klickst du auf die Fundstelle, kommt app.js nach vorn, und die export-Zeile beziehungsweise die import-Zeile wird eingefärbt. Mehr als diese eine Zeile ist auch nicht falsch.

Geladen wird dabei nichts, und am Laden scheitert es auch nicht. Der Browser liest die Datei und versteht sie nicht. Deshalb kommt die Meldung auch beim ersten Beispiel, obwohl dort gar kein import steht und es nichts zu laden gäbe. Im Reiter „Netzwerk“ stehen genau drei Zeilen, index.html, styles.css und app.js, alle mit der Marke „aus der Aufgabe“, die die Lektionsansicht selbst in die Seite einbaut. Für werkzeuge.js steht keine da, weder eine erfolgreiche noch eine rote. Holen müsste der Browser sie erst beim import, und so weit ist er nie gekommen.

Eine einzelne Datei läuft hier sehr wohl als Modul. Steht in index.html die Zeile <script type="module" src="app.js"></script>, setzt die Seite app.js als Modul ein, strikt und mit eigenem Gültigkeitsbereich. Was nicht geht, ist der import einer zweiten Datei, denn werkzeuge.js liegt nur hier im Editor und auf keinem Server, und der Browser hat keine Adresse, unter der er sie holen könnte.

Eine Datei als Modul
// index.html nennt diese Datei mit type="module",
// und damit läuft sie als Modul.

function kuerzen(text, laenge) {
  return text.length <= laenge ? text : text.slice(0, laenge) + "...";
}

console.log(kuerzen("Ein ziemlich langer Satz für dieses Feld", 20));

// Ganz oben gibt es in einem Modul kein Objekt als this.
console.log("this:", this);

// Was ein Modul anlegt, bleibt im Modul. Am window hängt es nicht.
console.log("window.kuerzen:", typeof window.kuerzen);

// Strikter Modus: Eine Zuweisung an einen Namen,
// den es nie gab, ist ein Fehler.
try {
  zaehler = 1;
} catch (fehler) {
  console.log("Ohne let:", fehler.name);
}

In der Console steht zuerst die gekürzte Zeile, dann this: undefined, dann window.kuerzen: undefined und zuletzt Ohne let: ReferenceError. Als gewöhnliches Skript sähe das anders aus. this wäre das Fenster, kuerzen hinge als Funktion am window, und die Zuweisung an zaehler legte still eine neue globale Variable an.

Die ersten beiden Beispiele stehen trotzdem hier, denn jedes Projekt ist so aufgebaut, und solchen Code willst du lesen können. Ausprobieren kannst du ihn in Lektion 20.5 auf dem eigenen Rechner, wo Module ganz normal funktionieren. Im dritten Beispiel steht dieselbe kleine Anwendung ohne Module, und die läuft. Der Vergleich der drei Dateien nebeneinander ist der eigentliche Inhalt dieser Lektion.

Zum Mitnehmen

export gibt her, import holt herein, und jedes Modul hat seinen eigenen Gültigkeitsbereich. Hier läuft eine Datei als Modul, wenn index.html sie mit type=module einbindet, den import einer zweiten Datei gibt es nur mit einem Server.

Jetzt du

Basis Konto, kostenlos

Im Editor änderst du die Beispiele dieser Lektion und lässt sie gleich laufen. So merkst du am schnellsten, ob es sitzt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

Was in dieser Lektion steckt

  • Artikel mit 4 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.