Contracte Partea practică a semanticii

Ca întotdeauna, totuși, există și cealaltă parte a contractului respectiv. Implementatorul funcționalității promite să utilizeze funcționalitatea specificată. Imediat ce abuzează de această funcționalitate, toate pariurile sunt dezactivate - ceea ce duce la potențialul eșec.

Contracte de funcționalitate a browserului

Să revenim la "Vezi mai mult"Exemplu de mai devreme. În primele zile de JavaScript, dezvoltatorii ar scrie JavaScript folosind un pseudo protocol, JavaScript:

 Vezi mai mult

Relativ repede, au început să realizeze că această abordare are cel puțin un defect practic: codul JavaScript este afișat în bara de stare a browserului, care nu arată profesional. Răspunsul la această dilemă a fost acela de a muta codul la un onclick handler, și înlocuiți href atribut cu un identificator hash goală, după cum urmează:

 Vezi mai mult

Desigur, asta nu a rezolvat totul. Dacă Afișați mai multe are o eroare, return false nu este chemată niciodată, iar pagina este derulată în partea de sus - cu siguranță nu este dorită comportament.

Astăzi, dezvoltatorii își separă codurile HTML și JavaScript și utilizează tehnici adecvate de prevenire a evenimentelor:

 Vezi mai mult

 $ ('a.show-more') pe ('click', functie (eveniment) event.preventDefault (); ShowMore (););

Dar ghicește ce? Există încă multe probleme cu această abordare: deschiderea într-o filă nouă, marcarea sau copierea link-ului nu funcționează așa cum s-ar putea aștepta utilizatorul (mai ales dacă există etichetă pe pagină), ceea ce duce la confuzie și, eventual, la pierderea unui client.

Observați cum toate problemele descrise până acum au apărut dintr-un singur fapt. Dezvoltatorii au încălcat partea lor din contract cu producătorii de browsere: href atributul trebuie să conțină o adresă URL corectă, dar, în schimb, dezvoltatorii au introdus tot felul de gunoi.

 Vezi mai mult

 $ ("button.show-more") pe ("clic", ShowMore);

 a, .link-style culoare: @ albastru-albastru; text-decorare: subliniere; . stil de legătură font: inherit; fundal: nici unul; frontieră: nici una; cursor: pointer; 

Indiferent de câte noi modalități de a interacționa cu linkurile sunt adăugate la viitoarele iterații ale browserelor, această abordare va continua să funcționeze, deoarece nu încălcăm niciun contract cu browserul. Folosim elemente pentru a le transmite sensul și, în loc să ne ocupăm constant de noi probleme, știm că browserul va trata acest lucru în mod corect, deoarece înțelege ceea ce vrem.

Sigur, s-ar putea să fie nevoie de câteva linii suplimentare de CSS pentru a reinițializa unele dintre stilul implicit al nasturilor. Se merită! Nu fi leneș.

Specificații ca contracte

... cei care cunoscuseră semantica și ignorau cu bună știință.

În 2005, o mare parte din comunitatea de dezvoltare web a învățat modul greu că ignorarea cerințelor HTTP este rău. Google Web Accelerator nou lansat pre-introduce URL-uri pe o pagină pentru a minimiza timpul de așteptare al utilizatorului cu un clic.

Acest lucru a distrus haosul în aplicațiile care au ignorat HTTP și au pus operații distructive în spatele legăturilor simple. Și au existat multe astfel de aplicații.

Problema nu a rămas în mâinile dezvoltatorilor care nu înțelegeau semantica metodelor HTTP. Nu, problema a venit de la cei care au cunoscut semantica, ignorându-i cu bună știință și nu au împărtășit cunoștințele.

Contracte de întreținere

Codul confuz este rău!

De asemenea, există contracte între dezvoltatori. De fiecare dată când scrieți o linie de cod, faceți o promisiune dezvoltatorilor viitori că face exact ceea ce pare să facă. Cu alte cuvinte, codul derutant este rău!

De exemplu, utilizând o funcție de filtrare (cum ar fi filtru în Python) pentru a bifa peste elemente este incorectă, deoarece există un contract implicit că funcțiile de filtrare modifică numai lista fără a avea efecte secundare:

 Definiție def (element): imprimare (element) fructe = ['portocaliu', 'mere', 'lămâie'] filtru (spectacol, fructe)

În schimb, utilizați o buclă explicită pe o listă:

 (fruct) = ['portocaliu', 'măr', 'lămâie'] pentru fructe în fructe: spectacol (fructe)

Pe de altă parte, dacă vă puteți baza pe un contract, acesta vă va permite să vă clarificați codul. De exemplu, folosind array_filter în loc de a pentru buclă în PHP pentru a filtra elementele permite altor dezvoltatori să înțeleagă ce se întâmplă după o singură privire:

 $ venituri = [20, 15, -7, 19]; $ profit = array_filter ($ venituri, funcție ($ i) retur $ i> 0;);

Comparați fragmentul de mai sus cu utilizarea a pentru buclă:

 $ venituri = [20, 15, -7, 19]; $ profituri = []; foreach ($ venituri ca $ i) if ($ i> 0) $ profit [] = $ i; 

A doua versiune este mai rău, nu numai pentru că este mai lungă, ci și pentru că array_filter oferă o așteptare. Este clar că $ profit este un subset de $ venituri. Nu există o astfel de convenție cu generic pentru buclă, ceea ce explică de ce nu putem face nici o ipoteză, fără a descifra mai întâi interiorul buclei.

Scrierea corectă a codului semantic

Cum distingeți între codul care este și nu este semantic? Cum observați aceste contracte? În cea mai mare parte, simpla întrebare a întrebărilor ar trebui să fie suficientă.

Etichete HTML

Funcții numite

"Trebuie să tipăresc conținutul listei mele într-un filtru funcţie. Este imprimarea elementelor parte a procesului de filtrare? "Nu într-adevăr. Asta înseamnă că abuz filtru.

Funcții care nu prea mult

"Eu scriu a getFoo și trebuie să adăugați un cod de modificare în cadrul acestuia. Modifică starea de spirit ca parte a obținerii foo? Ar fi cineva care vrea pur și simplu să se aștepte ca altceva să se întâmple? "Probabil că nu!

Separarea preocupărilor

"Vreau să adaug câteva JavaScript în cadrul unui cod HTML onclick atribut. Este corect? "Fișierul pe care îl modificați este .html, dreapta? În schimb, plasați-vă JavaScript și CSS în cadrul acestuia .js și .css fișiere, respectiv. Mereu.

Desigur, în multe cazuri, pot fi necesare anumite cunoștințe suplimentare pentru a evalua în mod corespunzător situația. Ceea ce contează cel mai mult este să începeți să vă gândiți la aceste lucruri și să evitați principiul "aceasta (oarecum) funcționează, deci este suficient de fină."În schimb, întotdeauna întrebați-vă:" Ce înseamnă în realitate codul pe care îl scriu? "

Concluzie

Încălcarea unui contract garantează că se va sparge cooperarea.

Cooperarea depinde mereu de efortul ambelor părți. Majoritatea dezvoltării de software se reduce la cooperare: cooperarea dintre producătorii de hardware, programatorii de sistem, dezvoltatorii de browsere, autorii bibliotecii, dezvoltatorii de site-uri web și mulți alții. Încălcarea unui contract garantează că se va sparge cooperarea.

Semantica codului este un astfel de contract. Ai grijă de asta pentru binele tău!

Note de subsol

Strict vorbind, un identificator de fragment gol # poate fi considerată valabilă în acest context. Această tehnicitate, totuși, ratează punctul pe care îl fac în articol.