HTML5-Tutorium: JavaScript: Hello World 04

aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Wechseln zu:Navigation, Suche
Dieser Artikel erfüllt die GlossarWiki-Qualitätsanforderungen:
  ★★★☆☆ Korrektheit: zu größeren Teilen überprüft
  ★★★★☆ Umfang: einige unwichtige Fakten sollten ergänzt werden
  ★★★☆☆ Quellenangaben: wichtige Quellen sind vorhanden
  ★★★★★ Quellenqualität: ausgezeichnet
  ★★★☆☆ GlossarWiki-Konformität: gut
Vorlesung MMProg

Inhalt | Teil 1 | Teil 2 | Teil 3 | Teil 4

Musterlösung: index.html (4a), index.html (4b), index.html (4c)
Repositories (unterschiedliche webpack-Varianten): WK_HelloWorld04a.git, WK_HelloWorld04b.git, WK_HelloWorld04c.git

1 Anwendungsfälle (Use Cases)

Gegenüber dem dritten Teil des Tutoriums ändern sich die die Anwendungsfälle nicht. Die Anwendung leistet also genau dasselbe wie zuvor.

In diesem Teil des Tutoriums geht es darum, die Anwendung besser zu strukturieren, d. h. zu modularisieren.

2 Modularisierung

Eine Anwendung, wie z. B. ein HTML5-Spiel, besteht aus diversen unterschiedlichen Komponenten mit ganz unterschiedlichen Aufgaben. Bei einem HTML5-Spiel müssen die Spielfiguren, die Spielszenen, die Spiellogik, die Benutzereingaben, die Darstellung das Spiels im Browser etc. erstellt und verwaltet werden, wobei das Erstellen und Verwalten teilweise während der Spielentwicklung und teilweise während der Spielausführung (Runtime) erfolgt. An der Entwicklung eines Spiels sind üblicherweise mehrere oder gar viele Entwickler gleichzeitig beteiligt. Oft müssen einzelnen Komponenten an neue Endgeräte oder Betriebssysteme angepasst werden. Beispielsweise muss eine Tastatursteuerung durch eine Touch- oder Gestensteuerung ersetzt werden, wenn ein Spiel so erweitert werden soll, dass es auch auf einem Smartphone oder Tablet läuft.

Das alles ist nur machbar, wenn man die Anwendung modularisiert, d. h. in kleine, möglichst unabhängige Komponenten unterteilt. Ein großer Feind der Modularisierung sind globale Variablen und Funktionen. Je mehr Dateien von unterschiedlichen Autoren erstellt werden, desto größer ist die Gefahr, dass es zu Namenskollisionen kommt. Daher gilt der Grundsatz: Verwende so wenig globale Größen wie möglich.

3 Erstellen eines neuen Projektes

Erstellen Sie ein neues Projekt „HelloWorld04“.

Kopieren Sie anschließend die Projektdateien (das heißt, den Ordner „web“ mit den Dateien „index.html“, „main.css“ und „main.jssowie die Datei .gitignore) aus dem dritten Teil des Tutoriums und passen Sie den Titel in der HTML-Datei an.

Erstellen Sie für Ihr Projekt ein Git-Repository, committen Sie und pushen Sie es dann auf den Git-Server.

Dadurch, dass die Datei .gitignore das Verzeichnis node_modules enthält, werden die Dateien, die in Zukunft in diesem Ordner gespeichert werden, nicht ins Git-Repository übertragen. Dies ist notwendig, da sich in diesem Ordner mehrere tausend ganz kleine Dateien befinden werden, und die Speicherung dieser Daten im Git-Repository Stunden in Anspruch nehmen kann. Dabei ist eine Speicherung gar nicht notwendig, da sie jederzeit mit dem Befehl npm install sehr schnell wieder hergestellt werden können.

BTW: Sollten Sie einmal eine Abschlussarbeit mit Node.js erstellen, fügen Sie bitte auf gar keinen Fall den Inhalt des Ordners node_modules in Ihr Abgabemedium (CD, DVD, USB-Stick ...) ein. Ihr Betreuer wird es Ihnen danken!

4 Erstellen einer Ordnerstruktur

Grundsätzlich gilt auch bei der Programmierung: Ordnung ist das halbe Leben.

Web-Anwendungen werden sehr schnell sehr groß. Also sollte man sich eine geeignete Ordnerstruktur überlegen. Üblicherweise legt man CSS-Dateien in einen Ordner namens „css“ und JavaScript-Dateien in einen Ordner namens „js“ oder „lib“. Sollten es viele CSS- und/oder JavaScript-Dateien werden, legt man im entsprechenden Ordner geeignete Unterordner an.

