SQL paraugprakse - kā tīri un perfekti sakārtot kodu

Tīrs kods

Šajā amatā mēs pievērsīsim uzmanību kodēšanas stilam. Kodu var rakstīt daudzos veidos, taču ir tikai daži, kas tiek uzskatīti par profesionāļiem.

Izšķiroša nozīme ir kodēšanas stila noteikumu ievērošanai. Kad jūs attīstīsit programmēšanu ne tikai SQL, bet arī jebkurā valodā, jūs nekad nedarbosities pats. Jūs vienmēr strādāsit komandā. Pat ja esat brīvmākslinieks, kurš strādā tiešsaistē, vienmēr atradīsies kāds, kurš kādā brīdī nolasīs jūsu kodu. Tad jūs uzzināsit, ka ir viens jēdziens, kas jums netraucēs - tīrā koda jēdziens.

Tīrais kods ir kods, kas ir fokusēts un saprotams, kas nozīmē, ka tam jābūt lasāmam, loģiskam un maināmam. Atcerieties - labs kods nav tas, ko saprot datori; tas ir tas, ko cilvēki var saprast.

Bieži vien programmu var izveidot daudzos veidos, un kodu kopumā var organizēt vairākos veidos. Laba prakse nozīmē, ka jūs izvēlēsities versiju, kuru lasīt un saprast būs visvieglāk, un tā būs tā, kas netraucēs jūsu kolēģus to atjaunināt, kad tas būs nepieciešams. Viņi, iespējams, strādās pie jūsu koda, tāpēc vislabāk, ja viņi nezaudē laiku, izdomājot idejas zem sarežģītām koda rindām. Tāpēc tiek pieņemts, ka savā darba vietā jūs vienmēr ierakstīsit kodu tīri - pēc iespējas vienkāršāk, perfekti organizēti, saglabājot vienmērīgu loģisko plūsmu.

Labs stils

Tagad koncentrēsimies uz citu kodēšanas aspektu labā stilā. Piešķirot nosaukumus mainīgajiem vai SQL objektiem, vienmēr izvēlieties īsākus, jēgpilnus nosaukumus, nododot specifisku informāciju. Ar “nozīmīgu” mēs domājam vārdus, kuri ir izrunājami, ja katram jēdzienam ir izvēlēts viens vārds. Piemēram, tas ir iemesls, kāpēc tabulā “Pārdošana” izvēlējāmies “pirkuma numuru”, nevis “klienta pirkuma unikālo numuru”.

Šajā kontā jums nav jāsteidzas izvēlēties nosaukumus, jo tiem ir jāatspoguļo pēc iespējas vairāk objekta funkcionalitātes. Vārdi veidos vairāk nekā 80% no jūsu koda, tāpēc ir svarīgi, ar kuriem strādājat!

Bieži tiek diskutēts, vai kodējot ir jāizmanto lielie vai mazie burti. Patiesība ir - tas ir atkarīgs no jūsu stila vai no tā uzņēmuma stila, kurā strādājat. Visbiežāk profesionāļi izmanto SQL atslēgvārdus ar lielajiem burtiem un rakstīs objektu nosaukumus atšķirīgā veidā.

Ja nosaukumā ir vairāk nekā viens vārds, piemēram, “pirkuma numurs”, vārdi parasti tiek vai nu atdalīti ar pasvītrojumu, vai arī pievienoti viens otram, un katrs vārds sākas ar lielo burtu. Abas pieejas ir sastopamas profesionālajā kodēšanā. Tomēr viena lieta ir pārliecināta - starp vārdiem nevar atstāt tukšu vietu. Ja mēģināt to izdarīt, MySQL parādīs kļūdas ziņojumu.

Kodu lasāmība

Trešais aspekts, uz kuru mēs pievērsīsimies šajā amatā, ir jūsu koda lasāmība. No vienas puses, tas attiecas uz koda horizontālo un vertikālo organizāciju, no otras puses, uz krāsu, ar kādu tiek parādīti vārdi.

Tehniski jebkuru SQL vaicājumu var uzrakstīt vienā rindā. Tomēr daudzi jautājumi ir pārāk ilgi, un, ja mēs to darīsim, būs grūti lasīt. Šādos gadījumos ir jāorganizē kods ne tikai horizontāli, bet arī vertikāli.

Atkarībā no to nozīmes vaicājumā un no tā, kā mēs vēlamies tos lasīt, vārdus var rakstīt dažādās krāsās. SQL atslēgvārdi ir uzrakstīti zilā krāsā, objektu nosaukumi ir melni, cipari ir oranži utt.

Uzturiet savu kodu

Kad mēs virzāmies tālāk uz pastu, jūs uzraudzīsit raksta koda nevainojamu organizēšanu. Pagaidām atcerieties, ka ir trīs galvenie veidi, kā labi uzturēt kodu:

