iks auf der gearconf 2012: Clean Code - Von der Lehre in den Alltag
3 gefällt mir8,896 aufrufe
Der Vortrag von Jörg Vollmer und Reik Oberrath behandelt die Problematik von 'dirty code' in der Softwareentwicklung und dessen Ursachen wie unvollständige Umsetzung, mangelnde Motivation und unlogische Realisierung. Er stellt die 'Clean Code'-Bewegung vor, die durch Prinzipien und Praktiken anstrebt, qualitativ hochwertigen, wartbaren und verständlichen Code zu fördern. Zudem wird ein Teamansatz zur Implementierung dieser Praktiken skizziert, um die Zusammenarbeit und Entscheidungsfindung zu verbessern.
iks auf der gearconf 2012: Clean Code - Von der Lehre in den Alltag
- 1. Von der Lehre in den Alltag von Jörg Vollmer und Reik Oberrath 26.06.2012
- 4. Der Code
- 5. Wofür steht ? & Software- Effektive qualität Softwareentwicklung
- 6. Agenda Einleitung Ursachen von Dirty Code Die Clean Code Developer Bewegung Das Team Clean Coding Meinungen zu Clean Code und zum Team Clean Coding
- 8. Häufige Unsitten Kommunikations- Konformitäts- Schlechte probleme brüche Infrastruktur Magie im Workarounds Code Code- anstatt Verdopplungen Behebung Unglückliche Fehlende Namensgebung Tests Unzureichendes Frühzeitiges Logging Toter Fertigmelden Code Keine Kommentare Verweiste Schlechte TODOs Fehlerbehandlung (Zu) komplizierte Implementierung Fehlende Konsistenzprüfungen Unvollständige Spaghetti- Refactorings Code
- 10. Unvollständige Umsetzung Projektleiter: „Wie sieht‘s aus? Kann man denn schon etwas zeigen?“ Entwickler: „Ja, aber erst mal nur ein Schnellschuss, das kann nicht so bleiben…“ Kunde & Projektleiter: „…sieht doch gut aus! Mehr brauchen wir doch gar nicht!“ Welcher Entwickler hat da den Mut, sich durchzusetzen?
- 11. Unvollständige Umsetzung Projektleiter A: „Stell‘ mir mal deinen aktuellen Stand zur Verfügung, Projektleiter B braucht den, damit sein Team weiter- arbeiten kann!“ Stimmt nicht (mehr), denn es gibt Mocks! Interface Segregation Principle (ISP) Dependency Inversion Principle (DIP) Inversion of Control Container (ICC) Test First (TF)
- 12. Unvollständige Umsetzung „Lass gut sein, das ziehen wir später gerade. Hauptsache, es läuft!“ Die Erfahrung zeigt: Nachträgliches Refactoring funktioniert nur sehr selten, weil …es zu mühsam ist (erneutes Hineindenken) …das Risiko ist groß ist, Fehler einzubauen …größere Maßnahmen zeitlich kaum abschätzbar sind …es (deswegen) Widerstand bei der Projektleitung gibt
- 13. Unvollständige Umsetzung Entwickler: „Fertig, es läuft!“ Projektleiter: „Prima, dann können wir endlich liefern!“
- 14. Ein Fall läuft Die guten Fälle laufen Definition of Done Fehlerfälle wurden untersucht „Alle“ Fehlerfälle wurden berücksichtigt Unit-Tests Integrationstests Systemtests Metriken (statistische Code-Analysen) Verständlichkeit (menschliche Code-Analyse)
- 16. Mangelnde Motivation: Broken Window Entwickler: „Ich hab damit nichts zu tun, das ist nicht von mir!“ „Darauf kommt es jetzt auch nicht mehr an!“ „Warum soll ich anfangen, hier sauber zu implementieren?“
- 17. Mangelnde Motivation: Die x-te Änderung Entwickler: „Das war so gar nicht spezifiziert!“ „Wie oft muss ich da noch ran?“
- 19. Unlogische Realisierung: Die Gasfabrik Entwickler: „Das muss auch noch rein, denn so wird das richtig gut!“
- 20. Unlogische Realisierung: Konformitätsbrüche „Ich mach das aber anders als die anderen!“ „Was interessiert mich, was die anderen gemacht haben?“
- 21. Grund 4: Schlechte Rahmenbedingungen
- 22. Schlechte Rahmenbedingungen: Menschliche Defizite Fortbildungsdefizite Mangelndes Interesse Kommunikationsprobleme Sender-Empfänger-Probleme Schlechtes Team-Klima Motivationsprobleme Kein Bewertungssystem für Lob und Tadel
- 23. Schlechte Rahmenbedingungen: Organisatorische Defizite Unzureichende Weiterbildungsmöglichkeiten Unklare Rollen, Unklare Prozesse, Unklare Richtlinien …
- 24. Grund 5: Termine
- 25. Termine Dilemma: - Termine wird es immer geben, - Anzahl von Issues/Tickets direkt messbar, Qualität aber nicht. - Entwickler sind gehemmt, die Wahrheit zu sagen.
- 26. Ursachen für Dirty Code Unvollständige Umsetzung Mangelnde Motivation Unlogische Realisierung Schlechte Rahmenbedingungen Termine Moment mal !!! Sind wir etwa faul, feige und unfähig??? Nein! Aber wir können besser werden!
- 27. Agenda Einleitung Ursachen von Dirty Code Die Clean Code Developer Bewegung Das Team Clean Coding Meinungen zu Clean-Code
- 28. Was heißt clean? Def. 1: Clean ist alles, was intuitiv verständlich ist, also (Quellcode-) Dokumente, Datenstrukturen, Konzepte, Regeln, Verfahren.... Def. 2: Intuitiv verständlich ist, was mit wenig Spezialwissen in kurzer Zeit richtig verstanden wird. Def. 3: Clean ist alles, was effizient ist, also Verfahren, die die Softwareentwicklung beschleunigen.
- 30. Kernaussagen der Clean-Code-Developer-Bewegung Disziplin Ständige Selbstkontrolle („Bewusstsein“) durch („Professionalität“) konsequente Anwendung des inneren Wertesystems („Prinzipien“) Wertesystem Das Buch „Clean Code“ ist wert, als allgemeingültiges Wertesystem anerkannt zu werden. Programmieralltag Das CCD-Grade-System hilft, das innere Wertesystem aktiv einzusetzen und die mentale CCD-Einstellung zu verinnerlichen. www.clean-code-developer.de
- 31. Die Clean Code Grade: Schwarz Schwarz Rot Orange Gelb Grün Blau Weiss Don´t Repeat Single Level of Interface Open Closed Entwurf und Yourself (DRY), Abstraction Segregation Principle Implementation Keep it simple, (SLA) Principle Tell, don´t ask überlappen nicht stupid (KISS) Single Dependency Law of Demeter Implementa- Responsibility Inversion Principle tion spiegelt Prinzipien Vorsicht vor Optimierungen Principle (SRP) Liskov Entwurf Separation of Substitution You Ain´t (VvO) Principle Favour Concerns (SoC) Gonna Need It Principle of (YAGNI) Composition over Source Code Least Inheritance (FCoI) Konventionen Astonishment Information Hiding Principle Die Pfadfinderregel Issue Tracking Automatisierte Continuous Continuous beachten Automatisierte Unit Tests Integration I Integration II Root Cause Integrationstests Mockups Statische Iterative Praktiken Analysis Lesen, Lesen, (Testattrappen) Codeanalyse Entwicklung Ein Versionskon- Lesen (LLL) Code Coverage (Metriken) Komponenten- trollsystem einsetzen Reviews Analyse Inversion of orientierung Einfache Refakto- Teilnahme an Control Container Test first risierungsmuster an- Fachveranstal- Erfahrung wenden (ER) tungen weitergeben Täglich reflektieren Komplexe Re- Messen von faktorisierungen Fehlern
- 32. Was heißt Clean Code noch? Def. 4: Clean Code ist ein Buch mit einem umfassenden Regelwerk, das als Sprachen über- greifendes Wertesystem (Best Practices) gelten kann. Def. 5: Clean Code ist die mentale Einstellung, das gemeinsame Wertesystem im Programmier- alltag bewusst anzuwenden (der „Geist“ der Clean-Code-Developer-Bewegung).
- 33. Was bewirkt Clean Code? Code Entwicklung Leicht verständlich flexibel Einfach änderbar wartbar Gut testbar effektiv
- 34. Agenda Einleitung Ursachen von Dirty Code Die Clean Code Developer Bewegung Das Team Clean Coding Meinungen zu Clean Code und zum Team Clean Coding
- 36. Das Team Clean Coding Warum? Gute Vorsätze schwinden schnell Verrottung Unterschiedliche Meinungen Wildwuchs Mittel gegen die „Durchsetzungsstarken“ (die Stillen sind oft besser) Motivation durch Anerkennung, Kontrolle auf Augenhöhe
- 37. Das Team Clean Coding Basis-Konsens §1 ALLE Teammitglieder (inkl. Projektleitung) verpflichten sich, Prozesse anzuerkennen, die für ALLE gleichermaßen bindend sind. §2 Diese Prozesse können bei Bedarf jederzeit angepasst werden. §3 Als erstes muss ein effizientes Verfahren zur Entscheidungsfindung etabliert werden.
- 38. Das Team Clean Coding Methoden zur Entscheidungsfindung Vorgabe des Projektleiters Mehrheitsbeschluss Minimierung des durchschn. Widerstands – Vetoabfrage – Konsensrunde – Thumb-Voting „Konsens bedeutet die Übereinstimmung von Menschen hinsichtlich einer Thematik ohne verdeckten oder offenen Widerspruch.“ - Wikipedia
- 39. Das Team Clean Coding (Legislative) Was muß entschieden werden? Was bedeutet für uns die Definition of Done? Wie gehen wir mit unfertigem Code um? Code Tagging: Umgang mit „fremdem Eigentum“? Wie ist unser Was ist für uns clean? REFACTORE_MEs: FIXMEs, TODOs und FIXME jvo von rob 20.02.2011: Fall kunde == null fehlt DONE FIXMEs raus, TODOs raus oder in den Issue-Tracker
- 40. Das Team Clean Coding Wege zur Einigung im Team Daily Standups (Scrum-ähnlich) Regelmäßige Team-Reviews Retrospektiven Coding-Notes kommunizieren (z.B. E-Mail an Team-Verteiler) Pair-Programming von Erfahrenen und Unerfahrenen 4 -Reviews
- 41. Das Team Clean Coding 4 -Review Am Ende der Entwicklung eines Software-Teils sucht der Autor nach einem Teammitglied, das als Reviewer dient. Dieser prüft: Funktionelle Korrektheit Ausreichende Testabdeckung FIXME- / TODO-Einträge Einhaltung der im Team abgestimmten Clean-Code-Maßnahmen Erst nach dem OK des Reviewers gilt der Teil als DONE!
- 42. Das Team Clean Coding(Judikative) Die 1€-Regel Ein Euro wird eingezogen bei Vergehen gegen zuvor abgestimmte Regeln. Beispiele: Build brechen und nach Hause gehen, Tests brechen und sich nicht um deren Behebung bemühen, Backend-Änderungen ohne Client-Anpassung, Domain-Änderungen ohne DB-Skript-Anpassung, etc.
- 43. Was hilft wann? Dirty Code Ursachen Clean Code Dev. Team Clean Coding Unklare DOD DOD definieren Hauptsache, es läuft! Test first DOD anwenden, 4iReviews Gasfabrik KISS, YAGNI, VvO Team-Reviews, 4iReviews X-te Änderung Code Tagging Broken Windows Pfadfinderregel Code Tagging Konformitätsbrüche Reviews, ER, SCC 4iReviews Fortbildung LLL, TAF Team-Reviews, Pairprogramming Kommunikation Erfahrung weitergeben Wege zur Einigung im Team Organisation Rollen & Prozesse definieren Motivation Bewusstsein Anerkennung, 1€-Regel Termine Mentale Einstellung DOD anwenden
- 44. Agenda Einleitung Ursachen von Dirty Code Die Clean Code Developer Bewegung Das Team Clean Coding Meinungen zu Clean Code und zum Team Clean Coding
- 45. Clean-Code ist ist gut, man kann es – eher etwas für Ästheten! Clean-Code gut, aber praxisfern aber leicht übertreiben!
- 46. Ein Organismus verträgt nur ein begrenztes Maß an Schadstoffen.
- 47. Wichtig sind Funktionsfähigkeit, Stabilität, Wartbarkeit und Erweiterbarkeit. Clean-Code ist was für Spießer – wichtig ist nur, dass es läuft! Dazu braucht man kein Clean Code!
- 48. Sauberer Code - Hohe Testabdeckung Produktionscode Testabdeckung Testcode Schmutz im Code stellt eine reale Gefahr dar!
- 49. Clean Code kostet zusätzliche Zeit Clean Code spart Zeit in der Entwicklung! in der Wartung!
- 50. Wie wirkt sich die Anwendung der Best practices aus? 1 0 011 01 00 1 1 100 1001101 0011100 0110011 1010110 01 1 01 10 1 10 0 001 0110110 1100001 11 11 0 00 1010010 1111000 10 10 01 0 01 00 011 0 1 111 01 0100011 0111101 1000011 1001010 01 010 10 1 00 11 01 0101010 1001101 ERROR
- 51. Wofür steht ? & Software- Effektive qualität Softwareentwicklung
- 52. Nicht-funktionale Qualitätsmerkmale von Software Das Produkt korrekt, skalierbar, performant, (finales Ziel mit stabil, effizient, sicher (Security), Selbstzweck) zuverlässig, gesetzeskonform, gut bedienbar Der Entwicklungs- wirtschaftlich, testbar, erweiterbar, prozess veränderbar, analysierbar, wartbar (Zwischenziel, nur Mittel zum Zweck)
- 53. Take-Home-Message Möchten wir… …lesbaren & langlebigen Code? Clean-Code-Prinzipien anwenden …effektiv & effizient arbeiten? Clean-Code-Praktiken anwenden …effektiv & effizient bleiben? Clean-Code-Controlling anwenden Selbstkontrolle und Wertesystem konsequent anzuwenden, ist schwer!
- 54. Fragen?
- 56. Weiterführende Literatur Effective Java (2nd Edition), Joshua Bloch, Addison-Wesley, 2008 Der Weg zum Java-Profi, dpunkt-Verlag, 2011 Bug-Patterns in Java, Eric Allen, Apress, 2002 More Java Pitfalls, Wiley, 2003
- 57. Weiterführende Literatur Clean Code, Robert C. Martin, Prentice Hall, 2008 The Clean Coder, Robert C. Martin, Prentice Hall, 2011 Clean Coder: Verhaltensregeln für professionelle Programmierer, Robert C. Martin, Addison-Wesley, 2011 The Pragmatic Programmer, Addison-Wesley, 1999 Soft Skills für Softwareentwickler, dpunkt-Verlag, 2010 http://www.clean-code-developer.de http://de.wikipedia.org/wiki/Clean_Code http://www.clean-code.info
- 58. Diskussion Worin siehst Du Probleme in der Anwendung? Welche Art von Unterstützung brauchst Du im Programmier-Alltag? Ist diese Selbstkontrolle so schwer, dass man ein Team Clean Codingbenötigt?
- 59. Bildernachweise Die in diesem Vortrag verwendeten Bilder stammen von folgenden Quellen: Folie 6: http://www.flickr.com/photos/pringels/3139474250/sizes/l/in/photostream/ Folie 7: http://www.flickr.com/photos/23313526@N07/4948442428/sizes/l/in/photostream/ http://www.flickr.com/photos/29747502@N03/2784238062/sizes/l/in/photostream/ Folie 8: http://www.flickr.com/photos/buridansesel/6163446452/sizes/l/in/photostream/ Folie 9: http://office.microsoft.com/en-us/images http://officeimg.vo.msecnd.net/en-us/images/MB900443111.jpg http://officeimg.vo.msecnd.net/en-us/images/MB900443251.jpg Folie 10: http://office.microsoft.com/en-us/images Folie 11: http://photos.signonsandiego.com/album55/mud02 Folie 13: http://www.sxc.hu/browse.phtml?f=download&id=1099152 Folie 14: http://upload.wikimedia.org/wikipedia/commons/9/91/22_West_-_view_from_window.jpg
- 60. Bildernachweise Folie 16: http://www.clker.com Folie 18: http://www.sxc.hu/browse.phtml?f=download&id=866819 Folie 26: http://www.sxc.hu/browse.phtml?f=download&id=544619 Folie 27: http://commons.wikimedia.org/wiki/File:Change.jpg Folie 30: http://www.flickr.com/photos/ionics/6338284584 Folie 31: http://www.f1online.de http://www,flickr.com Folie 33: http://www.clker.com Folie 35: http://www.clker.com Folie 36: http://www.clean-code-developer.de Folie 38: http://photos.signonsandiego.com/album55/mud02
- 61. Bildernachweise Folie 41, 43, 45: http://www.clean-code-developer.de Folie 58: http://www.flickr.com/photos/oskay/437341603/ Folie 60, 61: http://www.clker.com Folie 62: http://openclipart.org/people/DooFi/DooFi_Piggybank.png http://openclipart.org/people/lolonene/1309969161.png Folie 65: http://freepostermaker.com/uploads/saved_posters/free-poster-dnxeoi88fg-WILLIES-WASH.jpg Folie 69: http://office.microsoft.com/de-de/images/results.aspx?qu=frau+computer&ex=1&ctt=1#ai:MP900430491| http://office.microsoft.com/de-de/images/results.aspx?ex=2&qu=frau%20b%C3%BCro%20stress#ai:MP900422409|mt:2| Folie 72: http://www.hborchert.de/medihumor.htm http://hdfreewallpaper.info/fishy-ubuntu-1920-x-1080.html Folie 76: http://www.clker.com Hinweis: Sämtliche hier nicht aufgeführte Bilder (z.B. auf Folie 28) wurden von den Autoren selbst erstellt.
- 62. Eclipse-IDE
- 63. Infrastruktur Entwicklung Build-System SCM Deployment Entwickler-PC Ent Abn Ref Prod
- 64. Continuous Build / Integration 1. Diese Tools ermöglichen einen automatischen Build der eingecheckten Sourcen 2. Getriggert: Zeitgesteuert, per Hand, Einchecken 3. ANT / Maven / Skript-Integration 4. Automatisches Deploy- ment möglich TeamCity – Ab einer Größe kostenpflichtig Hudson, Jenkins – Open Source
- 65. Qualitätssicherung Sonar – Open Source – Zusätzliches Tool zum Continuous Build – Berechnet zahlreiche Code-Metriken – Erzeugt schöne Grafiken – (Eigene) Plugins möglich
- 66. t.addCell (new Phrase(formatDateString( sd.date == null || "".equals (sd.date) ? sh.date.substring (0, 4) : sd.date), f)); Date datum = strukturDaten.date; if (datum == null) { datum = strukturHelper.date; } String datumFormatiert = formatDate(datum); Phrase phrase = new Phrase(datumFormatiert, format); table.addCell(phrase);
- 67. www.iks-gmbh.com