Legen Sie im Root-Verzeichnis Ihres Projektes folgende Ordner an (und beantworten Sie die Fragen, ob ein Ordner im Repository gespeichert werden soll, gegebenenfalls mit Yes):

  • src: Der Inhalt dieses Ordners enthält die Ausgangsdateien, die mit Hilfe von Node.js noch transformiert und dann in den Web-Ordner kopiert werden. Verschieben Sie die Datei web/index.html in diesen Ordner.
  • src/css: Hier werden die eigentlichen CSS-Dateien der Web-Anwendung gespeichert, die von der App dynamisch nachgeladen werden sollen. In diesem Ordner könnten zur weiteren Strukturierung Unterordner angelegt werden. Allerdings wird das in dieser Veranstaltung nicht notwendig sein. Es wird nur die Dateien „head.css“ und „main.css“ geben. Verschieben Sie die Datei web/main.css in diesen Ordner.
  • src/js: Hierher kommt die Datei „app.js“, die für den Start der Web-Anwendung zuständig ist. Üblicherweise liest sie weitere JavaScript-Dateien sowie eine oder mehrere JSON-Dateien mit Initialwerten ein, initialisiert die Anwendung und startet sie dann. Verschieben Sie die Datei web/main.js in diesen Ordner.
  • web: (Dieser Ordner existiert schon.) Der Inhalt dieses Ordners kommt später auf einen echten Web-Server.
  • web/css: Hierher kopiert Node.js die erzeugten CSS-Dateien. (In den Tutorien werden dort jeweils nur eine sehr kleine CSS-Dateien liegen. Diese sorgen dafür, dass der Browser während der Initialisierung einer App kein defektes Layout präsentiert. Der größte Teil des CSS-Codes ist in der Haupt-JavaScript-Datei der App enthalten.)
  • web/js: Hierher kopiert Node.js die erzeugten JavaScript-Dateien.

Wenn Sie jetzt die Datei src/index.html mittels run ausführen, sollte Ihre Anwendung immer noch laufen. WebStorm hat die Pfade in der Datei index.html, unter denen die Dateien main.css und main.js zu finden sind, automatisch angepasst. Vergleichen Sie die index.html-Dateien der HelloWorld-Versionen 3 und 4.

Fremde Bibliotheken und automatisch generierte JavaScript-Dateien enthalten häufig unsauberen Code, die Ihnen von WebStorm beim Speichern der Dateien im Repository angezeigt werden. In einer Rückfrage sollen Sie dann bestätigen, dass Sie die „fehlerhaften“ Dateien trotzdem speichern wollen.

Damit Ihnen bei einem Commit nur Fehler in von Ihnen erstellten Dateien angezeigt werden, schließen Sie den Ordner „web“ von der WebStorm-Fehlerüberwachung aus:

  • Rechtsklick auf den Ordner „web“ → Mark Directory asExcluded

Für den Ordner „node_modules“ brauchen Sie dies nicht zu machen. Dieser Ordner wird von WebStorm-Fehlerüberwachung automatisch ignoriert.

Sie sollten nach jeden größeren Entwicklungsschritt die Änderungen im Repository speichern:

  • Klick auf das Commit-Icon.

Hin und wieder ist auch ein git push angebracht. Es schadet übrigens nicht, vorher noch einmal zu überprüfen, ob die Anwendung immer noch läuft.

5 Die App

5.1 Laden der CSS- und der JavaScript-Dateien

Eine Web-Anwendung funktioniert nur – wie Sie bereits erfahren haben –, wenn nicht nur die HTML-Datei, sondern auch die zugehörigen CSS- und JavaScript-Dateien geladen werden. Allerdings gibt es dabei ein Problem: Die CSS- und JavaScript-Dateien werden im Laufe der Zeit immer zahlreicher und/oder größer. Diese Dateien zu laden, dauert seine Zeit.

In der dritten Version der Web-Anwendung stehen die Verweise auf diese Dateien im head-Bereich des Dokuments. Dieser wird vollständig geladen, bevor der body-Bereich eingelesen wird. (Genauer gesagt, nur die CSS-Datei wird vollständig geladen. Durch die Angabe von async="async" im Script-Tag wird erreicht, dass diese Datei geladen wird, während der Body-Bereich gerendert wird.)

Das heißt aber, dass der Browser keine Inhalte des HTML-Dokuments darstellen kann, solange er CSS-Datei (und evtl. weitere Dateien) lädt. Wenn dies zu lange dauert, verliert der Besucher die Geduld und verlässt die Seite vorzeitig.

Besser wäre es daher andersherum vorzugehen: Es wird zuerst der Body-Bereich geladen und dann die JavaScript- und die CSS-Dateien. Im Falle von JavaScript ist das durchaus sinnvoll (und durch die Angabe von async="async" auch machbar), aber im Falle von CSS hat das den Effekt, dass der Browser noch keine Layout-Vorgaben erhalten hat, wenn er mit dem Rendern der Seite beginnt. Also verwendet er die browserspezifischen Defaultwerte. Das heißt, die Seite sieht zunächst ganz anders aus, als vom Designer geplant. Wenn dann die CSS-Dateien geladen wurden, wird die Seite erneut gerendert und verändert ihr Aussehen. Auch das ist verwirrend und wirkt unprofessionell.

