Codequalität mit Live-Refactoring verbessern

Mit komplexer Software zu arbeiten kann echt schwierig sein. Wenn der Code grösser wird, wird er schwerer zu lesen, zu aktualisieren und zu warten. Das kann zu Problemen führen, die dazu führen, dass die Software schlecht läuft oder schwer zu handhaben ist. Um diese Probleme zu beheben, können Entwickler den Code umstrukturieren, was bedeutet, dass sie ihn ändern, um die Struktur und Lesbarkeit zu verbessern, ohne das Verhalten zu verändern. Es gibt Refactoring-Tools, die Entwicklern helfen, diese Verbesserungen einfacher vorzunehmen. Allerdings können viele dieser Tools langsam sein oder bieten nur Unterstützung, wenn man danach fragt, was es für Entwickler schwierig macht, schnell Änderungen vorzunehmen.

Um dieses Problem anzugehen, haben wir die Idee des Live Refactorings untersucht. Dieser Ansatz zielt darauf ab, in Echtzeit Vorschläge zur Verbesserung des Codes zu geben, während Entwickler daran arbeiten. Wir haben eine Live Refactoring-Umgebung erstellt, die visuell Wege zur Refaktorisierung von Code identifiziert und empfiehlt. Dabei konzentriert sie sich speziell auf eine gängige Refactoring-Methode, die als Extract Method bekannt ist und grosse Methoden in kleinere, handlichere aufteilt.

#Warum Refactoring wichtig ist

Refactoring ist entscheidend, um hochwertige Software zu erhalten. Komplexer Code kann „Code smells“ enthalten, das sind Signale, dass etwas nicht stimmt. Dazu gehören lange Methoden, die zu viel machen, oder wiederholter Code, der die Wartung erschwert. Wenn man diese Code smells nicht angeht, kann das zu grösseren Problemen führen, die den Code noch schwieriger zu bearbeiten machen.

Viele Entwickler wissen, dass sie ihren Code refaktorisieren müssen, um ihn sauber zu halten, aber der Prozess kann zeitaufwändig sein. Traditionelle Refactoring-Tools erfordern oft, dass Entwickler manuell nach Problemen suchen und dann Lösungen anwenden. Dieser Prozess kann Zeit in Anspruch nehmen und die Entwickler aus ihrem Fluss reissen, was es schwer macht, fokussiert zu bleiben.

#Was ist Live Refactoring?

Live Refactoring zielt darauf ab, dies zu ändern, indem es sofortiges Feedback und Vorschläge liefert, während Entwickler codieren. Durch diesen Echtzeitzugang können Entwickler die Probleme sehen, sobald sie auftreten, und sofortige Hilfe zur Behebung erhalten. Live Refactoring betont drei Schlüsselschritte: potenzielle Refaktorisierungen identifizieren, Änderungen empfehlen und sie automatisch anwenden. So müssen Entwickler nicht warten, bis sie mit dem Codieren fertig sind, um ihre Arbeit zu verbessern.

Unsere Live Refactoring-Umgebung wurde als Plugin für die IntelliJ IDE entwickelt, ein beliebtes Tool für die Java-Entwicklung. Mit dieser Umgebung können Entwickler Extract Method-Refaktorisierungen schnell und effizient durchführen, während sie noch codieren.

#Forschungsfragen

Um die Effektivität unserer Live Refactoring-Umgebung zu bewerten, haben wir drei Forschungsfragen formuliert:

1. Wie beeinflusst eine Live Refactoring-Umgebung das Bewusstsein der Entwickler für die Qualität ihres Codes?
2. Wie wirkt sich das auf die Qualität des Codes selbst aus?
3. Wie viel Zeit spart es Entwicklern, um qualitativ hochwertigeren Code zu erreichen?

#Das Experiment

Um diese Fragen zu beantworten, haben wir ein Experiment mit mehreren Programmieraufgaben eingerichtet. Eine Gruppe von Programmierstudierenden nahm teil und wurde in vier Gruppen aufgeteilt, die jeweils verschiedene Tools und Methoden zur Anwendung von Refaktorisierungen verwendeten.

