Code-Review in Java: Was man prüfen und wie man Anfängern Feedback geben sollte

Code-Review in Java: Was man prüfen und wie man Feedback geben sollte

Code-Review (Code-Überprüfung) ist nicht nur eine Formalität vor dem Mergen eines Pull-Requests. Es ist ein mächtiges Werkzeug zur Verbesserung der Codequalität, zum Wissensaustausch und zur Vermeidung von Fehlern. Für angehende Java-Entwickler löst die Teilnahme an einem Review oft Angst aus: "Was, wenn ich kritisiert werde?", "Was, wenn ich einen kritischen Fehler übersehe?". In diesem Artikel schauen wir uns an, worauf man bei der Überprüfung von Java-Code achten sollte und wie man Feedback gibt, das hilft und nicht demotiviert.

1. Was man in Java-Code prüfen sollte: Eine Checkliste für Anfänger

Der erste und wichtigste Schritt ist zu wissen, worauf man achten muss. Versuchen Sie nicht, alles auf einmal zu finden. Konzentrieren Sie sich auf die Schlüsselbereiche. Hier ist eine grundlegende Checkliste für das Code-Review in Java:

• Logik und Korrektheit: Löst der Code die gestellte Aufgabe? Gibt es offensichtliche logische Fehler? Werden Randfälle korrekt behandelt?
• Naming (Benennung): Entsprechen die Namen von Variablen, Methoden und Klassen den Java-Konventionen (camelCase, PascalCase)? Sind sie aussagekräftig? int a ist schlecht, int numberOfUsers ist gut.
• Fehlerbehandlung: Gibt es try-catch-Blöcke? Werden spezifische Ausnahmetypen anstelle der allgemeinen Exception verwendet? Werden Ausnahmen stillschweigend geschluckt (leerer catch-Block)?
• Leistung: Gibt es offensichtliche Probleme wie die Erstellung von Objekten innerhalb von Schleifen, die Verwendung von String-Verkettung mit + in einer Schleife (besser StringBuilder) oder unnötige Methodenaufrufe?
• Testen: Ist der Code durch Unit-Tests abgedeckt? Testen diese nur positive Szenarien oder auch negative und Randfälle?

Beispiel für schlechten Code, der im Review auffallen sollte:

public void processData(List data) {    for (Object item : data) {        String s = "";        for (int i = 0; i < 1000; i++) {            s += item.toString() + i; // Potenzielles Leistungsproblem        }        System.out.println(s);    }}

Was ist hier falsch? Die Verwendung von + in der Schleife erzeugt viele temporäre String-Objekte. Besser wäre es, durch StringBuilder zu ersetzen. Außerdem fehlt eine Null-Prüfung für data.

2. Wie man konstruktives Feedback gibt

Der schwierigste Aspekt eines Code-Reviews ist nicht die technische Prüfung, sondern die Kommunikation. Ihr Ziel ist es nicht zu zeigen, wer schlauer ist, sondern dem Team zu helfen, zu wachsen. Hier sind einige Regeln:

• Fokus auf den Code, nicht auf den Autor. Sagen Sie statt "Du hast schrecklichen Code geschrieben" lieber "Diese Methode kann man vereinfachen, indem man das Stream API verwendet".
• Verwenden Sie eine fragende Form. Stellen Sie anstelle von Behauptungen Fragen. Beispiel: "Warum wurde hier ArrayList statt LinkedList gewählt? Angesichts der häufigen Einfügungen am Listenanfang könnte LinkedList effizienter sein."
• Erklären Sie das "Warum". Ein einfaches "Ändere das" funktioniert nicht. Schreiben Sie: "Ersetzen wir == durch .equals() zum Vergleichen von Strings, weil == Referenzen und nicht den Inhalt vergleicht."
• Loben Sie guten Code. Wenn Sie eine elegante Lösung sehen, heben Sie sie hervor. "Hervorragende Verwendung des Builder-Patterns hier – der Code ist dadurch viel lesbarer geworden."

Beispiel für einen schlechten Kommentar: "Das ist Schrottcode, schreib es neu." Beispiel für einen guten Kommentar: "Ich finde, man könnte diesen Block in eine separate private Methode auslagern, um die Lesbarkeit der Hauptmethode zu verbessern. Was denkst du?"

3. Typische Anfängerfehler in Java und wie man sie aufzeigt

Wenn Sie die typischen Fehler kennen, können Sie sie schneller finden und relevantere Ratschläge geben. Hier sind die Top-3-Fehler, die bei angehenden Java-Entwicklern im Review häufig vorkommen:

Fehler 1: Ignorieren der Verträge von equals() und hashCode()