Oprogramowanie łatwe w utrzymaniu. Pisz kod podatny na przyszłe zmiany — Joost Visser

Przeczytałem ostatnio kolejną książkę. W tym wpisie dzielę się informacjami, które w niej znalazłem oraz które wdrożyłem w swoim życiu. Staram się z każdej książki wdrażać minimum jedną rzecz.

Wdrożyłem:

• Usprawnienie procesu naprawy błędów (najpierw fail test, a potem poprawka).

Notatki:

Pielęgnowalność oprogramowania to zdolność zmodyfikowania systemu.

Podstawowe rodzaje zadań związane z pielęgnowaniem oprogramowania:

• Pielęgnacja korekcyjna – naprawianie wykrytych błędów.
• Pielęgnacja adaptacyjna – dostosowywanie do zmian występujących w środowisku (aktualizacja systemu operacyjnego, protokołu przysyłania danych).
• Pielęgnacja doskonaląca – reagowanie na zmieniające się wymagania klienta.
• Konserwacja profilaktyczna – realizacja sposobów poprawiających jakość systemu lub zapobiegająca występowaniu przyszłych błędów.

Wytyczne dotyczące pielęgnowalności w skrócie:

1. Pisanie krótkich jednostek kodu – mniejsze jednostki oprogramowania łatwiej jest zrozumieć, przetestować i wykorzystać.
2. Pisanie prostych jednostek kodu – należy ograniczyć liczbę punktów decyzyjnych.
3. Pisanie kodu 1 raz – zawsze unikaj powielania kodu.
4. Ograniczenie wielkości interfejsu jednostek.
5. Separowanie zagadnień w modułach – luźno sprzężone moduły są łatwiejsze do modyfikowania i tworzenia bardziej modułowych systemów.
6. Luźne sprzężenie komponentów architektonicznych – luźno sprzężone wysokopoziomowe komponenty są łatwiejsze do modyfikowania i tworzenia bardziej modułowych systemów.
7. Równoważenie architektury komponentów – zrównoważona architektura o odpowiedniej liczbie komponentów mających podobną wielkość pozwalają najłatwiej tworzyć modułowy system prosty do modyfikacji.
8. Ograniczanie wielkości bazy kodu – wielki kod jest trudny w pielęgnacji.
9. Automatyzowanie testów.
10. Pisanie czystego kodu.

Wytyczne dotyczące pielęgnowalności:

1. Pisanie krótkich jednostek kodu – mniejsze jednostki oprogramowania łatwiej jest zrozumieć, przetestować i wykorzystać.
   • Ogranicz metodę do 15 linii.
   • Dobieraj starannie nazwy (metod, klas, zmiennych).
   • Krótka jednostka może zrobić tylko jedną rzecz — ma pojedynczą odpowiedzialność.
   • Techniki pomagające:
     • Wyodrębnianie metody — komentarze są zbędne, ponieważ nazwa metody przyjmuje ich rolę.
     • Zastąpienie metody obiektem metody.
2. Pisanie prostych jednostek kodu – należy ograniczyć liczbę punktów decyzyjnych.
   • Ogranicz liczbę punktów decyzyjnych jednostki do 4.
   • Techniki pomagające:
     • Zastępowanie warunku polimorfizmem.
     • Zastępowanie zagnieżdżonego warunku klauzulami strzegącymi.
3. Pisanie kodu 1 raz – zawsze unikaj powielania kodu.
   • Nie kopiuj kodu, ponieważ później będziesz musiał pamiętać, aby wszędzie wprowadzić poprawkę.
4. Ograniczenie wielkości interfejsu jednostek.
   • Ogranicz liczbę parametrów (metody, konstruktora) do 4.
   • Wyodrębnij parametry do obiektów.
   • Techniki pomagające:
     • Obiekt parametru (obiekt transferu danych).
5. Separowanie zagadnień w modułach – luźno sprzężone moduły są łatwiejsze do modyfikowania i tworzenia bardziej modułowych systemów.
   • Unikaj dużych modułów.
   • Przypisuj obowiązki do oddzielnych modułów.
   • Ukrywaj szczegóły implementacji za interfejsami.
