Ultima actualizare: 13 decembrie 2016

curată

Această postare acoperă regulile generale de codificare curată pentru denumirea și utilizarea variabilelor și funcțiilor, precum și unele bune practici de codificare curată specifice JavaScript

Serviciile RisingStack:

Înscrieți-vă la newsletter-ul nostru!

Alăturați-vă 150.000 de cititori lunare.

Articole detaliate despre Node.js, Microservices, Kubernetes și DevOps.

În acest articol:

Programator Full-Stack la RisingStack.

Scrierea unui cod curat este ceea ce trebuie să știți și să faceți pentru a vă numi dezvoltator profesionist. Nu există nicio scuză rezonabilă pentru a face ceva mai mic decât cel mai bun.

„Chiar și codul rău poate funcționa. Dar dacă codul nu este curat, acesta poate aduce o organizație de dezvoltare în genunchi. " - Robert C. Martin (unchiul Bob)

În această postare de blog, vom acoperi principiile generale de codificare curată pentru denumirea și utilizarea variabilelor și funcțiilor, precum și unele Cele mai bune practici de codificare curată specifică JavaScript.

Node.js la scară este o colecție de articole axate pe nevoile companiilor cu instalații Node.js mai mari și dezvoltatori avansați de noduri. Capitole:

În primul rând, ce înseamnă codificare curată?

Codificarea curată înseamnă că, în primul rând, scrieți codul pentru sinele dvs. ulterior și pentru colegii dvs. de muncă și nu pentru mașină.

Codul dvs. trebuie să fie ușor de înțeles pentru oameni.

Știți că lucrați la un cod curat atunci când fiecare rutină pe care o citiți se dovedește a fi aproape ceea ce vă așteptați.

Cele mai bune practici de codificare curată JavaScript

Acum, că știm ce ar trebui să vizeze fiecare dezvoltator, să trecem prin cele mai bune practici!

Cum ar trebui să-mi denumesc variabilele?

Folosiți nume care dezvăluie intenția și nu vă faceți griji dacă aveți nume variabile lungi în loc să salvați câteva linii de tastatură.

Dacă urmați această practică, numele dvs. devin căutabile, ceea ce ajută foarte mult atunci când faci refactori sau doar cauți ceva.

De asemenea, faceți distincții semnificative și nu adăugați substantive suplimentare, inutile la numele variabilelor, precum tipul său (notație maghiară).

Faceți numele variabilelor ușor de pronunțat, deoarece pentru mintea umană este nevoie de mai puțin efort pentru a procesa.

Când faceți recenzii de cod împreună cu colegii dvs. de dezvoltatori, aceste nume sunt mai ușor de referit.

Pe scurt, nu provocați o cartografiere mentală suplimentară cu numele dvs.

Cum ar trebui să-mi scriu funcțiile?

Funcțiile dvs. ar trebui să facă un singur lucru doar la un singur nivel de abstractizare.

Funcțiile ar trebui să facă un lucru. Ar trebui să o facă bine. Ar trebui să o facă numai. - Robert C. Martin (unchiul Bob)

După ce v-ați scris corect funcțiile, puteți testa cât de bine v-ați descurcat cu profilarea procesorului - ceea ce vă ajută să găsiți blocaje.

Folosiți nume lungi, descriptive

Un nume de funcție ar trebui să fie un verb sau o sintagmă verbală, și ea trebuie să-și comunice intenția, precum și ordinea și intenția argumentelor.

Un nume descriptiv lung este mult mai bun decât un nume scurt, enigmatic sau un comentariu descriptiv lung.

Evitați lista lungă de argumente

Folosiți în schimb un parametru de obiect unic și alocarea destructurării. De asemenea, facilitează mult manipularea parametrilor opționali.

Reduceți efectele secundare

Folosiți funcții pure fără efecte secundare, ori de câte ori puteți. Sunt foarte ușor de utilizat și testat.

Organizați-vă funcțiile într-un fișier conform regulii de retragere

Funcțiile de nivel superior ar trebui să fie la nivelurile superioare și inferioare. Este natural să citiți codul sursă.

Interogare sau modificare

Funcțiile ar trebui să facă ceva (să modifice) sau să răspundă la ceva (interogare), dar nu ambele.

Toată lumea îi place să scrie JavaScript diferit, ce să facă?

Deoarece JavaScript este dinamic și slab tastat, este predispus în special la erori de programare.

Utilizați regulile și stilul de formatare a proiectelor sau companiei.

Cu cât regulile sunt mai stricte, cu atât se va depune mai puțin efort pentru a arăta o formatare proastă în recenziile de cod. Ar trebui să acopere lucruri precum denumirea consecventă, dimensiunea indentării, plasarea spațiului alb și chiar punct și virgula.

Stilul standard JS este destul de plăcut pentru început, dar, în opinia mea, nu este suficient de strict. Pot accepta majoritatea regulilor în stilul Airbnb.

Cum se scrie un cod asincron frumos?

Folosește Promisiunile ori de câte ori poți.

Promisiunile sunt disponibile în mod nativ de la nodul 4. În loc să scrieți apeluri de apel imbricate, puteți avea apeluri Promise înlănțuite.

Majoritatea bibliotecilor de acolo au atât interfețe de apelare, cât și de promisiune, preferându-le pe acestea din urmă. Puteți chiar să convertiți API-urile de apelare inversă pentru a promite una bazată prin împachetarea lor folosind pachete precum es6-promisify.

Următorul pas ar fi să utilizați asincronizare/așteptare (≥ Nodul 7) sau generatoare cu co (≥ Nodul 4) pentru a realiza fluxuri de control asemănătoare sincrone pentru codul dvs. asincron.

Cum ar trebui să scriu cod performant?

În primul rând, ar trebui să scrieți un cod curat, apoi să utilizați profilarea pentru a găsi blocaje de performanță.

Nu încercați niciodată să scrieți mai întâi cod performant și inteligent, în schimb, optimizați codul atunci când aveți nevoie și consultați impactul adevărat în loc de micro-repere.

Deși, există unele scenarii simple, cum ar fi inițializarea cu nerăbdare a ceea ce puteți (de exemplu, schemele Joi în rutele de gestionare, care ar fi utilizate în fiecare cerere și care adaugă cheltuieli generale serioase dacă sunt recreate de fiecare dată) și utilizarea codului asincron în loc de blocare.

Urmează în Node.js la Scală

În următorul episod al acestei serii, vom discuta despre cele mai bune practici asincronizate Node.js avansate și despre evitarea infernului de apel invers!

Dacă aveți întrebări cu privire la codificarea curată, nu ezitați și anunțați-mă în comentarii!