Was also machen?

5.2 CSS-Dateien

Damit das Problem mit dem falschen Layout nicht auftritt, empfiehlt Google, ganz wenige, wichtige CSS-Befehle direkt – d. h. als CSS-Befehle innerhalb eines style-Elements – in dem HTML-Head-Bereich einzufügen. Alle anderen CSS-Anweisungen sollen erst am Ende der HTML-Datei dynamisch mittels JavaScript (oder mittels des PageSpeed-Optimization-Modul von Google) gelesen werden.[1] (Früher hat Google ernsthaft empfohlen, das Link-Element ganz ans Ende der HTML-Datei zu stellen, also nach dem schließenden html-Tag. Das wäre aber natürlich nicht standardkonform.)

Gehen Sie so vor, wie es Google empfiehlt. Genauer gesagt, gehen Sie so vor, wie es unter Multimedia-Programmierung: Best Practices beschrieben ist. In diesem und den folgenden Tutorien werden die dort beschriebenen Prinzipien berücksichtigt.

Legen Sie die Datei src/css/head.css an und fügen Sie folgenden (sehr kurzen!) Code ein:

html, body
{ background-color: #C5EFFC; }

.hidden
{ display: none; }

In der Datei src/css/main.css können Sie das .hidden-Element und das Farbattribut background-color: #C5EFFC; entfernen.

In der Datei src/index.html müssen Sie das Link-Element in Header folgendermaßen

<link rel="stylesheet" type="text/css" href="css/head.css"/>

anpassen. Das heißt, Sie laden im HTML-Head-Bereich nur noch die kleine CSS-Datei. Damit funktioniert Ihre Web-Anwendung derzeit nur noch rudimentär: Es gibt kaum noch CSS-Anweisungen, die berücksichtigt werden.

5.3 JavaScript-Dateien

Für JavaScript-Dateien empfiehlt Google ebenfalls, diese nicht schon zu Beginn zu laden.[2] Dieser Vorschlag war bis vor kurzem noch sehr sinnvoll. Man könnte das Skript-Element aus dem HTML-Header-Bereich entfernen und vor dem schließenden Body-Tag einfügen. Bis vor Kurzem war diese Vorgehensweise auch sehr weit verbreitet. Seitdem die meisten Browser die Async- und Defer-Attribute im Skript-Element unterstützen, ist dies jedoch nicht mehr notwendig. Und Sie haben ja schon ein Async-Attribut in Ihr Skript-Element eingefügt.

Was Sie aber machen sollten, ist, in das erste Section-Tag im Body der HRML-Datei das Attribut class="hidden" einzufügen, damit man auch dieses Element beim Laden der Anwendung zunächst nicht sieht. In einer Anwendung, die zum Laden etwas länger dauert, würde man einen so genannten Splash Screen sichtbar einfügen und diesen beim eigentlichen Start der App ausblenden.

Wenn Sie nun die Web-App testweise starten, sollten Sie eine himmelblaue, aber ansonsten leere Seite sehen.

Fügen Sie nun den Befehl

document.getElementById('section_form').classList.remove('hidden');

als letzen Befehl in den Rumpf der Funktion init in der Datei src/js/main.js ein.

Wenn Sie jetzt die Web-App starten, sollte sie wieder funktionieren (wenn auch mit einem sehr CSS-armen Layout).

Was haben Sie erreicht? Solange die Anwendung geladen wird, sehen Sie nur einen blauen Hintergrund ohne Inhalt. (Besser wäre – wie gesagt – ein Splash Screen.) Wenn dann alles, d. h. alle CSS- und JavaScript-Dateien geladen wurden, wird die eigentliche Anwendung sichtbar. Dies ist bei großen Anwendungen, wie einem Spiel, eine übliche Vorgehensweise.

Vergessen Sie nicht:

  • Klick auf das Commit-Icon.

5.4 Modularisierung der JavaScript-Dateien

Die JavaScript-Datei main.js aus dem dritten Teil des Tutoriums wird in zwei Teile aufgespalten: greet.js und main.js. Die erste Datei enthält die eigentliche Begrüßungsfunktionalität, die zweite initialisiert die App, d. h. aktiviert die Begrüßungsfunktion.

Erstellen Sie die JavaScript-Datei src/js/greet.js und verschieben Sie die beiden Funktionen sayHello und sayHelloOnEnter (jeweils samt Funktionsrumpf :-) ) in diese Datei.

Schreiben Sie vor jede der beiden Funktionsdefinitionen das Schlüsselwort export. Mit dieser ES-6-Anweisung legen Sie fest, dass die beiden Funktionen von anderen ES-6-Dateien mittels eines Import-Befehls importiert werden können. (Funktionen ohne Export-Anweisung könnten von anderen ES-6-Dateien nicht importiert werden.)

