Cele mai bune practici SQL - Cum să tastați codul curat și organizat perfect

Cod curat

În această postare, vom acorda atenție stilului de codare. Există multe moduri în care vă puteți scrie codul, dar există doar câteva considerate profesionale.

Respectarea regulilor de stil de codare este crucială. Când avansați în programare, nu numai în SQL, ci în orice limbaj, nu veți lucra niciodată pe cont propriu. Vei lucra întotdeauna în echipă. Chiar dacă sunteți freelancer care lucrează online, va exista întotdeauna cineva care vă va citi codul la un moment dat. Apoi, veți afla că există o singură noțiune care nu vă va oferi o pauză - noțiunea de cod curat.

Codul curat este codul focalizat și inteligibil, ceea ce înseamnă că trebuie să fie lizibil, logic și schimbabil. Amintiți-vă - codul bun nu este cel pe care calculatoarele îl înțeleg; este cel pe care oamenii îl pot înțelege.

Adesea, un program poate fi creat în mai multe moduri, iar codul, în general, poate fi organizat în mai multe moduri. O bună practică presupune că vei alege versiunea care va fi cea mai ușor de citit și de înțeles și va fi cea care nu îi împiedică pe colegii tăi să o actualizeze când este necesar. Probabil că vor funcționa în partea superioară a codului dvs., așa că este cel mai bine dacă nu pierdeți timp pentru a găsi idei sub linii complexe de cod. De aceea, presupunerea este că, la locul de muncă, veți introduce întotdeauna cod curat - cât se poate de simplu, perfect organizat, menținând un flux logic constant.

Stil bun

Acum, să ne concentrăm pe un alt aspect al codării în stil bun. Atunci când alocați nume pentru variabile sau obiecte SQL, alegeți întotdeauna nume mai scurte, semnificative, care transmit informații specifice. Prin „semnificative”, ne referim la nume care se pronunță, unde un cuvânt per concept a fost ales. De exemplu, acesta este motivul pentru care am ales „numărul de achiziție”, nu „numărul de achiziție al clientului” din tabelul „Vânzări”.

În acest cont, nu trebuie să vă grăbiți să alegeți nume, deoarece acestea trebuie să reflecte cât mai mult din funcționalitatea obiectului. Numele vor constitui mai mult de 80% din codul dvs., deci contează cu cele cu care lucrați!

Se discută adesea dacă trebuie folosită majuscule sau litere mici la codare. Adevărul este - depinde de stilul dvs. sau de stilul companiei pentru care lucrați. Cel mai adesea, profesioniștii vor valorifica cuvintele cheie SQL și vor scrie numele obiectelor într-un mod diferit.

Când un nume cuprinde mai mult de un cuvânt, cum ar fi „număr de achiziție”, cuvintele sunt fie de obicei separate printr-o notă subliniată sau atașate între ele și fiecare cuvânt începe cu o majusculă. Ambele abordări sunt întâlnite în codificarea profesională. Cu toate acestea, un lucru este sigur - nu puteți lăsa un spațiu liber între cuvinte. MySQL va afișa un mesaj de eroare dacă încercați să faceți asta.

Lizibilitatea codului

A treia fațetă pe care ne vom concentra în această postare este lizibilitatea codului dvs. Pe de o parte, aceasta privește organizarea orizontală și verticală a codului, pe de altă parte, culoarea cu care sunt afișate cuvintele.

Tehnic, orice interogare SQL poate fi scrisă pe o singură linie. Cu toate acestea, multe întrebări sunt prea lungi și vor deveni dificil de citit dacă facem asta. Ceea ce trebuie făcut în astfel de cazuri este organizarea codului, nu doar pe orizontală, ci și pe verticală.

În funcție de semnificația lor într-o interogare și de modul în care dorim ca acestea să fie citite, cuvintele pot fi scrise în diferite culori. Cuvintele cheie SQL sunt scrise în albastru, numele obiectelor în negru, numerele în portocaliu și așa mai departe.

Mențineți-vă codul

Pe măsură ce avansăm în postare, veți dezvolta un ochi pentru organizarea impecabilă a codului pe care îl scrieți. Deocamdată, nu uitați că există trei moduri principale de a vă menține bine codul:

1. Profesioniștii folosesc software ad-hoc care reorganizează codul și colorează cuvinte diferite. Într-un mediu de codare mai dinamic, timpul va fi un factor, iar unificarea stilului de codare va fi o prioritate. Este imposibil să ai 50 de programatori în compania ta, toate scriind în același stil. Este neprofesional să îmbini codul scris în aceeași limbă, dar într-un stil diferit. Așadar, la finalizare, bucăți de cod de lucru trec prin verificarea unui astfel de software, iar șeful tău va avea o grămadă de cod scrisă în același stil.

2. Utilizați instrumentul analogic relevant furnizat în Workbench. Această perie mică îți înfrumusețează codul. Combinația de taste rapide pentru a aplica această funcție la interogarea în care se află cursorul dvs. este Ctrl și B. Vedeți? Minunat!

3. Dacă preferați să vă curățați codul diferit, ar trebui să interveniți manual și să-l reglați după cum doriți.

Exercițiu

În această linie simplă, vom crea un tabel de test cu două coloane - „Numere” și „Cuvinte”.

Am scris codul pe o linie cu litere mici. Observați cum MySQL a schimbat culoarea cuvintelor cheie, tipuri de date și numere. Acum, nu vom avea de-a face cu un software ad-hoc, deoarece ne concentrăm pe Workbench. După ce ați plasat cursorul undeva în această interogare, puteți apăsa pictograma perie mică pentru a reformata scriptul. Pentru a face aceeași operație mai repede, amintiți-vă de comanda rapidă Ctrl și B.

Wow! A mers.

Cuvintele cheie sunt cu majuscule, iar datele pentru fiecare coloană a tabelului pornesc pe o nouă linie. Grozav!

Stil de indentare

Imaginați-vă că aveți o preferință suplimentară în ceea ce privește organizarea orizontală a acestui cod și alinierea tuturor tipurilor de date. Folosind butonul tab de pe tastatură, puteți seta INT și VARCHAR să înceapă în același punct orizontal. Conform unor utilizatori, acest truc îmbunătățește și mai mult lizibilitatea codului.

Termenul tehnic se numește indentare. Spunem că numele coloanelor și tipurile lor de date au fost indentate la dreapta.

Comentarii

Un alt aspect al menținerii unui stil de codare bun este utilizarea comentariilor. Acestea sunt linii de text pe care Workbench nu va rula ca cod; ei transmit un mesaj cuiva care ne citește codul. Tehnic, în MySQL, puteți începe un comentariu tastând un slash înainte și o stea și îl puteți închide reciproc cu o stea și o tăiere înainte. Această abordare este utilizată în principal pentru comentarii mari.
Pentru comentarii cu o linie, puteți utiliza fie două liniuțe sau unul sau mai multe semne de hash. În plus, pentru a le diferenția de simplu cod, MySQL Workbench marchează toate comentariile în gri.

Fantastic!

Execută Codul

În cele din urmă, aș dori să detaliez simbolul fulger, care vă ajută să vă executați codul.

Să pornim de la faptul că codul dvs. este separat în blocuri, așa cum este marcat de separatorul de semicolon. O.K.

Deci, dacă așezați cursorul pe un singur bloc și apoi apăsați pictograma fulger sau combinația Ctrl, Shift, Enter, SQL va rula interogările selectate și toate celelalte.

De aceea, dacă fac clic pe FROM și execut codul în acest fel, voi vedea ieșirea din instrucțiunea SELECT și va renunța la tabelul de testare.

Dacă doriți să rulați doar instrucțiunea sub cursor, trebuie să apăsați pictograma adiacentă, în care sunt descrise un fulger și un cursor. Combinația de tastatură corespunzătoare este Ctrl și Enter.

Vă pot promite că nu veți înceta să utilizați această combinație de tastatură, deoarece vă permite să vedeți rapid ieșirea unei anumite interogări, fără a fi necesar să rulați întregul cod SQL.

Ei bine ... sper că v-a plăcut această postare! Acesta a avut ca scop să vă conștientizeze noțiunea de codare curată și codare în stil bun. Considerăm aceste instrumente esențiale pentru o bună codificare profesională, așa că am fi bucuroși dacă puteți simți că ați început să construiți obiceiuri bune de stil de codare.