Java-Codierungskonventionen. Welchen man folgen sollte und warum

Die Kenntnis und Einhaltung von Industriestandards und Best Practices ist in jedem Bereich sehr wichtig, insbesondere in der Programmierung mit ihrer komplexen und manchmal chaotischen Mischung aus Programmiersprachen, Tools, Ansätzen und Technologien. Aus diesem Grund sollte ein professioneller Java-Programmierer mit den Java-Codierungskonventionen gut vertraut sein, worüber wir heute sprechen werden.

Was sind Codierungskonventionen?

Codierungskonventionen sind Richtliniensätze für jede spezifische Programmiersprache mit Empfehlungen zu verschiedenen Aspekten der Softwareentwicklung in dieser Sprache, einschließlich Codierungsstil, Best Practices und Methoden. Codierungskonventionen sollen von Softwareprogrammierern befolgt werden, die in dieser Sprache programmieren. Sie dienen als Qualitätsrichtlinien, um sicherzustellen, dass ihr Code lesbar ist und die ordnungsgemäße Wartung der Software durch andere Personen möglich ist. Codierungskonventionen decken normalerweise alle wesentlichen Komponenten der Softwareerstellung in dieser Programmiersprache ab, einschließlich Dateiorganisation, Einrückung, Kommentare, Deklarationen, Anweisungen, Leerzeichen, Namenskonventionen, Programmierpraktiken, Programmierprinzipien, Faustregeln für die Programmierung, bewährte Methoden für die Architektur und mehr .

Was ist der Zweck von Codierungskonventionen?

Es gibt eine Reihe von Gründen, warum Codierungskonventionen in der Softwareentwicklung eine wichtige Rolle spielen.

• Beibehaltung eines einheitlichen Codestils

Das Befolgen einer Codierungskonvention ermöglicht es, das Softwareprojekt in einem einzigen einheitlichen Stil zu schreiben, was in vielerlei Hinsicht von Vorteil ist, wie zum Beispiel im Folgenden.

• Minimierung der Softwarewartungskosten

Einer der wichtigsten Punkte ist die Vereinfachung der Wartung und des Supports des Softwareprodukts, da es sehr oft nicht die ursprünglichen Autoren des Programms sind, die es unterstützen. Dies ist wichtig, da 80 % der Lebenszeitkosten einer Software für die Wartung anfallen.

• Verbesserung der Lesbarkeit der Software

Die Verbesserung der Lesbarkeit der Software ist ein weiterer großer Vorteil, der auch mehrere Auswirkungen hat, wie z. B. die Vereinfachung der Einführung neuer Entwickler in das Projekt und die Steigerung der Effizienz der Zusammenarbeit der Mitglieder des Entwicklungsteams.

• Beschleunigung der Arbeit

Schließlich ist ein ordnungsgemäß geschriebener und strukturierter Code erforderlich, damit der Softwareentwicklungsprozess so schnell wie möglich abläuft.

Java-Codierungskonventionen

Wenn es um Java geht, gibt es zwei gebräuchlichste und bekannteste Codierungskonventionen: die Java Code Conventions von Oracle und die Java Style Guide Codierungskonvention von Google .

• Oracles Java Code Convention

Die Code-Konvention von Oracle gilt aus mehreren offensichtlichen Gründen als die wichtigste: Die Konvention von Oracle ist die offizielle, da Oracle der Eigentümer von Java ist, und außerdem eine der ältesten (die letzte Überarbeitung dieses Dokuments erfolgte am 20. 1999). Zu den wichtigen Teilen der Java-Codekonvention von Oracle gehört die Empfehlung, beim Definieren von Klassen, Methoden oder Variablen die Kamelschreibung zu verwenden, Klassen mit einem Großbuchstaben zu beginnen und Substantive zu verwenden, um sie zu benennen, während Verben in Imperativform und am Anfang verwendet werden aus einem Kleinbuchstaben für Methoden usw.

• Googles Java Style Guide