In der Datei src/js/main.js werden jetzt diese beiden Funktionen importiert. Fügen Sie ganz am Anfang der Datei (d. h. vor der verbliebenen Init-Funktion) die folgende Import-Anweisung ein:

import * as greet from './greet.js';

Damit wird erreicht, dass alle (*) Elemente, die von der Datei greet.js exportiert werden, unter ihrem jeweiligen Namen im Objekt greet gespeichert werden. (Man könnte auch nur bestimmte Elemente von greet.js importieren, sofern man nicht alle benötigt.) Das heißt, innerhalb der Datei main.js gibt es nun die beiden Funktionen greet.sayHello und greet.sayHelloOnEnter.

Damit die Web-Anwendung wieder funktioniert. müssen Sie also in der Datei main.js vor jede Verwendung dieser beiden Funktionen die Zeichfolge greet. einfügen. (WebStorm zeigt ihnen durch Unterringeln an, dass die Funktionen sayHello und sayHelloOnEnter nicht existieren. Wenn Sie jeweils greet. davor einfügen, verschwinden die Fehlermarkierungen.)

Fügen Sie jetzt noch das Attribut type="module" in das Script-Element in der Datei src/index.html ein und löschen Sie gegebenenfalls das Attribut type="text/javascript". Damit sollte Ihre Anwendung wieder funktionieren. Leider macht Ihnen WebStorm einen Strich durch die Rechnung. Aus „Sicherheitsgründen“ unterbindet WebStorm das dynamische Laden der Datei greet.js durch den Browser. Sie werden durch ein Pop-up-Fenster aufgefordert, eine “authorization URL” zum Clipboard zu kopieren. Wenn Sie das tun, ist es schon zu spät. Der Browser konnte die Datei nicht laden und daher funktioniert die Web-App nicht (wenn Sie sie von WebStorm aus starten; auf einem anderen Server würde sie schon funktionieren, wenn Sie alles richtig gemacht haben).

Gewöhnen Sie WebStorm dieses Verhalten ab:

  • File/WebStormSettings/PreferencesBuild, Execution, DeploymentDebugger
  • Häkchen bei Allow unsigned requests
  • OK

Jetzt sollte die Anwendung wieder laufen (auch wenn Sie sie von WebStorm aus starten).

Vergessen Sie nicht:

  • Klick auf das Commit-Icon.

5.5 Node.js und webpack

Jetzt müssen sie „nur noch“ die CSS-Datei main.css laden, dann funktioniert Ihre Anwendung wieder wie gewohnt. Und Sie ist überdies modular aufgebaut. (Sehr viel weiter kann man eine Hello-World-Anwendung nicht modularisieren. :-) )

Google empfiehlt, die eigentliche CSS-Datei dynamisch zu laden. Dazu gibt es zahlreiche Möglichkeiten. Ich empfehle derzeit webpack dafür einzusetzen[3].

webpack ist ein sehr mächtiges Werkzeug, mit dem eine Vielzahl von Web-Dateien in einer oder einigen wenigen JavaScript-Dateien zusammengefasst und bei Bedarf auch komprimiert werden können. Es handelt sich um einen JavaScript module bundler, der sehr viel mehr kann, als nur CSS-Dateien dynamisch einzulesen.

