Wir haben versucht, eine große Codebasis in logische Module zu unterteilen. Ich würde gerne einige Empfehlungen für Tools sowie alle Erfahrungen, die Sie mit dieser Art von Dingen haben könnten, haben.
Die Anwendung besteht aus einer Server WAR und mehreren Rich-Clients, die in JARs verteilt sind. Das Problem ist, dass es alles in einer großen, haarigen Codebasis, einem Quellbaum von & gt; 2k Dateien Krieg. Jede JAR verfügt über eine dedizierte Klasse mit einer main -Methode, aber das Gewirr von Abhängigkeiten ist schnell verzwickt. Es ist gar nicht so schlecht, gute Praktiken wurden konsequent befolgt und es gibt Komponenten mit spezifischen Aufgaben. Es braucht nur einige Verbesserungen, um unserem Team zu helfen, zu wachsen.
Die Module befinden sich jeweils in einem Maven-Projekt, das von einem Eltern-POM erstellt wurde. Der Prozess hat bereits damit begonnen, jedes JAR / WAR in sein eigenes Projekt zu verschieben, aber es ist offensichtlich, dass dies nur die Oberfläche kratzen wird: ein paar Klassen in jeder App JAR und ein Mammut- "Legacy" -Projekt mit allem anderen. Außerdem gibt es bereits einige Einheiten- und Integrationstests.
Jedenfalls bin ich an Tools, Techniken und allgemeinen Ratschlägen interessiert, um eine zu große und verwickelte Code-Basis in etwas überschaubarer zu zerlegen. Free / Open Source ist bevorzugt.
Schauen Sie sich eine Struktur 101 an. Es ist großartig, Abhängigkeiten zu visualisieren und die Abhängigkeiten aufzuzeigen, die auf Ihrem Weg zu einer saubereren Struktur zu brechen sind.
Wir haben kürzlich eine ähnliche Aufgabe erfüllt, d. h. ein Projekt, das aus & gt; 1k Quelldateien mit zwei Hauptklassen, die aufgeteilt werden mussten. Wir hatten vier verschiedene Projekte, eines für die Basis-Utility-Klassen, eines für das Client-Datenbank-Zeug, eines für den Server (das Projekt ist eine RMI-Server-Client-Anwendung) und eines für das Client-GUI-Zeug. Unser Projekt musste getrennt werden, da andere Anwendungen den Client nur als Befehlszeile verwendeten und wenn Sie versehentlich eine der gui-Klassen verwendet haben, gab es kopflose Ausnahmen, die nur beim Start auf dem headless Deployment Server auftraten.
Einige Dinge, die wir aus unserer Erfahrung wissen sollten:
Zwei Ratschläge: Das erste, was Sie brauchen, ist Test-Suiten. Der zweite Ratschlag besteht darin, in kleinen Schritten zu arbeiten.
Wenn Sie bereits eine starke Testsuite haben, sind Sie in einer guten Position. Ansonsten würde ich einige gute High-Level-Tests (aka: Systemtests).
Der Hauptvorteil von High-Level-Tests ist, dass eine relativ geringe Anzahl von Tests eine gute Abdeckung erzielen kann. Sie werden Ihnen nicht helfen, einen Fehler zu lokalisieren, aber Sie werden das nicht wirklich brauchen: Wenn Sie in kleinen Schritten arbeiten und sicherstellen, dass die Tests nach jeder Änderung ausgeführt werden, können Sie schnell erkennen (versehentlich eingeführt) Bugs: Die Wurzel des Bugs ist in dem kleinen Teil des Codes seit der letzten Ausführung der Tests geändert worden.
Ich würde mit den verschiedenen Aufgaben beginnen, die Sie ausführen müssen.
Ich hatte vor kurzem eine ähnliche Aufgabe, da ich eine 15 Jahre alte Codebasis hatte, die von einer Reihe von Entwicklern erstellt wurde, die untereinander keine Kommunikation hatten (eine arbeitete am Projekt, links, dann eine andere) eingestellt, usw., ohne Übersprechen). Das Ergebnis ist ein totaler Mischmasch von sehr unterschiedlichen Stilen und Qualitäten.
Damit es funktioniert, mussten wir die notwendige Funktionalität isolieren, die sich vom dekorativen Flaum unterscheidet, damit alles funktioniert. Zum Beispiel gibt es eine Menge verschiedener String-Klassen und eine Person hat viel Zeit damit verbracht, eine 2k-Zeilen-Conversion zwischen COleDateTime zu const char* und wieder zurück zu machen; Das war Fluff, Code, um eine Aufgabe zu lösen, die neben dem Hauptziel stand (Dinge in und aus einer Datenbank zu bekommen).
Was wir letztendlich tun mussten, war ein großes Ziel zu identifizieren, das dieser Code erreichte, und dann die Basislogik dafür zu schreiben. Wenn es eine Aufgabe gab, die wir erledigen mussten, die wir schon vorher gemacht hatten, fanden wir sie und verpackten sie in Bibliotheksaufrufe, so dass sie alleine existieren konnte. Ein Code-Chunk aktiviert beispielsweise einen USB-Gerätetreiber, um ein Bild zu erstellen. Dieser Code bleibt von diesem aktuellen Projekt unberührt, wird aber bei Bedarf über Bibliotheksaufrufe aufgerufen. Ein anderer Code-Chunk funktioniert mit dem Sicherheits-Dongle, und ein anderer fragt Remote-Server nach Daten ab. Das ist alles notwendige Code, der gekapselt werden kann. Der Zeichnungscode war jedoch über 15 Jahre lang gebaut worden, und solch ein Gebäude zum Wahnsinn, dass ein OpenGL-Umschreiben im Laufe eines Monats die Zeit besser nutzte, als zu versuchen herauszufinden, was jemand anderes getan hatte und dann hinzuzufügen dazu.
Ich bin ein bisschen handwavy hier, weil unser Projekt MFC C ++ zu .NET C # war, aber die Grundprinzipien gelten:
Ich hoffe, das hilft ...
Um Itays Antwort fortzusetzen, empfehle ich, Michael Feathers "Effektiv mit Legacy-Code arbeiten" (pdf) . Er empfiehlt außerdem, jeden Schritt mit Tests zu untermauern. Es gibt auch eine Buchversion .
Maven ermöglicht es Ihnen, kleine Projekte als Kinder eines größeren zu erstellen. Wenn Sie einen Teil Ihres Projekts als separate Bibliothek für andere Projekte extrahieren möchten, können Sie dies auch mit maven tun.
Nachdem Sie das gesagt haben, müssen Sie definitiv Ihre Aufgaben dokumentieren, was jedes kleinere Projekt erreichen wird, und dann (wie hier schon mehrfach angegeben) testen, testen, testen. Sie benötigen Tests, die das gesamte Projekt durchlaufen, und dann Tests, die mit den einzelnen Teilen des Projekts arbeiten, die als Kinderprojekte enden.
Wenn Sie anfangen, Funktionen zu entfernen, benötigen Sie zusätzliche Tests, um sicherzustellen, dass Ihre Funktionalität konsistent ist und dass Sie die Eingabe in Ihre verschiedenen untergeordneten Projekte simulieren können.
Tags und Links java refactoring