Packages sind ein oft vernachlässigtes Mittel, eine Anwendung zu strukturieren. Mit ein paar einfachen Regeln und dem Open-Source-Tool Degraph können Packages genutzt werden, um das Verständnis von Anwendungen zu vereinfachen, Codeduplizierung zu vermeiden und Wiederverwendung zu ermöglichen.
Nur extrem kleine Projekte kann ein Entwickler vollständig überblicken. Alles, was einem realistischen Zweck dient, ist schnell so umfangreich, dass niemand mehr alle Codezeilen im Kopf hat. Zum Glück ist das auch nicht notwendig, denn in der Softwareentwicklung hat sich schon lange das Prinzip der Datenkapselung [1] etabliert. Wir lagern Funktionalität in eigene Komponenten aus und müssen uns dann nicht mehr um die Details kümmern, wie diese Komponenten intern funktionieren.
Für solche Komponenten stehen Java-Entwicklern unterschiedliche Konzepte zur Verfügung. Auf unterster Ebene ist dies die Methode. Methoden werden in Klassen versammelt und Klassen in JAR-Dateien. Das klingt alles ganz wunderbar, bis man einmal schaut, wie groß diese Bündel sind. Die Anzahl Zeilen in einer Methode liegt in der Größenordnung von zehn – hoffentlich zumindest –, ebenso die Anzahl Methoden in einer Klasse. Die Anzahl Klassen in einer JAR-Datei ist aber oft beliebig groß. In diesem Bereich fehlt ein standardisiertes Strukturierungselement. Viele Leser des Eclipse Magazins nutzen sicher OSGi-Module. Andere brechen ihr Projekt in verschiedene Maven-Module auf. Dies ist zwar ein valider Ansatz, bringt aber oft zu viel Overhead mit sich, wenn diese Module nicht auch aus anderen Gründen genutzt werden, z. B. um sie separat auszuliefern.
Es gibt in Java jedoch ein Strukturierungsmittel zwischen Klassen und deploybaren Artefakten: Packages. Leider sind Packages in Java etwas „anämisch“. Außer, dass sie separate Namensräume definieren, bieten sie kaum Funktionalität. Dies wiederum führt dazu, dass sie in vielen Projekten stiefmütterlich behandelt werden. Während viele Entwickler sich Gedanken machen, was in eine Klasse gehört und was besser extrahiert werden sollte, machen das nur wenige, wenn es um Packages geht. Dies halte ich für einen Fehler. Ich setze mich in meinen Projekten deshalb dafür ein, dass für Packages die im Folgenden beschriebenen Regeln gelten.
Packages dürfen keine zyklischen Abhängigkeiten haben
Dass Packages keine zyklischen Abhängigkeiten haben sollen, ist ein Klassiker und wird von vielen statischen Codeanalysetools überprüft. Aber warum ist das eigentlich so wichtig? Packages sind eigenständige Komponenten, d. h. Dinge, die wir zumindest potenziell aus unserer Codebasis heraustrennen können. Dies geht aber nicht mehr, wenn es zyklische Abhängigkeiten gibt. Wenn zwei Packages A und B wechselseitig voneinander abhängen, sind es in Wirklichkeit nicht zwei Komponenten, sondern eine, die sich nur unscharf auf zwei Namensräume verteilt.
Der eine oder andere hat es sicher schon erlebt: Das Nachbarprojekt hat genau das gebaut, was man gerade benötigt, aber leider kann man es nur benutzen, wenn man den ganzen Rest der Anwendung mit verwendet, oder das Ganze heftig refaktorisiert. Genau diese Situationen entstehen, wenn Packages nicht frei von Zyklen sind. Bei zyklenfreien Packagestrukturen findet sich die allgemein hilfreich Funktionalität, die für andere Projekte nützlich ist, weit am Ende des Abhängigkeitsgraphen, mit wenigen oder ganz ohne Abhängigkeiten. Allgemein wachsen durch eine zyklenfreie Struktur die Anteile der Anwendung, die unabhängig voneinander bearbeitet und verstanden werden können. Es können also zwei Personen oder Teams an diesen Bereichen arbeiten, ohne sich gegenseitig zu beeinflussen. Auch kann der eine Teil ohne den anderen verstanden werden. Dies erleichtert das Durchdringen großer Codebasen erheblich.
Namen müssen einem klaren Prinzip folgen
Ein weiteres wichtiges einfaches, aber oft vernachlässigtes Prinzip ist es, eine klare Struktur für Packagenamen zu verwenden. Nur zu oft findet man auf einer Ebene Subpackages wie customer, purchasing, persistence, uti. Mit einer solchen Struktur (beziehungsweise mit der Abwesenheit einer klaren Struktur) wird es schwierig, den richtigen Ort für eine Klasse zu finden. Was gehört in das util-Package? Und gehört eine Klasse zum Laden eines Kunden aus der Datenbank in persistence oder in customer?
Dabei können wir einfach Abhilfe schaffen: Auf jeder Ebene muss es genau ein Kriterium geben, anhand dessen entschieden wird, in welches Subpackage eine Klasse gehört. Typische Kriterien sind:
-
Deploybares Artefakt: In welchem JAR oder WAR landen die Artefakte in den verschiedenen Subprojekten? Es ergibt wenig Sinn, Dinge, die nicht gemeinsam ausgeliefert werden, in ein Package zu stecken. Die einzige Ausnahme von dieser Regel sind Tests, die üblicherweise im gleichen Package wie der zu testende Code liegen, aber normalerweise nicht gemeinsam mit ausgeliefert werden.
-
Fachliches Modul: Dies ist das vielleicht am häufigsten vernachlässigte Unterscheidungskriterium, dabei ist es eins der wichtigsten. Fachliche Module, auch wenn sie nur als Packages existieren, kommunizieren jemandem, der den Code liest, sehr viel über die Anwendung: Was sind die wesentlichen fachlichen Begriffe? Worum geht es eigentlich in der Anwendung? Dies kann eine saubere fachliche Struktur dokumentieren.
-
Technische Schicht: Dies ist wohl das Kriterium, das den meisten als Erstes einfällt, wenn sie über Packagestrukturen nachdenken. Dabei ist es vielleicht das Kriterium, auf das man am ehesten verzichten kann. Natürlich sollte die UI-Schicht nicht direkt auf die Persistenzschicht zugreifen. Aber wenn die fachlichen Module klein sind, sind in der technischen Schicht eines fachlichen Moduls oft nur wenige oder sogar nur eine einzige Klasse vorhanden. Da kann man mit ein wenig Disziplin auch so darauf achten, dass nur die Abhängigkeiten existieren, die wirklich sinnvoll sind. Dennoch ist dies ebenfalls ein valides Kriterium, um eine Codebasis zu unterteilen.
Wichtig ist, dass auf jeder Ebene exakt ein solches Kriterium verwendet wird und nicht mehrere verschiedene. Insgesamt ergibt sich dann für Enterprise-Anwendungen immer wieder eine Package-Struktur wie die folgende:
<domainprefix>.<produkt...