1. Speciālisti izmanto ad-hoc programmatūru, kas konsekventi pārkārto kodu un krāso dažādus vārdus. Dinamiskākā kodēšanas vidē laiks būs faktors, un kodēšanas stila apvienošana būs galvenā prioritāte. Nav iespējams, lai jūsu uzņēmumā būtu 50 programmētāji, visi raksta vienā stilā. Ir neprofesionāli apvienot kodu, kas uzrakstīts tajā pašā valodā, bet citā stilā. Tātad, pabeidzot, darba koda gabali tiek pārbaudīti, izmantojot šādu programmatūru, un jūsu priekšniekam būs kodu kaudze, kas visi būs uzrakstīti vienā stilā.

2. Izmantojiet atbilstošo analogo rīku, kas sniegts Workbench. Šī mazā suka izdaiļo jūsu kodu. Īsinājumtaustiņu kombinācija, lai piemērotu šo funkciju vaicājumam, kurā atrodas kursors, ir Ctrl un B. Vai redzat? Satriecošs!

3. Ja vēlaties tīrīt kodu savādāk, jums vajadzētu iejaukties manuāli un pielāgot to, kā vēlaties.

Vingrinājums

Šajā vienkāršajā rindiņā mēs izveidosim testa tabulu ar divām kolonnām - “Cipari” un “Vārdi”.

Kodu esam uzrakstījuši vienā rindiņā ar maziem burtiem. Ievērojiet, kā MySQL mainīja atslēgvārdu, datu tipu un numuru krāsu. Tagad mēs nenodarbosimies ar ad-hoc programmatūru, jo mēs koncentrējamies uz Workbench. Kad kursors ir novietots kaut kur šajā vaicājumā, varat nospiest mazās sukas ikonu, lai formatētu skriptu. Lai to pašu darbību veiktu ātrāk, atcerieties Ctrl un B saīsni.

Oho! Tas strādāja.

Atslēgas vārdi ir drukāti ar lielajiem burtiem, un dati par katru tabulas kolonnu sākas ar jaunu rindu. Lieliski!

Atkāpes stils

Iedomājieties, ka jums ir vēl viena priekšrocība attiecībā uz šī koda horizontālo organizāciju un visu datu tipu izlīdzināšanu. Izmantojot tastatūras taustiņu cilni, varat iestatīt, lai INT un VARCHAR sāktu vienā un tajā pašā horizontālajā punktā. Pēc dažu lietotāju domām, šis triks vēl vairāk uzlabo koda lasāmību.

Tehnisko terminu sauc par ievilkumu. Mēs sakām, ka kolonnu nosaukumi un to datu tipi tika iegriezti labajā pusē.

Komentāri

Vēl viens laba kodēšanas stila uzturēšanas aspekts ir komentāru izmantošana. Šīs ir teksta rindiņas, kuras Workbench nedarbos kā kodu; viņi nodod ziņojumu kādam, kurš lasa mūsu kodu. Tehniski MySQL varat sākt komentāru, ierakstot priekšu slīpsvītra un zvaigzne, un abpusēji aizvērt to ar zvaigznīti un priekšu slīpsvītru. Šo pieeju galvenokārt izmanto lieliem komentāriem.
Komentāriem vienā rindā varat izmantot divas svītras vai vienu vai vairākas jaucējzīmes. Turklāt, lai atšķirtu tos no vienkārša koda, MySQL Workbench atzīmē visus komentārus pelēkā krāsā.

Fantastiski!

Izpildes kods

Visbeidzot es vēlētos izstrādāt zibens simbolu, kas palīdz izpildīt jūsu kodu.

Sāksim ar faktu, ka jūsu kods ir sadalīts blokos, ko apzīmē ar semikolu atdalītājs. Labi.

Tātad, ja jūs novietosit kursoru uz viena bloka un pēc tam nospiedīsit zibens ikonu vai taustiņu kombināciju Ctrl, Shift, Enter, SQL izpildīs atlasītos un visus atlikušos vaicājumus.

Tāpēc, ja es noklikšķināšu uz FROM un izpildītu kodu šādā veidā, es redzētu izrakstu SELECT un izmestu testa tabulu.

Ja jūs vēlaties palaist tikai paziņojumu zem kursora, jums jānospiež blakus esošajai ikonai, kur ir attēlots zibens un kursors. Atbilstošā tastatūras kombinācija ir Ctrl un Enter.

Es varu apsolīt, ka jūs nepārstāsit izmantot šo tastatūras kombināciju, jo tas ļauj ātri redzēt noteikta vaicājuma izvadi, neizlaižot visu SQL kodu.

Nu… es ceru, ka jums patika šī ziņa! Tā mērķis bija padarīt jūs saprotamāku par tīras kodēšanas un laba stila kodēšanas jēdzienu. Mēs uzskatām, ka šie rīki ir nepieciešami labai profesionālai kodēšanai, tāpēc mēs būtu priecīgi, ja jūtat, ka esat sācis veidot labus kodēšanas stila paradumus.