Hallo zusammen, JavaRush-Community! Heute sprechen wir über Codequalität. Ja, ja, liebe Freunde. Niemand ist vollkommen. Irgendwann wird jedem klar, dass der Code besser sein könnte ... Aber was tun in dieser Situation? Beginnen Sie zumindest damit, dieses Problem zu untersuchen. Da Sie hier sind, bedeutet das, dass das Thema für Sie interessant ist, also los geht's. Heute beschreiben wir Möglichkeiten, wie Sie Ihren Code besser und sauberer machen können. Damit Sie sich in Zukunft nicht für Ihren aktuellen Code schämen müssen!..)) All diese Methoden helfen dem Programmierer, ein guter Programmierer zu werden.
1. Wenn Sie Ihren Code verbessern möchten, lesen Sie den Code einer anderen Person
Wenn Sie Ihre Programmierkenntnisse erheblich verbessern möchten, müssen Sie ... Code lesen, der von anderen Programmierern geschrieben wurde. Man kann daran glauben, man kann es nicht glauben. Aber wenn Sie das Risiko eingehen, verspreche ich Ihnen, dass Ihre Zeit belohnt wird. Lesen Sie beispielsweise nicht auf Habré, wie HashMap, ArrayList, LinkedList usw. funktionieren, sondern lesen Sie deren Code und finden Sie es selbst heraus. Hier ist eine Liste der zu lesenden Klassen:
HashMap ist die am häufigsten gestellte Frage in Interviews. Sie können mehrere Fliegen mit einer Klappe schlagen: Verstehen Sie den Code und erwerben Sie das nötige Wissen.
Bei ArrayList handelt es sich um den gleichen Fall wie bei HashMap. Es gibt dort keine komplizierten Dinge, aber es lohnt sich wirklich, es zu lesen und zu verstehen.
String ist ein gutes Beispiel. Verstehen Sie, warum es unveränderlich ist.
AtomicInteger ist eine coole Klasse: Sie beschreibt den Prozess, wie Operationen an Integer-Objekten atomar ausgeführt werden.
Und dann - zumindest alle Klassen hintereinander...)
Wenn wir über etwas Ernsthafteres sprechen, lohnt es sich natürlich, den Code von Pivotal zu lesen. Diese Jungs haben das gefragteste Ökosystem in der Java-Welt geschrieben. Ihr Code ist auf jeden Fall lesenswert. Daher rate ich Ihnen, mit Spring Core zu beginnen . Das Lesen unbekannten Quellcodes ist eine herausfordernde, aber sehr lohnende Arbeit.)
2. Befolgen Sie Codekonventionen – Konventionen zum Schreiben von Code
Codierungskonventionen sind eine Reihe von Richtlinien, die von Entwicklungsteams entwickelt wurden und Richtlinien für Programmierstil und -techniken für jeden Aspekt des Codes enthalten, der innerhalb eines Unternehmens oder eines bestimmten Projekts geschrieben wird. Diese Konventionen sind in der Regel spezifisch für jede Programmiersprache und umfassen Dateiorganisation, Einrückung, Kommentare, Deklarationen, Operatoren, Leerzeichen, Namenskonventionen, Programmiertechniken und -prinzipien, Programmierregeln, bewährte Methoden für die Architektur usw. Der Hauptvorteil bestimmter Standards besteht darin Der Code sieht gleich aus und ist im gleichen Stil geschrieben. Dies macht es besser lesbar und hilft Programmierern, den von einem anderen Programmierer geschriebenen Code zu verstehen. Wenn Codierungsstandards während des gesamten Entwicklungsprozesses eingehalten und konsequent angewendet werden, wird es in Zukunft einfacher sein, den Code zu pflegen und zu erweitern, ihn umzugestalten und Integrationskonflikte zu lösen. Codierungskonventionen sind für Programmierer aus mehreren Gründen wichtig:
40–80 % der Softwarekosten werden für deren Wartung aufgewendet;
Der Autor pflegt zeitlebens kaum Software;
Codekonventionen verbessern die Lesbarkeit von Software und ermöglichen es Programmierern, neuen Code schneller zu verstehen.
Ehrlich gesagt bin ich ein großer Fan von Codierungsstandards. Für mich ist es sinnvoll, Zeit damit zu verbringen, darüber zu diskutieren und zu streiten, da es eine wertvolle Aktivität ist, die Ihnen in Zukunft Zeit und Mühe sparen wird. Kodexkonventionen sollten regelmäßig überprüft werden. Regeln können von „obligatorisch“ in „optional“ übersetzt werden und umgekehrt. Wenn einige davon nicht richtig funktionieren, müssen sie neu gestaltet oder aus den Richtlinien entfernt werden.
3. Verwenden Sie Code Review – Codeüberprüfung durch andere
Die Codeüberprüfung ist eines der leistungsstärksten Tools zur Verbesserung von Code. Warum? Denn der Code wird von den Spezialisten geprüft, die ihn nicht geschrieben haben. Und ein frischer Look ist sehr nützlich. Und oft ist es die Codeüberprüfung, die dabei hilft, das Schreiben von ehrlich gesagt schrecklichem Code zu verhindern. Ich weiß, dass dies nicht immer möglich ist, da Sie eine andere Person finden müssen, die dies tun möchte. Dies bedeutet jedoch nicht, dass sich die Verwendung dieses Tools nicht lohnt. Ganz im Gegenteil: Das ist ein Grund, Gleichgesinnte zu finden, denen es ebenfalls wichtig ist, die Qualität des Codes zu verbessern. Übrigens, wer verbietet Ihnen, sie hier auf JavaRush zu finden? An einem Ort, an dem jeder Programmierer werden möchte.
4. Schreiben Sie Unit-Tests – Unit-Tests
Meine mit Abstand liebste Methode zur Codeverbesserung ist das Schreiben von Unit-Tests. Darüber hinaus gilt: Je mehr Sie sie schreiben, desto besser. In der Computerprogrammierung ist Unit-Test ein Softwareentwicklungsprozess, bei dem der kleinste testbare Teil des Quellcodes, eine sogenannte Einheit, einzeln und unabhängig getestet wird, um zu überprüfen, ob er wie erwartet funktioniert. Dies wird Ihnen helfen, Fehler in Algorithmen und/oder Logik zu erkennen, bevor Sie den Code veröffentlichen. Da Unit-Tests die entsprechende Struktur Ihres Codes erfordern, bedeutet dies, dass der Code in kleinere und fokussiertere Funktionen unterteilt werden muss. Jeder von ihnen ist für eine einzelne Operation an einem Datensatz verantwortlich, und nicht für große Funktionen, die eine Reihe unterschiedlicher Operationen ausführen. (Wie man so schön sagt: Hallo vom Single-Responsibility-Prinzip ...) Der zweite Vorteil des Schreibens von gut getestetem Code besteht darin, dass Sie zukünftige Fehler bei kleinen Änderungen an vorhandenen Funktionen zum Brechen von Code verhindern können. Wenn ein Fehler auftritt, werden Ihnen die Unit-Tests mitteilen, dass etwas falsch geschrieben wurde. Auf den ersten Blick scheint es ein zusätzlicher Aufwand zu sein, während der Entwicklung Zeit für das Schreiben von Unit-Tests aufzuwenden. Dies wird jedoch in Zukunft Zeit sparen, die für das Debuggen aufgewendet werden muss. Dies sollte ein schrittweiser Prozess sein. Machen Sie also weiter und schreiben Sie Tests für alle Methoden und Klassen :D
5. Verwenden Sie Tools, um die Codequalität zu verbessern
Es gibt keinen Entwickler, der niemals Fehler macht. Typischerweise erkennt der Compiler Syntax- und Rechenprobleme und gibt einen Stack-Trace aus. Es kann jedoch immer noch einige Probleme geben, die der Compiler nicht erkennt. Zum Beispiel falsch implementierte Anforderungen, falsche Algorithmen, falsche Codestruktur oder einige potenzielle Probleme, die der Community aus Erfahrung bekannt sind. Die einzige Möglichkeit, solche Fehler zu erkennen, besteht darin, einen erfahrenen Entwickler zu bitten, Ihren Code zu überprüfen. Dieser Ansatz ist kein Allheilmittel und ändert wenig. Mit jedem neuen Entwickler im Team sollten Sie ein zusätzliches Augenpaar haben, das sich seinen Code ansieht. Aber glücklicherweise gibt es viele Tools, die Ihnen helfen können, die Qualität Ihres Codes zu kontrollieren. Ich habe Checkstyle, PMD, FindBugs und SonarQube bei meiner Arbeit an verschiedenen Projekten verwendet. Es gibt auch andere. Sie alle werden üblicherweise für Qualitätsanalysen und die Erstellung einiger nützlicher Berichte verwendet. Sehr oft werden diese Berichte von Continuous-Integration-Servern wie Jenkins veröffentlicht.
6. Schreiben Sie einfachen und klaren Code
Schreiben Sie immer einfachen, klaren und logischen Code. Menschen neigen dazu, komplexen Code zu schreiben, um zu beweisen, dass sie dazu in der Lage sind. Einfacher, aber logischer Code funktioniert immer gut, verursacht weniger Probleme und ist besser erweiterbar. Guter Code bedeutet bessere Dokumentation. Wenn Sie darüber nachdenken, einen Kommentar hinzuzufügen, fragen Sie sich: „ Wie kann ich den Code verbessern, sodass dieser Kommentar nicht benötigt wird?“ " ~Steve McConnell.
7. Lesen Sie die Dokumentation
Eine der wichtigen Gewohnheiten guter Programmierer ist es, viel Dokumentation zu lesen. Seien es Spezifikationen, JSR, API-Dokumente, Tutorials usw. Das Lesen von Dokumenten hilft Ihnen dabei, die solide Grundlage aufzubauen, auf der Sie am besten programmieren. Vergleichen Sie sich nicht mit anderen. Sich mit anderen zu vergleichen, führt nur zu negativen Gefühlen und ungesundem Wettbewerb. Jeder hat seine eigenen Stärken und Schwächen. Daher ist es wichtig, sie zu kennen und mit ihnen zu arbeiten. Analysieren Sie sich selbst, listen Sie Ihre Stärken auf und arbeiten Sie daran. Programmieren macht richtig Spaß: Genießen Sie es.
„Die Konstante des einen ist die Variable des anderen.“
8. Folgen Sie interessanten Bloggern
Es gibt Tausende von Enthusiasten auf der ganzen Welt, die an denselben Technologien arbeiten und darüber schreiben. Blogs werden oft von Programmierern selbst geschrieben und die meisten von ihnen teilen persönliche Meinungen und Erfahrungen. Auf Blogs können Sie unterschiedliche Perspektiven derselben Technologie sehen. Auf Blogs kann man sowohl gute als auch schlechte Technologie sehen. Lesen Sie zumindest Artikel über Habré JavaRush :D, einschließlich meiner. Folgen Sie guten Blogs und kommentieren Sie Beiträge, teilen Sie Ihre Meinung.
9. Lesen Sie Fachbücher
Nichts kann ein gutes Buch ersetzen. Ein gutes Buch vermittelt grundlegende Konzepte auf viel einfachere Weise und lässt sich auf Objekte der realen Welt anwenden. Ihre Autoren sind selbst großartige Programmierer. Durch das Lesen von Büchern können Sie aus den Erfahrungen anderer lernen. Ich schlage vor, „Java. Effektive Programmierung von Joshua Bloch. Dieses Buch stellt 78 unersetzliche Faustregeln für Programmierer vor: funktionierende, beste Lösungen für die Programmierprobleme, mit denen Sie jeden Tag konfrontiert sind. Es enthält die praktischsten und maßgeblichsten Richtlinien, die Sie zum Schreiben effektiver, gut gestalteter Programme verwenden können. Wenn Sie gerade erst mit Java anfangen und keine Programmiererfahrung haben, sollten Sie Sams Teach Yourself Java 2 in 24 Hours lesen. Und zum Schreiben von sauberem Code gibt es ein hervorragendes Buch „Clean Code von Robert Martin“. Danach entsteht ein „Gefühl der Schönheit“ in Bezug auf den Code.
10. Code! Code! Code!
Sie können kein guter Programmierer werden, indem Sie einfach ein Buch auswendig lernen. Es ist einfach, über theoretische Konzepte zu sprechen. Sie können jedoch nur beim Schreiben von Code Sprachbeschränkungen erlernen oder Best Practices entwickeln. Um ein guter Programmierer zu werden, müssen Sie daher viel Code schreiben. Wenn Sie ein Anfänger sind, schreiben Sie zunächst Programme für einfache Probleme wie Fibonacci-Reihen, Palindrome, Pascals Dreieck usw. und gehen Sie dann zu größeren Problemen wie binärem Suchbaum usw. über. Wenn Sie nach einer Online-Plattform zum Üben von Java-Programmen suchen, Schauen Sie sich Coding Ground an . Darüber hinaus können Sie den CS50- Kurs belegen , dessen Übersetzung uns von „you know who“ zur Verfügung gestellt wurde :D
Fassen wir es zusammen
Wer nichts tut, macht keine Fehler. Deshalb müssen wir geduldig sein und wie ein fleißiger Japaner unsere Programmierfähigkeiten verbessern. Vergessen Sie dabei nicht:
den Code einer anderen Person lesen;
Führen Sie eine Codeüberprüfung durch und fordern Sie diese an.
Unit-Tests schreiben;
Verwenden Sie Tools, um den Code zu verbessern.
einfachen und verständlichen Code schreiben;
Lesen Sie die Dokumentation derjenigen, die dazu in der Lage waren;
Codierungskonventionen sind eine Reihe von Richtlinien, die von Entwicklungsteams entwickelt wurden und Richtlinien für Programmierstil und -techniken für jeden Aspekt des Codes enthalten, der innerhalb eines Unternehmens oder eines bestimmten Projekts geschrieben wird. Diese Konventionen sind in der Regel spezifisch für jede Programmiersprache und umfassen Dateiorganisation, Einrückung, Kommentare, Deklarationen, Operatoren, Leerzeichen, Namenskonventionen, Programmiertechniken und -prinzipien, Programmierregeln, bewährte Methoden für die Architektur usw. Der Hauptvorteil bestimmter Standards besteht darin Der Code sieht gleich aus und ist im gleichen Stil geschrieben. Dies macht es besser lesbar und hilft Programmierern, den von einem anderen Programmierer geschriebenen Code zu verstehen. Wenn Codierungsstandards während des gesamten Entwicklungsprozesses eingehalten und konsequent angewendet werden, wird es in Zukunft einfacher sein, den Code zu pflegen und zu erweitern, ihn umzugestalten und Integrationskonflikte zu lösen. Codierungskonventionen sind für Programmierer aus mehreren Gründen wichtig:
Warum? Denn der Code wird von den Spezialisten geprüft, die ihn nicht geschrieben haben. Und ein frischer Look ist sehr nützlich. Und oft ist es die Codeüberprüfung, die dabei hilft, das Schreiben von ehrlich gesagt schrecklichem Code zu verhindern. Ich weiß, dass dies nicht immer möglich ist, da Sie eine andere Person finden müssen, die dies tun möchte. Dies bedeutet jedoch nicht, dass sich die Verwendung dieses Tools nicht lohnt. Ganz im Gegenteil: Das ist ein Grund, Gleichgesinnte zu finden, denen es ebenfalls wichtig ist, die Qualität des Codes zu verbessern. Übrigens, wer verbietet Ihnen, sie hier auf JavaRush zu finden? An einem Ort, an dem jeder Programmierer werden möchte.
Meine mit Abstand liebste Methode zur Codeverbesserung ist das Schreiben von Unit-Tests. Darüber hinaus gilt: Je mehr Sie sie schreiben, desto besser. In der Computerprogrammierung ist Unit-Test ein Softwareentwicklungsprozess, bei dem der kleinste testbare Teil des Quellcodes, eine sogenannte Einheit, einzeln und unabhängig getestet wird, um zu überprüfen, ob er wie erwartet funktioniert. Dies wird Ihnen helfen, Fehler in Algorithmen und/oder Logik zu erkennen, bevor Sie den Code veröffentlichen. Da Unit-Tests die entsprechende Struktur Ihres Codes erfordern, bedeutet dies, dass der Code in kleinere und fokussiertere Funktionen unterteilt werden muss. Jeder von ihnen ist für eine einzelne Operation an einem Datensatz verantwortlich, und nicht für große Funktionen, die eine Reihe unterschiedlicher Operationen ausführen. (Wie man so schön sagt: Hallo vom Single-Responsibility-Prinzip ...) Der zweite Vorteil des Schreibens von gut getestetem Code besteht darin, dass Sie zukünftige Fehler bei kleinen Änderungen an vorhandenen Funktionen zum Brechen von Code verhindern können. Wenn ein Fehler auftritt, werden Ihnen die Unit-Tests mitteilen, dass etwas falsch geschrieben wurde. Auf den ersten Blick scheint es ein zusätzlicher Aufwand zu sein, während der Entwicklung Zeit für das Schreiben von Unit-Tests aufzuwenden. Dies wird jedoch in Zukunft Zeit sparen, die für das Debuggen aufgewendet werden muss. Dies sollte ein schrittweiser Prozess sein. Machen Sie also weiter und schreiben Sie Tests für alle Methoden und Klassen :D
Es gibt keinen Entwickler, der niemals Fehler macht. Typischerweise erkennt der Compiler Syntax- und Rechenprobleme und gibt einen Stack-Trace aus. Es kann jedoch immer noch einige Probleme geben, die der Compiler nicht erkennt. Zum Beispiel falsch implementierte Anforderungen, falsche Algorithmen, falsche Codestruktur oder einige potenzielle Probleme, die der Community aus Erfahrung bekannt sind. Die einzige Möglichkeit, solche Fehler zu erkennen, besteht darin, einen erfahrenen Entwickler zu bitten, Ihren Code zu überprüfen. Dieser Ansatz ist kein Allheilmittel und ändert wenig. Mit jedem neuen Entwickler im Team sollten Sie ein zusätzliches Augenpaar haben, das sich seinen Code ansieht. Aber glücklicherweise gibt es viele Tools, die Ihnen helfen können, die Qualität Ihres Codes zu kontrollieren. Ich habe Checkstyle, PMD, FindBugs und SonarQube bei meiner Arbeit an verschiedenen Projekten verwendet. Es gibt auch andere. Sie alle werden üblicherweise für Qualitätsanalysen und die Erstellung einiger nützlicher Berichte verwendet. Sehr oft werden diese Berichte von Continuous-Integration-Servern wie Jenkins veröffentlicht.
Schreiben Sie immer einfachen, klaren und logischen Code. Menschen neigen dazu, komplexen Code zu schreiben, um zu beweisen, dass sie dazu in der Lage sind. Einfacher, aber logischer Code funktioniert immer gut, verursacht weniger Probleme und ist besser erweiterbar. Guter Code bedeutet bessere Dokumentation. Wenn Sie darüber nachdenken, einen Kommentar hinzuzufügen, fragen Sie sich: „ Wie kann ich den Code verbessern, sodass dieser Kommentar nicht benötigt wird?“ " ~Steve McConnell.
Eine der wichtigen Gewohnheiten guter Programmierer ist es, viel Dokumentation zu lesen. Seien es Spezifikationen, JSR, API-Dokumente, Tutorials usw. Das Lesen von Dokumenten hilft Ihnen dabei, die solide Grundlage aufzubauen, auf der Sie am besten programmieren. Vergleichen Sie sich nicht mit anderen. Sich mit anderen zu vergleichen, führt nur zu negativen Gefühlen und ungesundem Wettbewerb. Jeder hat seine eigenen Stärken und Schwächen. Daher ist es wichtig, sie zu kennen und mit ihnen zu arbeiten. Analysieren Sie sich selbst, listen Sie Ihre Stärken auf und arbeiten Sie daran. Programmieren macht richtig Spaß: Genießen Sie es.
Es gibt Tausende von Enthusiasten auf der ganzen Welt, die an denselben Technologien arbeiten und darüber schreiben. Blogs werden oft von Programmierern selbst geschrieben und die meisten von ihnen teilen persönliche Meinungen und Erfahrungen. Auf Blogs können Sie unterschiedliche Perspektiven derselben Technologie sehen. Auf Blogs kann man sowohl gute als auch schlechte Technologie sehen. Lesen Sie zumindest Artikel über 
Nichts kann ein gutes Buch ersetzen. Ein gutes Buch vermittelt grundlegende Konzepte auf viel einfachere Weise und lässt sich auf Objekte der realen Welt anwenden. Ihre Autoren sind selbst großartige Programmierer. Durch das Lesen von Büchern können Sie aus den Erfahrungen anderer lernen. Ich schlage vor, „Java. Effektive Programmierung von Joshua Bloch. Dieses Buch stellt 78 unersetzliche Faustregeln für Programmierer vor: funktionierende, beste Lösungen für die Programmierprobleme, mit denen Sie jeden Tag konfrontiert sind. Es enthält die praktischsten und maßgeblichsten Richtlinien, die Sie zum Schreiben effektiver, gut gestalteter Programme verwenden können. Wenn Sie gerade erst mit Java anfangen und keine Programmiererfahrung haben, sollten Sie Sams Teach Yourself Java 2 in 24 Hours lesen. Und zum Schreiben von sauberem Code gibt es ein hervorragendes Buch „Clean Code von Robert Martin“. Danach entsteht ein „Gefühl der Schönheit“ in Bezug auf den Code.
Es ist einfach, über theoretische Konzepte zu sprechen. Sie können jedoch nur beim Schreiben von Code Sprachbeschränkungen erlernen oder Best Practices entwickeln. Um ein guter Programmierer zu werden, müssen Sie daher viel Code schreiben. Wenn Sie ein Anfänger sind, schreiben Sie zunächst Programme für einfache Probleme wie Fibonacci-Reihen, Palindrome, Pascals Dreieck usw. und gehen Sie dann zu größeren Problemen wie binärem Suchbaum usw. über. Wenn Sie nach einer Online-Plattform zum Üben von Java-Programmen suchen, Schauen Sie sich Coding Ground an . Darüber hinaus können Sie den CS50- Kurs belegen , dessen Übersetzung uns von „you know who“ zur Verfügung gestellt wurde :D
GO TO FULL VERSION