Einer der Entwickler von webpack ist Johannes Ewald, ein ehemaliger Student der HSA (vgl. https://github.com/jhnns). Er bietet auch regelmäßig Vorlesung an der HSA zum Thema „JavaScript“ an.

5.5.1 Node.js-Pakete

Öffnen Sie das WebStorm-Terminal und installieren Sie die benötigten Node.js-Pakete (falls Sie nicht mehr genau wissen, wie man Node.js bedient, sollten Sie sich noch einmal das Tutorium HTML5-Tutorium: JavaScript: Entwicklungsumgebung: Node.js ansehen):

npm init -y
# Name, Description, Repository, Autor, Lizenz und Keywords in package.json anpassen
# Achtung: Der Name darf nur Kleinbuchstaben, Zahlen 
#          und das Underscore-Zeichen enthalten.
npm install --save-dev webpack webpack-cli
npm install --save-dev html-loader css-loader style-loader  
npm install --save-dev file-loader extract-loader  
npm install --save-dev suppress-chunks-webpack-plugin

Führen Sie nun einen Git-Commit durch. Sorgen Sie dafür, dass auch die neu angelegten Dateien package.json und package-lock.json im Git-Repository gespeichert werden. Dies können Sie entweder beim Commit erzielen, indem Sie vor Unversioned Files ein Häkchen setzen oder indem Sie vor dem Commit für beiden Dateien Folgendes ausführen:

Rechtsklick auf den Dateinamen → GitAdd

Achtung, wenn Git Ihnen anbietet, den Ordner node_modules zu speichern, haben Sie die Datei .gitignore vergessen. Fügen Sie in diesem Fall unbedingt die Datei .gitignore in Ihr Projekt ein!

5.5.2 webpack

Nun muss noch webpack konfiguriert werden, damit die Dateien web/index.html, web/css/head.css und web/js/mains.js automatisch generiert werden können.

Erstellen Sie im Wurzelverzeichnis des Projektes die Datei webpack.config.js (die Sie unbedingt auch in Git speichern sollten). Fügen Sie folgenden Code in diese Datei ein.

webpack.config.js

const
  path                    = require('path'),
  SuppressChunksPlugin    = require('suppress-chunks-webpack-plugin').default;

function absolutePath(l_path)
{ return path.resolve(__dirname, l_path); }

module.exports =
{ entry:
  { index: absolutePath('src/index.html'),
    head:  absolutePath('src/css/head.css'),
    main:  absolutePath('src/js/main.js'),
  },

  output:
  { filename: 'js/[name].js',
    path: absolutePath('web'),
  },
  
  plugins:
  [ new SuppressChunksPlugin(['index', 'head']) ],
  
  module:
  { rules:
    [ { test:   /head\.css$/,
        use:    [ { loader: 'file-loader',
                    options: { name: '[name].[ext]',
                               outputPath: 'css/'
                             }
                  },
                  'extract-loader',
                  'css-loader'
                ]
      },

      { test:    /main\.css$/,
        exclude: [/node_modules/, /web/],
        use:     [ 'style-loader',
                   'css-loader'
                 ]
      },
      
      { test:   /\.html$/,
        use:    [ { loader: 'file-loader',
                    options: { name: '[name].[ext]',
                               outputPath: '/'
                             }
                  },
                  'extract-loader',
                  'html-loader'
                ]
      },
    ]
  }
};

Es handelt sich um ein JavaScript-Datei, die direkt von Node.js interpretiert wird. Aus diesem Grund wird auch nicht das EcmaScript-6-Modul-Konzept eingesetzt, sondern CommonJS, das Standard-Modulkonzept vom Node. Hier werden Module mittels require und nicht mittels import importiert. Für Sie ist das allerdings nebensächlich, da Sie im Rahmen der Tutorien keine komplexen Konfigurationsdateien für webpack implementieren werden.

Im Prinzip macht diese Datei nichts andere als ein Objekt zu exportieren, das webpack-Konfigurationsinformationen enthält:

  • entry: JavaScript-Dateien, die gebündelt und komprimiert werden sollen. Man muss jeweils nur die Wurzeldatei angeben. webpack sucht in dieser Datei rekursiv nach Import-Befehlen und packt die benötigten Dateien ebenfalls in die Ausgabedatei.
  • output: Hier wird festgelegt, wie die gepackten Dateien heißen sollen. Für jeden Eintrag im Attribute entry wird eine Datei mit dem Namen web/js/[name].js erzeugt, wobei [name] durch den Schlüsselname des Entry-Eintrags ersetzt wird. In der obigen Datei gibt es drei Entry-Elemente.
  • plugins: Hier werden webpack-Hilfsmodule geladen, die bestimmte Zusatzaufgaben erledigen. Sie verwenden derzeit nur das Modul SuppressChunksPlugin. Dieses löscht die Dateien web/js/index.js und web/js/head.js, nachdem die Dateien web/js/index.html und web/js/head.css daraus mittels gewissen Loadern extrahiert wurden. Grundsätzlich generiert webpack für jeden Entry eine JavaScript-Datei, egal, um welches Inputformat es sich handelt. Wenn man einen anderen Dateityp benötigt, muss man diese aus der zugehörigen JavaScript-Datei extrahieren und kann letztere danach mittels SuppressChunksPlugin löschen.
  • module: In diesem Attribut werden Regeln (rules) angegeben,die festlegen, auf welche Weise eine Datei transformiert werden sollen. Bei jeder Regel gibt es einen Test, der festlegt, für welche Dateien die jeweilige Regel zutrifft. Mit Hilfe eines regulären Ausdrucks wird im Tutoriumsbeispiel geprüft, ob die aktuelle Datei auf head.css, mains.css oder .html endet. Je nach der Endung werden anderer Loader zum Laden und Verarbeiten der zugehörigen Datei verwendet. (Für webpack gibt es diverse Loader, einige davon haben Sie zuvor mit Hilfe von npm installiert.) Leider gibt es soviel Loader, dass die Auswahl geeigneter Loader nicht gerade einfach ist. Erschwerend kommt hinzu, dass sich mit jeder neuen Hauptversion von webpack nicht nur die Struktur der Konfigurationsdatei, sonder auch die verfügbaren Loader und Plugins verändern. :-( )

CSS-Dateien werden zunächst mit dem CSS-Loader geladen und verarbeitet. Anschließend wird die Datei main.css vom Style-Loader Anweisungen in die Datei main.js geschrieben. Damit wird erreicht, dass die Datei main.css in der Datei main.js enthalten ist. Sobald main.js geladen wird, „injiziert“ sie die CSS-Elemente dieser JavaScript-Datei direkt in den HTML-Head-Bereich der zugehörigen HTML-Datei. Das heißt, die CSS-Datei wird dynamisch von main.js geladen. Genau das wollten wir erreichen.

Die Datei head.css soll nicht dynamisch geladen werden. Sie wird daher mit Hilfe des Extract- und des File-Loaders aus der zugehörigen JavaScript-Datei extrahiert und unter dem Namen web/css/head.css gespeichert.

Analog wird die Datei src/index.html mittels eines HTML-Loaders in eine JavaScript-Datei geladen und von dort mit dem Extract-Loader extrahiert. Mittels des File-Loaders wird sie schließlich unter dem Namen web/index.html gespeichert.

Dieses Vorgehen klingt zunächst einmal so, als ob man mit Kanonen auf Spatzen schießen würde. Warum kopiert man beispielsweise die Dateien nicht einfach direkt vom Ordner src in den Ordner web. Ganz eingach: Die Loader können noch viel mehr, als eine Datei nur zu kopieren. Sie können Dateien, die von diesen referenziert werden, in die referenzierende Datei integrieren. Zum Beispiel wird die Datei greet.js automatisch in die Datei main.js eingefügt, so dass index.html nur eine einzige JavaScript-Datei laden muss und nicht zwei. (Bei großen Projekten werden so Dutzende von Dateien in eine einzige gepackt.) Außerdem kann man mit speziellen Anweisungen webpack dazu bringen, die erzeugten JavaScript-/HTML-/CSS-Dateien zu komprimieren, so dass das Datenvolumen teils drastisch reduziert wird.

Damit steht einer Verwendung von webpack nichts mehr im Wege. Man könnte webpack nun direkt von der Kommandozeile aufrufen. Besser ist es allerdings NPM-Skript-Befehle zu verwenden.

5.5.3 NPM-Skripte

Fügen Sie das scripts-Objekt der Datei package.json drei weitere Skript-Anweisungen ein:

"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "dev": "webpack --mode development",
  "prod": "webpack --mode production",
  "watch": "webpack --mode development --watch"
}

