Refactoring in kleinen, verifizierten Schritten

Ziel

Die Struktur bestehenden Codes verbessern und dabei Schritt für Schritt garantieren, dass sein beobachtbares Verhalten unverändert bleibt.

Voraussetzungen

Tests, die das Verhalten des zu überarbeitenden Codes abdecken. Existieren keine, zuerst Charakterisierungstests schreiben: den Code mit repräsentativen Eingaben aufrufen und die aktuellen Ausgaben festschreiben.

Schritte

1. Die Zielstruktur und den zu beseitigenden Code-Smell festlegen; im Entwurf der Commit-Nachricht festhalten.
2. Jeweils ein benanntes Refactoring anwenden (Funktion extrahieren, umbenennen, verschieben, inline setzen, Parameterobjekt einführen), wo verfügbar mit Editor-Automatisierung.
3. Nach jedem Schritt die Tests laufen lassen. Schlagen sie fehl, den Schritt rückgängig machen statt vorwärts zu debuggen.
4. Nach jeder sinnvollen Gruppe von Schritten committen, mit einer Nachricht, die „refactor: …“ lautet und keine Verhaltensaussagen enthält.
5. Nie eine Verhaltensänderung in einen Refactoring-Commit mischen; Reviewer müssen darauf vertrauen können, dass ein Refactoring-Diff verhaltensneutral ist.
6. Aufhören, sobald der Smell beseitigt ist; nicht in spekulative Allgemeingültigkeit weitergehen.

Erwartetes Ergebnis

Eine Reihe kleiner Commits, jeder grün, jeder innerhalb von Minuten überprüfbar, die zusammen die beabsichtigte Struktur ergeben.

Grenzen und Prüfbasis

Tests schützen nur, was sie abdecken; Performance- und Nebenläufigkeitsverhalten können sich unbemerkt ändern. Umstrukturierung im grossen Massstab über Module hinweg benötigt dieselbe Disziplin zuzüglich eines Plans (siehe Branch by Abstraction oder das Strangler-Fig-Muster). Der Katalog der Schritte folgt der zitierten Referenz.