#Experimentaufbau

Die Teilnehmer erhielten über ein Google-Formular die benötigten Materialien, um die Aufgaben zu erledigen. Dazu gehörten die Aufgabebeschreibungen, der Quellcode, an dem sie arbeiten sollten, Anleitungshandbücher und Informationen über die Refactoring-Umgebung, die sie nutzen sollten. Die Aufgaben hatten unterschiedliche Schwierigkeitsgrade und waren so konzipiert, dass sie jeweils nicht länger als 45 Minuten dauerten.

Gruppe A1 verwendete die Live Refactoring-Umgebung, die wir entwickelt haben. Gruppe A2 hatte ein Tool, das nur die schwerwiegendsten Refactoring-Kandidaten pro Codierungssitzung anzeigte. Gruppe A3 nutzte ein Tool, das eine Liste aller verfügbaren Refactoring-Vorschläge in einem separaten Dokument bereitstellte. Schliesslich hatte Gruppe B keinen Zugriff auf Refactoring-Tools und arbeitete nur mit einem Plugin, das Projektmetriken misst.

#Programmieraufgaben

Die Aufgaben waren für alle Gruppen identisch, variieren aber in der Komplexität:

1. Aufgabe 1 diente als Aufwärmübung. Die Teilnehmer arbeiteten an einem einfachen Filmverleihsystem und konzentrierten sich auf ein bekanntes Beispiel für die Extrahierung von Methoden.
2. Aufgabe 2 beinhaltete ein komplexeres „Space Invaders“-Projekt. Die Teilnehmer mussten spezifische Spielzyklusmethoden implementieren und dabei Möglichkeiten zur Extrahierung von Methoden identifizieren.
3. Aufgabe 3 konzentrierte sich auf das JHotDraw-Projekt, das grösser ist und mehrere Klassen mit umfangreichem Code hat. Die Teilnehmer sollten Extract Method-Refaktorisierungen auf bestimmten Klassen identifizieren und anwenden.

#Ergebnisse des Experiments

Nach Abschluss des Experiments sammelten wir verschiedene Ergebnisse, um zu analysieren, wie gut jede Herangehensweise abschnitt.

#Hintergrund der Teilnehmer

Wir sammelten Informationen über die Programmiererfahrung und die Vertrautheit jedes Teilnehmers mit den Tools. Die meisten von ihnen waren im Umgang mit Java kompetent, hatten jedoch nur begrenzte Erfahrungen mit Refactoring-Tools.

#Codequalität

Wir schauten uns an, wie gut sich die Codequalitätsmetriken nach der Anwendung von Refaktorisierungen verbesserten. Alle Gruppen sahen positive Veränderungen, aber die Gruppen, die die Live Refactoring-Umgebung verwendeten, erzielten die besten Ergebnisse. Die Teilnehmer dieser Gruppe wendeten die meisten Refaktorisierungen an, was zu besserem Code führte.

#Anzahl der angewendeten Refaktorisierungen

Wir haben die Anzahl der von jeder Gruppe angewendeten Refaktorisierungen erfasst. Gruppe A1, die die Live Refactoring-Umgebung nutzte, hatte die höchste Anzahl angewendeter Refaktorisierungen, während Gruppe B die wenigsten anwendete. Das deutet darauf hin, dass ein unterstützendes Refactoring-Tool Entwicklern helfen kann, mehr Änderungen vorzunehmen und ihren Code zu verbessern.

#Zeiteffizienz

Wir haben gemessen, wie lange die Teilnehmer benötigten, um die Refactoring-Aufgaben abzuschliessen. Gruppen, die unsere Live Refactoring-Umgebung verwendeten, schlossen deutlich schneller ab als Gruppe B, die keine Toolunterstützung hatte. Das deutet darauf hin, dass Live-Feedback den Entwicklern hilft, fokussiert zu bleiben und Änderungen effizient vorzunehmen.