Geben Sie nun im WebStorm-Terminal die Anweisung npm run dev (dev = development) ein.

Wenn Sie alles richtig gemacht haben, müsste webpack fehlerfrei durchlaufen und die Dateien web/index.html, web/js/main.js sowie web/css/head.css erstellen. Im Zweifelsfall müssen Sie auf das Reload-Icon unter der Menü-Leiste klicken, um sie zu sehen (View → Häkchen bei Toolbar). Wenn die Dateiname nicht grün, sondern braun eingefärbt sind, müssen Sie sie (spätestens beim Commit) unter Git-Kontrolle stellen.

Wenn Sie jetzt die Datei index.html im Browser öffnen, sollten Sie nach kurzer Zeit wieder das Begrüßungsmenü sehen. Nach Eingabe des Namens und Klick auf den Say-hello-Button oder Drücken der Enter-Taste sollten Sie freundlich begrüßt werden.

Allerdings ist das CSS-Layout immer noch mangelhaft. Die Datei main.css wird bislang noch nicht eingebunden. Das können Sie ganz einfach ändern. Fügen Sie in die Datei src/js/main.js folgenden Import-Befehl am Anfang der Datei ein:

import '../css/main.css';

Dieser Befehl ist in JavaScript eigentlich nicht erlaubt. Wenn Sie jetzt versuchen, die Datei src/index.html im Browser zu öffnen, werden Sie in der Browser-Konsole eine Fehlermeldung erhalten.

webpack unterstützt allerdings das Importieren von CSS-Dateien in JavaScript-Dateien. Das Tool wurde so konfiguriert, dass die Datei so eingebunden wird, dass sie dynamisch in das HTML-Dokument injiziert wird (siehe oben).

Geben Sie im WebStorm-Terminal noch einmal die Anweisung npm run dev ein und öffnen Sie die Datei web/index.html im Browser (nicht die Datei src/index.html!). Jetzt sollte sie wieder sauber formatiert sein (evtl. erst nach einem Reload im Browser)!

Sehen Sie sich mal den Inhalt der Datei main.js an. Darin finden Sie – neben vielen Kommentaren, die zur Strukturierung der Datei verwendet werden – die Inhalte der Dateien main.js, greet.js und main.css sowie spezielle Anweisungen, die von webpack eingefügt wurden.

