Zum Inhalt springen

Java-Module

Im ersten Eclipse-Kapitel haben wir das Häkchen bei Create module-info.java file entfernt – „ein fortgeschrittenes Thema“. Hier ist es. Wir werden in der Schulung keine eigenen Module bauen. Aber sie stecken im JDK, sie tauchen in Fehlermeldungen auf, und wer weiß, wofür es sie gibt, versteht die Java-Plattform besser.

  • erklären, welche Probleme der Classpath hat und warum es Module gibt
  • eine module-info.java lesen: requires, exports, uses
  • herausfinden, welche Module ein Programm braucht
  • Java-Module von Maven-Modulen unterscheiden

Bisher landet alles auf einem Classpath: unsere Klassen, die JAR-Datei von H2, die von JUnit. Für Java ist das ein großer Haufen Klassen ohne Grenzen. Das hat Folgen:

  • public heißt: für alle. Jede public Klasse in jeder JAR-Datei kann von überall benutzt werden – auch Klassen, die eine Bibliothek nur für sich selbst gedacht hatte. Wer sie benutzt, bricht beim nächsten Update der Bibliothek. Das JDK hat das jahrelang erlebt: Viele Programme benutzten interne Klassen wie sun.misc.Unsafe, die nie für sie gedacht waren.
  • Was fehlt, merkt man erst beim Start. Unser Programm aus dem Kapitel JDBC ließ sich ohne H2 übersetzen – und meldete erst beim Ausführen No suitable driver found. Bei einer fehlenden Klasse kommt im schlimmsten Fall erst nach Stunden ein NoClassDefFoundError, wenn der Code zum ersten Mal an die Stelle kommt.
  • Doppelte Klassen. Liegen zwei Versionen derselben Bibliothek auf dem Classpath, gewinnt die, die zuerst gefunden wird. Welche das ist, hängt von der Reihenfolge ab. Dafür gibt es einen eigenen Begriff: die JAR-Hölle.
  • Das JDK war ein Block. Bis Java 8 steckte die ganze Standardbibliothek in einer Datei, rt.jar. Wer nur System.out.println brauchte, bekam trotzdem die Klassen für Datenbanken, XML und grafische Oberflächen mit.

Ein Modul ist eine Gruppe von Packages mit einem Namen und klaren Grenzen. Was es braucht und was es anbietet, steht in einer Datei module-info.java im obersten Quellordner:

module-info.java
module de.drv.zeiterfassung {
requires java.sql; // was ich brauche
exports de.drv.zeiten; // was andere von mir benutzen dürfen
}
Schlüsselwort bedeutet
requires Dieses Modul braucht ein anderes. Fehlt es, startet das Programm gar nicht erst.
exports Dieses Package dürfen andere Module benutzen. Alle anderen bleiben innen.
requires transitive Wer mich braucht, bekommt das andere Modul gleich mit.
uses / provides Ein Modul sucht Implementierungen eines Interfaces – oder bietet eine an. Das ist der ServiceLoader aus dem Kapitel Verträge.

java.base – mit String, List, Path und allem Grundlegenden – braucht jedes Modul. Es muss nicht hingeschrieben werden.

Im Kapitel Kapselung haben wir das Haus mit seinen Zimmern gesehen: private, Package, protected, public. Module setzen eine Grenze darüber: Ein public Typ in einem Package, das nicht exportiert wird, ist nur innerhalb des Moduls sichtbar. Draußen gibt es ihn nicht.

Fehlt ein requires, sagt es der Compiler sofort – nicht erst beim Start:

Terminal-Fenster
NeuMitErstemTag.java:3: Fehler: Package java.sql ist nicht sichtbar
import java.sql.Connection;
^
(Package java.sql wird in Modul java.sql deklariert, aber nicht von Modul de.drv.zeiterfassung gelesen)

Mit Java 9 wurde das JDK selbst in rund 70 Module zerlegt. Eine Liste zeigt:

PowerShell
java --list-modules

Wie ein Modul aufgebaut ist, verrät --describe-module. Das Modul, das wir für JDBC benutzt haben:

PowerShell
java --describe-module java.sql
Terminal-Fenster
java.sql@25.0.4
exports java.sql
exports javax.sql
requires java.transaction.xa transitive
requires java.logging transitive
requires java.xml transitive
requires java.base mandated
uses java.sql.Driver

(Hinter dem @ steht die Version des JDK – auf den Schulungsrechnern also eine 21.)

Hier steht im Kleinen, was wir im Kapitel JDBC gesehen haben:

  • exports java.sql – das sind die Interfaces Connection, Statement, ResultSet.
  • uses java.sql.Driver – das Modul sucht Implementierungen des Interfaces Driver. Genau so findet der DriverManager den H2-Treiber.
  • requires java.base mandated – java.base ist immer dabei.

Das Werkzeug jdeps aus dem JDK sieht in eine JAR-Datei und listet auf, was sie braucht – etwa das JAR aus dem Kapitel Maven:

PowerShell
jdeps --list-deps target\zeiterfassung-1.0-SNAPSHOT.jar
Terminal-Fenster
java.base
java.sql

Wenn feststeht, welche Module ein Programm braucht, kann man eine Java-Laufzeit bauen, die nur diese enthält:

PowerShell
jlink --add-modules java.base,java.sql --strip-debug --no-header-files --no-man-pages --output laufzeit

Das Ergebnis ist ein Ordner laufzeit mit eigenem bin\java.exe – und den fünf Modulen, die java.sql mit sich zieht: java.base, java.logging, java.sql, java.transaction.xa, java.xml. Auf einem Testrechner war diese Laufzeit 55 MB groß, das vollständige JDK 294 MB. Für Programme in Containern oder auf kleinen Geräten ist das ein echter Unterschied.

Module sind im JDK angekommen – in den meisten Anwendungen noch nicht:

  • Viele Bibliotheken sind keine richtigen Module. Eine JAR-Datei ohne module-info wird als automatisches Modul behandelt – das geht, aber mit Einschränkungen und manchmal mit überraschenden Fehlern.
  • Der Classpath funktioniert weiter. Programme ohne module-info.java landen im unbenannten Modul und verhalten sich wie vor Java 9. So laufen alle unsere Projekte.
  • Frameworks wie Spring Boot setzen meist auf den Classpath. Wer in einem Spring-Projekt arbeitet, schreibt in der Regel keine module-info.java.

Wo man ihnen begegnet:

  • in Fehlermeldungen wie module java.base does not export … – wenn Code auf interne Klassen des JDK zugreifen will, die seit Java 9 verschlossen sind,
  • in Bibliotheken, die eine module-info.java mitbringen,
  • beim Ausliefern mit jlink oder beim Prüfen mit jdeps.
Classpath Module
Grenzen keine – alles public ist überall sichtbar nur exportierte Packages sind von außen sichtbar
Abhängigkeiten stillschweigend – fehlt etwas, kracht es irgendwann ausdrücklich mit requires – fehlt etwas, startet nichts
JDK alles oder nichts nur die Module, die gebraucht werden (jlink)
Verbreitung fast alle Anwendungen das JDK selbst, einige Bibliotheken