#Beantwortung der Forschungsfragen

Mit den gesammelten Daten konnten wir die ursprünglichen Forschungsfragen beantworten.

#RQ1: Bewusstsein für die Codequalität

Die Live Refactoring-Umgebung half den Entwicklern, sich mehr über potenzielle Probleme in ihrem Code bewusst zu werden. Die Teilnehmer berichteten, dass sie dank der in Echtzeit sichtbaren Refactoring-Vorschläge bessere Entscheidungen über ihre Programmierpraktiken treffen konnten.

#RQ2: Auswirkungen auf die Codequalität

Die Ergebnisse zeigten, dass sich die Codequalität mit Hilfe der Live Refactoring-Umgebung verbesserte. Die Metriken zeigten, dass Gruppen, die die Umgebung nutzten, besseren Code hatten als solche, die sich ausschliesslich auf manuelle Refaktorisierungen verliessen. Das bestätigt, dass Echtzeitvorschläge für die Codequalität vorteilhaft sind.

#RQ3: Zeiteffizienz

Die Umgebung reduzierte die Zeit, die für die Anwendung von Refaktorisierungen benötigt wurde, erheblich im Vergleich zu manuellen Methoden. Die Teilnehmer, die unser Tool verwendeten, schlossen die Aufgaben schneller ab, was die Effizienz von Live-Unterstützung beim Codieren zeigt.

#Einschränkungen

Obwohl die Ergebnisse vielversprechend waren, gab es einige Einschränkungen in unserer Studie. Die Anzahl der in der Live Refactoring-Umgebung verfügbaren Refaktorisierungen war auf das Extrahieren von Methoden für diese spezielle Studie beschränkt. Zukünftige Arbeiten müssen daher zusätzliche Refaktorisierungen einbeziehen, um ein breiteres Spektrum an Code smells abzudecken.

Eine weitere Einschränkung war die Zeit, die die Umgebung benötigte, um den Code zu analysieren und Refactoring-Vorschläge zu präsentieren. Mit zunehmender Grösse des Codes nahm auch die Verarbeitungszeit zu. Damit unser Ansatz wirklich effektiv ist, müssen wir diese Inspektionszeit optimieren.

#Zukünftige Richtungen

Für die Zukunft zielen wir darauf ab, die Fähigkeiten der Live Refactoring-Umgebung zu erweitern, indem wir weitere Refactoring-Optionen wie Extract Class und Extract Variable einbeziehen. Wir werden auch daran arbeiten, die Geschwindigkeit und Reaktionsfähigkeit der Umgebung zu verbessern, um sicherzustellen, dass sie auch in grösseren Codebasen hilfreich bleibt.

Zusätzlich planen wir, das Experiment mit einer grösseren und vielfältigeren Gruppe von Teilnehmern zu wiederholen. Durch Tests mit professionellen Entwicklern können wir die Effektivität des Tools in realen Szenarien bewerten und wertvolles Feedback erhalten.

#Fazit

Zusammenfassend zeigt unsere Forschung, dass eine Live Refactoring-Umgebung den Refactoring-Prozess für Entwickler erheblich verbessern kann. Sie erhöht das Bewusstsein für die Codequalität, verbessert die tatsächliche Codequalität und reduziert die für das Refactoring benötigte Zeit. Dieser Ansatz bietet eine effektivere Möglichkeit, mit Code smells umzugehen und sauberere, wartungsfreundlichere Software zu erstellen. Durch die Einbeziehung von Live-Unterstützung und visuellen Feedback können Entwickler in ihrem Fluss beim Codieren bleiben, während sie notwendige Verbesserungen vornehmen. Während wir weiterhin an diesem Tool arbeiten, streben wir an, eine benutzerfreundlichere Umgebung zu schaffen, die die Programmierpraktiken unterstützt und zu qualitativ hochwertigerer Software führt.