Die 7 Wege zum Clean Code

Transkript

1 Die 7 Wege zum Clean Code

2 Über mich Claudio Altamura Softwareentwickler Certified ScrumMaster Interessen Agile Softwareentwicklung Softwarearchitekturen Java 2

3 Inhalt 1. Statische Codeanalyse 2. Testdriven Development 3. Refactoring 4. Continuous Integration 5. Reviews 6. Coding Standards 7. Coding Dojos 3

4 Statische Codeanalyse Automatische Erkennung von Fehlern Sicherstellung von Coding-Standards Prüfung zum Softwaredesign Einhaltung diverser Metriken Namen, Größen, Anzahl weitere Verifikationen 4

5 Statische Codeanalyse Welche Tools gibt es? Checkstyle, Findbugs, PMD, etc. mvn checkstyle:checkstyle mvn findbugs:findbugs Was messen? Anzahl Zeilen, Methoden und Klassen Duplicate Code Abhängigkeiten, Komplexität Anzahl von Tests, Anzahl fehlgeschlagener Tests 5

6 SONARQUBE Statische Codeanalyse 6

7 Vorteile Testdriven Development Senkt die Entwicklungskosten Produktivere Programmierer Einfache Validierung Positive Auswirkungen auf das Design Vorgehen 7

8 Best Practices Testdriven Development Zuerst die Tests schreiben "Keep it simple stupid" (KISS) "You aren't gonna need it" (YAGNI). Keep the unit small Der Testcode ist genau so wichtig Nicht auf Zustände vorhergelaufenen Tests bauen 8

9 Vorsicht! Testdriven Development Nicht für alle Bereiche geeignet: z.b. Oberflächen Unterstützung durch Management wichtig Schlecht geschriebene Tests Betriebsblindheit bei Unit Tests 9

10 Refactoring By continuously improving the design of code, we make it easier and easier to work with.... If you get into the hygienic habit of refactoring continuously, you'll find that it is easier to extend and maintain code. Joshua Kerievsky, Refactoring to Patterns Vorteile Erhöhung der Lesbarkeit und Verständlichkeit Verbesserung der Wartbarkeit und Erweiterbarkeit Senkung von Kosten für Erweiterungen 10

11 Mögliche Refactorings Refactoring Abstraktion Code in mehr logische Einheiten unterteilen Name und Ort von Code 11

12 Risiken Refactoring Risiko ungewünschter Änderungen und Fehler große Änderungen erschweren die Ursachenanalyse Unit-Tests senken lediglich die Risiken 12

13 Continuous Integration Praktiken Automatisierte Übersetzung Kontinuierliche Test-Entwicklung Häufige Integration Kurze Testzyklen Gespiegelte Produktionsumgebung Einfacher Zugriff Automatisiertes Reporting Automatisierte Verteilung 13

14 Vorteile Continuous Integration Integrations-Probleme werden laufend gefixt frühe Warnungen, Feedback-Zyklus Unit-Tests entdecken Fehler zeitnah ständige Verfügbarkeit eines lauffähigen Standes 14

15 Continuous Integration 15

16 Reviews Reviewarten Informelles Review Walkthrough Inspektion Lightweight Reviews Over the Shoulder Pair Programming 16

17 Vorteile Reviews Kostengünstige Behebung von Fehlern Identifizierung von Verbesserungsmöglichkeiten Wissentransfer Erfolgsfaktoren Konstruktive Kritik üben Kultur von Lernen und Prozessverbesserung Taktgefühl des Reviewers 17

18 Reviews Gerrit 18

19 Coding Standards Why Have Code Conventions? Code conventions are important to programmers for a number of reasons: 80% of the lifetime cost of a piece of software goes to maintenance. Hardly any software is maintained for its whole life by the original author. Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly. Code Conventions for the Java Language Was sind Coding Standards? [email protected] 19

20 Coding Standards Beispiele für Coding Standards Naming Conventions, Anweisungen, White Space Deklarationen, Kommentare, Einrückung Dateiorganisation, Praktiken, Prinzipien und Regeln Vorteile Erleichterung der Arbeit Steigerung der Lesbarkeit, Verständlichkeit und Wartbarkeit Elimierung von vermeidbaren Fehlerquellen

21 Coding Standards Prozess Basis Language Coding Conventions Festlegung in einem Dokument Schrittweise Justierung der Regeln, z.b. Tools für die statische Codeanalyse Codeformatter 21

22 Coding Dojos Dojo = Trainingsraum Kata = vorgegebener Bewegungsablauf Code Kata = vorgegebene Programmieraufgabe viele Male hintereinander ausgeführt es geht nicht um die Lösung, sondern um den Weg Muster sollen in Fleisch und Blut übergehen Ziel: besserer Entwickler zu werden [email protected] 22

23 Ablauf Coding Dojos zwei Entwickler im Team an einem Rechner restliche Teilnehmer schauen auf den Beamer nach einer Zeitspanne Wechsel eines Entwickler bis nichts mehr zu verbessern ist am Ende Retrospektive 23

24 Coding Dojos Für was eignen sich Coding Katas? TDD zu lernen Neue Sprache oder Sprachfeatures zu lernen besser zu programmieren 24

25 Fragen & Antworten

26 Links Statische Codeanalyse SonarSource ( Continuous Integration Martin Fowler CI ( TDD Introduction to TDD ( Refactoring Refactoring to Patterns Catalog ( Reviews Best Kept Secrets ( Coding Standards Code Conventions for the Java Programming Language ( Coding Dojos CodersDojo ( 26

27 Vielen Dank für eure Aufmerksamkeit.