In dieser Form ist die Datei für Entwicklungszwecke einigermaßen brauchbar. Bei einem Fehler zeigt einem der Browser, in welcher Zeile dieser Datei der Fehler aufgetreten ist. Normalerweise handelt es sich um eine Zeile, die Sie erfasst haben. webpack-Befehle sollten keine Fehler werfen. Nachteilig ist, dass diese Zeile etwas anders aussehen kann, wie in Ihrem Sourcecode, da sie eventuell transformiert wurde. Aber man findet die Originalzeile normalerweise recht schnell.

Gehen Sie nochmal ins WebStorm-Terminal und geben Sie diesmal die Anweisung npm run prod (prod = production) ein. Es werden wieder die drei Dateien erstellt. Und die Web-Anwendung sollte immer noch funktionieren. Wenn Sie sich die gebündelte JavaScript-Datei web/js/main.js noch einmal ansehen, werden Sie feststellen, dass sie nun viel kleiner ist. Sie enthält keine überflüssige Leerzeichen, keine Zeilenumbrüche und auch keine Kommentare mehr (evtl. mit Ausnahme des Kommentars, der Auskunft über den Autor und die Lizenz gibt). Diese Datei ist für den Produktivbetrieb viel besser geeignet, da sie weniger Bandbreite verbraucht. Insbesondere Smartphone-Besitzer freuen sich über kleine Dateien, da ihr Datenvolumen dadurch weniger belastet wird. Für die Fehlersuche bei der Entwicklung der Web-App ist diese Variante allerdings vollkommen ungeeignet.

Nun können Sie noch die Anweisung npm run watch testen. Dieser startet einen webpack-Watcher, der bei jeder Änderung an einer Datei, die von webpack beim Bündeln berücksichtigt wird, dafür sorgt, dass die Dateien im Web-Ordner neu erstellt werden und Sie die Ergebnisse Ihrer Änderung durch einen einfachen Reload der Datei index.html im Browser betrachten können. Ändern Sie doch einmal in der CSS-Datei src/css/head.css (nicht in der Datei web/css/head.css) die Hintergrundfarbe, speichern Sie die Datei und laden Sie danach die HTML-Datei im Browser mittels des Reload-Buttons neu.

Vergessen Sie nicht:

  • Klick auf das Commit-Icon und anschließend git push.

5.6 webpack improved

Bislang wird im Produktivmodus nur die JavaScript-Datei komprimiert. Schöner wäre es, wenn auch die CSS-Datei und die HTML-Datei komprimiert werden würden. Und wenn man die Google-Vorgaben vollständig umsetzen möchte, sollte außerdem der komprimierte Inhalt der Datei head.css direkt in die Datei index.html eingefügt werden. All das kann man mit webpack erreichen.

Installieren Sie dazu folgende Node.js-Pakete:

# Die folgenden Pakete wurden schon installiert. 
# Das brauchen Sie nicht zu wiederholen.
# Es macht aber auch nichts, wenn Sie sie noch einmal installieren.
npm install --save-dev webpack webpack-cli
npm install --save-dev html-loader css-loader style-loader  
npm install --save-dev file-loader extract-loader  
npm install --save-dev suppress-chunks-webpack-plugin

# Die folgenden Pakete werden zusätzlich benötigt:
npm install --save-dev cssnano postcss-loader
npm install --save-dev posthtml-loader posthtml-inline-assets
npm install --save-dev html-webpack-plugin terser-webpack-plugin
npm install --save-dev

Nun müssen Sie „nur noch“ den Inhalt der Datei webpack.config.js ersetzen. (In dieser Datei steckt stundenlange Arbeit, da die webpack-Dokumentation häufig nicht so prickelnd ist und es Dutzende von Paketen gibt, die Ähnliches leisten, aber oft die ein oder andere Schwäche haben. Ich behaupte übrigens nicht, dass dies die perfekte Konfigurationsdatei ist, um die gewünschten Optimierungen zu erzielen. Aber sie funktioniert! Zumindest solange webpack5 nicht veröffentlicht wurde. )

const
  path                       = require('path'),
  TerserPlugin               = require('terser-webpack-plugin'),
  SuppressChunksPlugin       = require('suppress-chunks-webpack-plugin').default;

function absolutePath(l_path)
{ return path.resolve(__dirname, l_path); }