6. Luźne sprzężenie komponentów architektonicznych – luźno sprzężone wysokopoziomowe komponenty są łatwiejsze do modyfikowania i tworzenia bardziej modułowych systemów.
   • Zapewnij luźne połączenie między komponentami.
   • Minimalizuj względną ilość kodu widoczną dla innych komponentów.
7. Równoważenie architektury komponentów – zrównoważona architektura o odpowiedniej liczbie komponentów mających podobną wielkość pozwalają najłatwiej tworzyć modułowy system prosty do modyfikacji.
   • Komponenty powinny być podobnej wielkości.
   • Liczba komponentów powinna być zbliżona do 9.
8. Ograniczanie wielkości bazy kodu – wielki kod jest trudny w pielęgnacji.
   • Ograniczaj wielkość kodu.
   • Techniki pomagające:
     • Środki funkcjonalne:
       • Walcz z pełzającym zakresem.
       • Standaryzuj funkcjonalności.
     • Środki techniczne:
       • Unikaj kopiowania i wklejania kodu.
       • Refaktoryzuj.
       • Używaj zewnętrznych bibliotek i frameworków.
       • Dziel system.
9. Automatyzowanie testów.
   • Automatyzuj testy.
   • Ogólne reguły pisania dobrych testów jednostkowych:
     • Testować należy przypadki normalne, specjalne i graniczne.
     • Testy to też kod produkcyjny.
     • Testy powinny być izolowane.
     • Wynik testu powinien odzwierciedlać jedynie działanie testowanego fragmentu.
10. Pisanie czystego kodu.
    • Nie pozostawiaj ze sobą zapachów kodu. Możesz użyć SonarQube, który wskaże Ci zapaszki.
    • Zasada skauta: zostaw obozowisko czystsze, niż się je zostałeś.
    • Wytyczne — nie pozostawiaj za sobą:
      • Zapachów w kodzie.
      • Złych komentarzy (komentarze w kodzie są sygnałem złych rozwiązań inżynierskich).
      • Zakomentowanego kodu.
      • Martwego kodu.
      • Długich i mylących nazw identyfikatorów.
      • Magicznych stałych — umieszczaj je w konfiguracji lub w bazie danych.
      • Źle obsłużonych wyjątków:
        • Zawsze przechwytuj wyjątki.
        • Przechwytuj konkretne wyjątki.
        • Tłumacz konkretne wyjątki na ogólne komunikaty. Nie pokazuj użytkownikowi końcowemu szczegółów implementacyjnych.

Sposób mierzenia pielęgnowalności wykorzystywane przez SIG

SIG przyznaje gwiazdy ocenianym systemom. Ciekawe jest to, że pięć gwiazdek dostaje 5% najlepszych systemów ze wszystkich ocenianych w danym teście. Sprawia to, że 5 gwiazdek z roku 2020 oznacza inną jakość niż 5 gwiazdek z 2000 roku. System z 1 gwiazdką w 2020 roku może być lepszy niż ten z 5 gwiazdkami przyznanymi w 2000 roku.

SIG zaobserwował, że jakość oprogramowania powoli, ale jednak stale się poprawia.

Wszystkie posty związane z książkowymi wdrożeniami:

• My robimy to inaczej! Opowieść o tym, jak organizacje powstają i upadają, by móc odrodzić się na nowo – J. Kotter, H. Rathgeber
• Zostań Drapieżnikiem — R. Mazur, M. Osman
• Od dobrego do wielkiego – J. Collins
• Ludzie. Krótka historia o tym, jak spieprzyliśmy wszystko – Tom Phillips
• Filozofia kaizen. Jak mały krok może zmienić Twoje życie — Maurer R.
• Od celu do wyniku. Siła mechanizmów katalitycznych w biznesie — J. Collins
• Praktyczne metody osiągania sukcesów. Potęga myśli — M. R. Kopmeyer
• Mit przedsiębiorczości. Dlaczego większość Małych firm upada i jak temu zaradzić – Michael E. Gerber
• Myśl i bogać się. Orientacja na cel — Greg S. Reid
• Dekalog szczęścia. Jak nie dać się udawanej radości, ale też nie wpaść w czarną rozpacz — w rozmowach z Beatą Pawłowicz
• Kreowanie Globalnej Marki. Magia Harry’ego Pottera — Stephen Brown
• Twoja wolność finansowa. Poprzez Marketing przez sieć — Andre Blanchard
• Prosta droga do sukcesu — Rafał Motriuk
• Eutyfron. Obrona. Kriton. — Platon
• Listy — Platon
• Starbucks. Sztuka wyciągania wniosków z porażek, czyli rewolucyjny przepis Schultza na wielki sukces — Howard Schultz z Joanne Gordon
• Zasada Dilberta. Szefowie, zebrania, fanaberie dyrekcji i inne plagi widziane z biurowej zagródki — Scott Adams
• Bądź kreatywny i pomysłowy — Barrie Hawkins
• Ludzie przeciwko ludziom — Jacek Santorski
• Emerytura nie jest Ci potrzebna, czyli jak kilka Twoich decyzji może spowodować, że zgromadzisz majątek i szybciej osiągniesz wolność finansową — Jacek Borowiak
• Laptopowy milioner. Jak zerwać z pracą na etacie i zacząć zarabiać w sieci — Mark Anastasi
• 4 godziny, by zostać mistrzem, nie tylko w kuchni — Timothy Ferriss
• Testy A/B. Od kliknięcia do klienta — Dan Siroker i Pete Koomen
• Sapiens. Od zwierząt do bogów — Yuval Noah Harari
• Niezwykłe historie zwykłych ludzi. Sekrety ich sukcesu — Alfred J. Palla
• Gotowi na start. Jak sprawdzić pomysł na biznes, żeby nie stracić czasu i pieniędzy — Pat Flynn
• Skuteczny e-mail marketing. Dowiedz się, jak skutecznie tworzyć wiadomości i sprzedawać e-mailem — Artur Maciorowski
• Wielka czwórka. Ukryte DNA: Amazon, Apple, Facebook i Google — Galloway Scott
• Biznes, czyli sztuka budowania relacji — Miłosz Brzeziński
• Życiologia, czyli o mądrym zarządzaniu czasem — Miłosz Brzeziński
• Cud uważności. Prosty podręcznik medytacji — Thich Nhat Hanh
• Umysł miliardera. 20 zasad bogactwa i sukcesu najbogatszych ludzi świata — Rafael Badziag
• Rework — Jason Fried, David Heinemeier Hansson
• Jak zdobyć bogactwo. Najważniejsze nauki jednego z najbogatszych brytyjskich przedsiębiorców — Felix Dennis
• Jak zarobić duże pieniądze. 88 sposobów na bogactwo i sukces — Felix Dennis
• Zdobywanie fortuny. Praktyczne metody osiągania sukcesów — M. R. Kopmeyer
• Miliarderzy. Kariery najbogatszych ludzi świata przedstawiają tajemnice swoich sukcesów — Charles-Albert Poissant, Christian Godefroy
• Elon Musk. Biografia twórcy PayPala, Tesli, SpaceX — Ashlee Vance
• Finansowa forteca. Jak inwestować skutecznie i mieć święty spokój — Marcin Iwuć
• Specyfikacja na przykładach. Poznaj zwinne metody pracy i dostarczaj właściwe oprogramowanie — Gojko Adzic
• Oprogramowanie łatwe w utrzymaniu. Pisz kod podatny na przyszłe zmiany — Joost Visser
• Jak uczyć się efektywnie: metody i motywacja: praktyczny poradnik — Edwin A. Locke
• Wy wszyscy moi ja — Miłosz Brzeziński
• Jak odgracić dom — Dana K. White
• Doskonała kariera — Max Eggert – moje notatki
• Steve Jobs — Walter Isaacson – notatki z książki
• Jak uniknąć pomyłek — Robert E. Mittelstaedt, Jr.
• Głowa do liczb — dr Barbara Oakley
• Najbogatszy człowiek w Babilonie — George S. Clason
• Wielkie marzenia? Szimon Peres i jego książka
• 25 miniemerytur — Jakub B. Bączek
• Jakoś wkrótce — Kelly i Zach Weinersmithowie
• Wielcy z wyboru — Jim Collins, Morten T. Hansen
• Jak upadają giganci — Jim Collins – notatki
• Wizjonerskie organizacje — Jim Collins, Jerry I. Porras
• Współbieżność w języku C#. Receptury — Stephen Cleary
• Myślenie strategiczne — Harris Vincent
• Wszyscy kłamią… — Seth Stephens-Davidowitz
• W co grają ludzie. Psychologia stosunków międzyludzkich — Eric Berne
• Doskonała obsługa klienta — Ted Johns
• Bogaty albo biedny po prostu różni mentalnie — T. Harv Eker
• Unscripted Życie wolność przedsiębiorczość — MJ DeMarco
• Emo Sapiens Harmonia emocji i rozumu – Rafał Ohme
• Nieznane więzi natury — Peter Wohlleben
• Adaptywny kod. Zwinne programowanie wzorce projektowe i SOLID-ne zasady – Gary McLean Hall
• Wieczne opóźnienie Zarządzanie projektami IT — Marcin Dąbrowski
• Jak skutecznie współdziałać w miejscu pracy — Kevin Narramore
• Organizacja spotkań Praktyczny poradnik dla tych, którzy nie lubią tracić czasu — Carol R. Anderson
• WikiLeaks od środka — Daniel Domscheit-Berg
• Niepowstrzymany rozwój Jak zmieniać firmę gdy zmienia się rynek — Chris Zook
• Postaw na swoim Praktyczne sposoby jak wywierać wpływ na innych — Nicole Soames
• Magia zmiany Przekrocz własne granice i osiągnij cel — Czarodziej Jakub
• Jak to ogarnąć? Praktyczny poradnik zarządzania szczęściem — Agnieszka Stefaniuk
• Gdzie rosną pieniądze Pierwszy poradnik o tym jak znaleźć pieniądze nie wychodząc z domu — Joanna Dymmel
• Unf*ck yourself Napraw się Mniej myśl więcej żyj — Gary John Bishop
• Stwórz jednorożca Od idei po startup wart miliony — Kubera Grzegorz
• Dowiedz się jak zarabiać online bez inwestycji — Łukasz Cichocki
• Zostań ultrasamoukiem Jak mistrzowsko opanować twarde umiejętności w zadziwiająco krótkim czasie — Scott Young
• Korposzczury Jak kultura korpo zrobiła z naszej pracy piekło — Dan Lyons
• Steve Jobs gdzie pada jabłko iPrzewodnik dla nowej generacji — Jay Elliot
• Wrzuć na luz jak poskromić i uspokoić swój umysł — Serge Marquis
• Wszystko zaczyna się w głowie: a kończy gdy nie działasz — Karolina Cwalina-Stępniak
• Zero Waste: śmieć mniej żyj lepiej — Amy Korst
• Liderzy jedzą na końcu — Simon Sinek
• Nie z miłości Mądrzy rodzice – silne dzieci — Jesper Juul
• Gra bez końca — Simon Sinek
• Mój Ojciec Mój Przyjaciel — André Stern, Arno Stern
• Gospodarka nie-wiedzy — Krzysztof Jan Konsztowicz
• Genialny sprzedawca — Tony Buzan Richard Israel
• Ciągłe dostarczanie oprogramowania Kompletny przewodnik — Eberhard Wolff
• WOPR Życiu na ratunek — Dawid Góra
• Krótka historia czasu Od Wielkiego Wybuchu do czarnych dziur — Stephen Hawking
• O pszczołach i ludziach – Lotte Möller
• Jak umiejętnie sprzedawać i zwielokrotniać dochody — Bettger Frank
• Rio Anaconda – Wojciech Cejrowski
• Nie z miłości Mądrzy rodzice – silne dzieci — Jesper Juul – Książkowe wdrożenia
• Zamiast wychowania O sile relacji z dzieckiem — Jesper Juul
• Bóg i Stephen Hawking. Czyj to w końcu projekt? — John Lennox
• Rodzic jako przywódca stada. Pełne miłości przywództwo w rodzinie — Jesper Juul

Źródła

Obraz główny

• Praca własna

Materiały

1. 1. • Oprogramowanie łatwe w utrzymaniu. Pisz kod podatny na przyszłe zmiany — Joost Visser.

Linki oznaczone (*) są linkami afiliacyjnymi. Jeżeli uważasz, że czerpiesz korzyści z mojej pracy, to kup coś korzystając z powyższego linku. Sprawi to, że dostanę prowizję z afiliacji.