Tiszta kód elvek - összefoglaló

Elnevezések:

• kommunikálja jól a szándékot
• ne legyen félrevezető, bizonytalan jelentésű
• hosszabb elnevezések kis eltéréssel
• helyesírás
• kiejthető (az esetleges szóbeli kommunikáció miatt)
• típusra utalást NE
• probléma, megoldás domén elnevezések (account, JobQueue)
• ne mókázzunk (whack vs kill)
• class: főnév (kerüljük a túl általánost: pl. Manager, Info, Data)
• metódus: ige vagy igei alak
• adott koncepciót egységesen ugyanavval (retrieve, fetch, get)
• több koncepcióra ugyanazt ne
• elegendő kontextust kapjon (number: phone or people?)
• de többet ne
• ésszerűen minél rövidebb

Metódus:

• rövid
• részekre szedés
• követhető szerkezet
• kevés behúzási (indent) szint
• rövid sorok
• egy dolgot csináljon
• ugyanazon absztrakciós szinten maradjon (details vs essential concepts)
• The Stepdown rule – Lépésenkénti haladás
• argument: az ideális, ha nincs; háromnál több kétséges
• output argument: nehéz megérteni
• flag argument: ronda, jelzi, h nem egy dolgot csinál
• side effect: ne!
• command-query separation: vagy-vagy, ne mindkettőt
• exception: részesítsük előnyben a visszatérési értékkel szemben
• try-catch: a blokkok tartalma külön fgv
• hibakezelés: „egy dolog”
• enum hibatípus: dependency magnet
• DRY: don’t repeat yourself

Switch statement:

• veszélyes
• hosszú
• túl sokat csinálhat
• Open Closed Principle sérülhet
• -> Abstract Factory-ba rejtés

Komment: legtöbbször a szükséges rossz

• a nem pontos rosszabb, mint a hiányzó
• gyakran a rossz kódot próbálja kompenzálni
• jó:
  • jogi
  • informatív: pl. regexp magyarázata formátummal
  • szándék magyarázata
  • tisztázás (pl. a < b)
  • következményekre figyelmeztetés
  • TODO
  • megerősítés
  • API doc!
• rossz:
  • érthetetlen motyogás
  • redundáns (a kód OK)
  • félrevezető
  • kötelező jelleggel letudott
  • zaj (semmitmondó)
  • függvény vagy változó helyett
  • pozíció jelzés (forráson belüli szekcionálás)
  • kiiktatott kód!túl sok infó
  • API doc nem publikus kódra

Kódformázás

• függőleges:
  • kisebb fájlokat általában könnyebb megérteni
  • újság metafóra
  • szellős vs tömör (térköz)
  • távolság
  • változó deklaráció: közel a felhasználáshoz
  • példányváltozó: az osztály tetején
  • függő metódusok
  • koncepcionális affinitás (az összetartozó részel közelsége)
  • rendezés
• vízszintes
  • a rövidebb jobb (a technológia megengedne hosszút is..)
  • szellős vs tömör (térköz)
  • alignment
  • indent
• konvenció -> egyezség!

Objektumok és adatstruktúrák

• objektum:
  • absztrakció: megvalósítás elrejtése
  • adatreprezentáció
  • adatmanipuláló függvények
• adatstruktúra
  • adatok feltárása
  • nincsenek adatmanipuláló függvények
• Demeter törvénye: egy modulnak nem szabad tudnia az általa manipulált objektumok belsejéről (a.getB().getC() )
• hibrid: kerülendő
• a.getC() vs a.doSomethingOnC()

Hibakezelés

• fontos
• ne zavarja a programlogikát
• lsd metódus
• checked vs unchecked: pros vs cons
• Special Case Pattern
• return no null: SCP, NullObject Pattern etc

Határvonalak

• 3rd party kód: korlátozzuk/csomagoljuk be
• felfedező tesztesetek (ne a kódban)
• nem kiforrott elképzelések IF mögé rejtése
• világos definíció

Unit teszt

• TDD három törvénye -> rengeteg kód, tiszta!!
  • először hibázó teszt kód, utána a tesztelendő kód
  • csak annyi teszt kódot szabad írni, amennyi elegendő egy hibára; a fordítási hiba is hiba
  • csak annyi tesztelendő kódot szabad írni, amennyi a hibázó tesztet megjavítja
• test enable –ilities
• olvashatóság
• domain-specific test language
• hatékonyság nem szempont
• assert/teszt (TDD) vs 1 koncepció/teszt
• FIRST: fast, independent, repeatable, self-validating, timely

Class

• elrejtés
• kicsi
• egyetlen felelősség (Single Responsibility Principle)
• kohézió: példányváltózók száma vs az egyes metódusok által használtak száma
• a fentiből -> sok kis osztály
• változásra tervezés
• változástól elhatárolás: DIP

Rendszerek

• „Complexity kills. It sucks the life out of developers, it makes products difficult to plan, build, and test”
• a rendszer konstruálásának és futásának szétválasztása
  • lusta inicializálás
  • factories
  • DI (ellentmondásos)
• separation of concerns
• cross-cutting concerns: AOP, Java Proxy
• döntés optimalizálás: ki, mikor
• standardok: demonstrálható értéket adjanak
• DSL!!!

Emergence (kialakulás)

• Simple Design
  1. minden teszt futtatása
  2. nincs duplikáció
  3. kifejezi a programozó szándékát
  4. class/method száma minimalizált
• 2-4: refaktorálás!

Többszálúság

• nehéz és komplex
• „mit” „mikor” szétválasztása
• nem mindig teljesítménynövelő
• rendszerint mély hatással van a rendszer struktúrájára
• a konténerek sem mentenek meg tőle
• bonyolítja a kódot
• hibák nehezen felderíthetők
• stb.

Gyanús kód (code smell - Martin Fowler)

• rossz kommentek
• környezet:
• egyetlen lépésben végre nem hajtható build
• egyetlen lépésben végre nem hajtható teszt
• lsd. metódus problémák
• általános
• egyetlen forrásfájlban több nyelv
• nyilvánvaló viselkedés nem implementált
• nem korrekt viselkedés határvonalon: minden eset lefedése
• felülírt biztonsági pontok (pl. nem működő teszteset kiiktatása)
• DRY megsértése
• hibás absztrakciós szintű kód
• ősosztály függése a leszármazottól
• túl sok információ (modul API)
• zűrzavar, döglött kód
• nagy függőleges szeparáció
• inkonzisztencia (kövesd a konvenciókat)
• mesterséges (szükségtelen?) csatolás
• funkció-irígység (Demeter?)
• selector argument (flag argument)
• homályos szándék
• rosszul elhelyezett felelősség
• alkalmatlan static
• nem érthető algoritmus (tesztek lefutása nem elég)
• if/else, switch/case
• elnevezés nélküli mágikus konstans
• precizitás hiánya
• a struktúra megelőzi a konvenciót
• feltételes szerkezet elrejtése
• negatív feltétel
• rejtett időbeli csatolás
• önkényesség