module.exports = function(p_env, p_argv)
{ let isProd = p_argv.mode === 'production';
  // isProd === true iff webpack is run in production mode

  return {
  // store the current mode ('production', 'development')
  // in the webpack object so that webpack plugins can access it
  mode:    p_argv.mode,

  // https://webpack.js.org/configuration/devtool/
  // 'eval-source-map' than 'inline-source-map' would be better.
  // However, using this devtool forces a developer using WebStorm
  // to authorize an error url created by webpack within WebStorm
  // before it can be viewed within the browser.
  devtool: isProd ? false : 'inline-source-map',
  
  entry:
  { // use the following files to create
    // web/index.html, web/css/head.css, web/js/main.js
    html: absolutePath('src/index.html'),
    head: absolutePath('src/css/head.css'),
    main: absolutePath('src/js/main.js'),
  },

  output:
  { // placesJavaScript files in dictionary web/js
    filename: 'js/[name].js',
    path: absolutePath('web'),
  },
  
  plugins:
  [ // delete html.js, head.js from output dictionary web/js
    // (For every member of the entry list, a JavaScript file
    // is created. index.html and head.css are extracted from
    // those files. So html.js and head.js are not needed
    // any longer.)
    new SuppressChunksPlugin(['html', 'head'])
  ],
  
  optimization:
  { minimizer:
    [ // minimizes ES6 JavaScript files
      // remove all JS comments but those that are marked to be preserved
      new TerserPlugin({ terserOptions: {output: {comments: /@preserve/}}})
    ]
  },
  
  module:
  { rules:
    [ { test:    /head\.css$/,
        use:     [ // store the extracted CSS content in a file
                   { loader: 'file-loader',
                     options: { name: '[name].[ext]',
                                outputPath: 'css/'
                              }
                   },
                   // extract the CSS content from the file loaded
                   'extract-loader',
                   // load the CSS file (using the optimizer defined below)
                   { loader: 'css-loader', options: { importLoaders: 1 } },
                   // optimize the CSS file
                   { loader: 'postcss-loader',
                     options: { sourceMap: 'inline',
                                plugins:
                                  () =>
                                  [ require('cssnano')
                                    ({ preset:
                                       [ 'default',
                                         { discardComments:
                                           // remove all CSS comments but those
                                           // that are marked tpo be preserved
                                           { remove: c => !c.match(/@preserve/) }
                                         }
                                        ],
                                    })
                                  ]
                              }
                   }
                 ]
      },

      { test:    /main\.css$/,
        exclude: [/node_modules/, /web/],
        use:     [ // enable to import CSS files into a JavaScript file
                   'style-loader',
                   // load the CSS file (using the optimizer defined below)
                   { loader: 'css-loader', options: { importLoaders: 1 } },
                   // optimize the CSS file
                   { loader: 'postcss-loader',
                     options: { sourceMap: 'inline',
                                plugins:   [ require('cssnano') ]
                                           // all CSS comments are removed
                              }
                   }
                 ]
      },

      { test:   /\.html$/,
        use:    [ // store the extracted HTML content in a file
                  { loader: 'file-loader',
                    options: { name: '[name].[ext]',
                               outputPath: '/'
                             }
                  },
                  // extract the HTML content from the file loaded
                  'extract-loader',
                  // load the HTML file; if on production mode minimize it
                  { loader: 'html-loader',
                    options: { minimize:                    isProd,
                               removeComments:              true,
                               ignoreCustomComments:        [/@preserve/],
                               //https://gist.github.com/stalniy/d55fc7990b4340c9d0ef55fd8838ed34
                               collapseWhitespace:          true,
                               conservativeCollapse:        false,
                               collapseInlineTagWhitespace: false,
                               removeAttributeQuotes:       false,
                               caseSensitive:               true,
                             }
                  },
                  { loader: 'posthtml-loader',
                    options:
                    { plugins:
                      [ require('posthtml-inline-assets')
                               ({ from: 'web/css', // 'web/web', 'web/abc' works as well ...
                                                   // this doesn't make any sense ...
                                  inline: { script: false }
                               })
                      ],
                    }
                  }
                ]
      },
    ]
  }
}};

Testen Sie den Übersetzungsmechanismus. Führen Sie npm run dev aus und sehen Sie sich die erzeugten Dateien an (insbesondere den Head-Bereich der Datei web/index.html). Führen Sie danach npm run prod aus und sehen Sie sich die Dateien noch einmal an.

Führen Sie die erzeugte Datei web/index.html jedes Mal auch im Browser aus und überprüfen Sie, ob sie noch funktioniert.

Übrigens: webpack wurde so konfiguriert, dass HTML-, CSS- und JavaScript-Kommentare, in denen das Schlüsselwort @preserve enthalten ist, auch in den komprimierten Code eingefügt werden. Das ist wichtig, wenn man Lizenzinformationen in diese Dateien einfügen möchte.

6 Quellen

  1. {{#var:beschreibung}} (Web), Kapitel „CSS-Bereitstellung optimieren“, https://developers.google.com/speed/docs/insights/OptimizeCSSDelivery
  2. {{#var:beschreibung}} (Web), Kapitel „Remove Render-Blocking JavaScript“, https://developers.google.com/speed/docs/insights/BlockingJS
  3. webpack: https://webpack.js.org/
  1. Kowarschick (MMProg): Wolfgang Kowarschick; Vorlesung „Multimedia-Programmierung“; Hochschule: Hochschule Augsburg; Adresse: Augsburg; Web-Link; 2018; Quellengüte: 3 (Vorlesung)