Die Java-Codierungskonventionen von Google werden aufgrund des Status von Google als lernendes Internet- und Technologieunternehmen mit enormer Erfahrung in der Entwicklung aller Arten von Java-Anwendungen als wichtig erachtet. Ein weiterer wichtiger Grund ist die Tatsache, dass die Java-Codekonvention von Google am 22. Mai 2018 aktualisiert wurde, wodurch sie relevanter ist als die Codekonvention von Oracle, insbesondere wenn es um die Beschreibung relativ neuer Funktionen von Java geht, die erst als Teil von Java 8 veröffentlicht wurden im Jahr 2014, wie Lambdas und Streams. So beschreiben die Autoren des Java Style Guide von Google den Inhalt dieser Codierungskonvention: „Dieses Dokument dient als vollständige Definition der Codierungsstandards von Google für Quellcode in Java. Wie bei anderen Programmier-Styleguides umfassen die behandelten Themen nicht nur ästhetische Fragen der Formatierung, aber auch andere Arten von Konventionen oder Codierungsstandards. Dieses Dokument konzentriert sich jedoch in erster Linie auf die festen Regeln, die wir allgemein befolgen, und vermeidet Ratschläge, die nicht eindeutig durchsetzbar sind (sei es durch Menschen oder Werkzeuge).“ „Der Google Java Style Guide ist größtenteils eine gute Referenz, aber bei manchen Themen ist er etwas freizügig. Andererseits muss man als Java-Programmierer unter anderem an vier Leerzeichen für die Codeeinrückung gewöhnt sein“, sagte David Rios, ein Softwarearchitekt und erfahrener Java-Programmierer, in einem LinkedIn aber bei manchen Themen ist es etwas freizügig. Andererseits muss man als Java-Programmierer unter anderem an vier Leerzeichen für die Codeeinrückung gewöhnt sein“, sagte David Rios, ein Softwarearchitekt und erfahrener Java-Programmierer, in einem LinkedIn aber bei manchen Themen ist es etwas freizügig. Andererseits muss man als Java-Programmierer unter anderem an vier Leerzeichen für die Codeeinrückung gewöhnt sein“, sagte David Rios, ein Softwarearchitekt und erfahrener Java-Programmierer, in einem LinkedInBeitrag mit einigen vorgeschlagenen Anpassungen des eigenen Google Java Style Guide.

Am häufigsten verwendete Java-Codierungsstandards

Hier sind einige der am häufigsten verwendeten Java-Codierungsstandards, die in den oben genannten Codierungskonventionen von Oracle und Google sowie anderen Dokumenten dieser Art zu finden sind.

• Befolgen Sie die richtige Namenskonvention;
• Füge Kommentare hinzu;
• Bezeichner bezeichnet einen symbolischen Namen, der sich auf den Namen von Klassen, Paketen, Methoden und Variablen in einem Java-Programm bezieht;
• Der Variablenname sollte sich auf seinen Zweck beziehen;
• Der Name der Methode sollte sich auf die Funktionalität der Methode beziehen;
• Die Methode sollte nicht mehr als 50 Zeilen enthalten;
• Es sollte keinen doppelten Code in derselben Klasse oder einer anderen Klasse geben.
• Deklarieren Sie globale Variablen nur, wenn dies für die Verwendung in anderen Methoden erforderlich ist.
• Überprüfen Sie die Erstellung statischer Variablen innerhalb einer Klasse noch einmal.
• Vermeiden Sie den direkten Zugriff auf Variablen aus anderen Klassen, sondern verwenden Sie stattdessen Getter- und Setter-Methoden.
• Die gesamte Geschäftslogik sollte nur in der Serviceklasse verarbeitet werden.
• Der gesamte DB-bezogene Code sollte nur in den DAO-Klassen enthalten sein;
• Verwenden Sie Getter und Setter.
• Instanzvariable als privat deklarieren;
• Halten Sie den Umfang der Variablen minimal;
• Weisen Sie Variablen aussagekräftige Namen zu;
• Vermeiden Sie Speicherlecks, indem Sie Datenbankverbindungen freigeben, wenn die Abfrage abgeschlossen ist.
• Versuchen Sie, den Block „Endlich“ so oft wie möglich zu verwenden.
• Verwenden Sie das Executor-Framework für die Multithread-Programmierung.