SQL Best Practices - Ako čisto a dokonale zorganizovať kód

Čistý kód

V tomto príspevku budeme venovať pozornosť štýlu kódovania. Existuje mnoho spôsobov, ako môžete napísať svoj kód, ale existuje len málo profesionálov.

Dodržiavanie pravidiel štýlu kódovania je rozhodujúce. Keď postupujete v programovaní, nielen v SQL, ale v akomkoľvek jazyku, nikdy nebudete pracovať sami. Vždy budete pracovať v tíme. Aj keď ste na voľnej nohe a pracujete online, vždy bude niekto, kto si v určitom okamihu prečíta váš kód. Potom zistíte, že existuje jeden pojem, ktorý vám nedá prestávku - pojem čistého kódu.

Čistý kód je kód, ktorý je zameraný a zrozumiteľný, čo znamená, že musí byť čitateľný, logický a meniteľný. Pamätajte - dobrý kód nie je ten, ktorému počítače rozumejú; je to človek, ktorému rozumejú.

Program sa často dá vytvoriť mnohými spôsobmi a kód sa všeobecne dá usporiadať niekoľkými spôsobmi. Osvedčený postup znamená, že si vyberiete verziu, ktorá bude najjednoduchšie čitateľná a zrozumiteľnejšia a ktorá bude brániť vašim kolegom v jej aktualizácii, keď to bude potrebné. Pravdepodobne budú fungovať nad vaším kódom, takže je najlepšie, ak nestratia čas vymýšľaním nápadov pod zložitými riadkami kódu. Preto sa vychádza z toho, že na vašom pracovisku vždy budete písať kód čisto - čo najjednoduchšie, dokonale zorganizovaný a udržiavate stály logický tok.

Dobrý štýl

Teraz sa zamerajme na iný aspekt kódovania v dobrom štýle. Pri prideľovaní názvov premenným alebo objektom SQL vždy zvoľte kratšie zmysluplné názvy, ktoré sprostredkujú konkrétne informácie. Výrazom „zmysluplný“ sa myslia mená, ktoré sú vysloviteľné, ak bolo vybraté jedno slovo pre každý koncept. Preto sme napríklad v tabuľke „Predaj“ vybrali „nákupné číslo“, nie „jedinečné nákupné číslo zákazníka“.

Z tohto dôvodu sa nemusíte ponáhľať s výberom mien, pretože musia odrážať čo najviac funkcií objektu. Mená budú tvoriť viac ako 80% vášho kódu, takže záleží na tom, s ktorými z nich pracujete!

Často sa diskutuje, či sa pri kódovaní musia používať veľké alebo malé písmená. Pravda je - záleží to na vašom štýle alebo na štýle spoločnosti, pre ktorú pracujete. Profesionáli najčastejšie kapitalizujú kľúčové slová SQL a budú písať názvy objektov iným spôsobom.

Ak meno obsahuje viac ako jedno slovo, napríklad „nákupné číslo“, slová sa zvyčajne buď oddelia podčiarknutím, alebo sa spoja, a každé slovo sa začína veľkým písmenom. Pri profesionálnom kódovaní sa s oboma prístupmi stretávame. Jedno je však isté - medzi slovami nemôžete nechať medzeru. MySQL zobrazí chybové hlásenie, ak sa pokúsite urobiť.

Čitateľnosť kódu

Tretím aspektom, na ktorý sa v tomto príspevku zameriame, je čitateľnosť kódu. Na jednej strane ide o horizontálnu a vertikálnu organizáciu kódu, na druhej strane o farbu, v ktorej sa slová zobrazujú.

Technicky môže byť akýkoľvek dotaz SQL napísaný na jeden riadok. Mnohé otázky sú však príliš dlhé a ak to urobíme, bude ťažké ich prečítať. V takýchto prípadoch je potrebné zorganizovať kód, a to nielen horizontálne, ale aj vertikálne.

V závislosti od ich významu v dotaze a od spôsobu, akým chceme, aby sa čítali, slová sa môžu písať rôznymi farbami. Kľúčové slová SQL sú napísané modrou farbou, názvy objektov čiernou farbou, čísla oranžovou farbou atď.

Zachovanie kódu

Pri postupovaní poštou si vytvoríte oko pre dokonalú organizáciu napísaného kódu. Zatiaľ si pamätajte, že existujú tri hlavné spôsoby, ako kód dobre udržiavať:

1. Profesionáli používajú softvér ad hoc, ktorý dôsledne reorganizuje kód a farby rôznych slov. V dynamickejšom prostredí kódovania bude faktorom faktor času a najvyššou prioritou bude zjednotenie štýlu kódovania. Vo vašej spoločnosti nie je možné mať 50 programátorov, ktorí píšu rovnakým spôsobom. Zlučovanie kódu napísaného v rovnakom jazyku, ale v inom štýle, je neprofesionálne. Po dokončení teda časti pracovného kódu prechádzajú kontrolou takého softvéru a váš šéf bude mať hromadu kódu napísanú rovnakým spôsobom.

2. Použite príslušný analogický nástroj, ktorý sa dodáva v pracovnom stole. Tento malý štetec skrášľuje váš kód. Kombinácia klávesových skratiek na použitie tejto funkcie v dotaze, kde sa nachádza kurzor, je Ctrl a B. Vidíte? Úžasné!

3. Ak by ste radšej kód čistili inak, mali by ste zasiahnuť ručne a podľa potreby ho upraviť.

cvičenie

V tomto jednoduchom riadku vytvoríme skúšobnú tabuľku s dvoma stĺpcami - „Čísla“ a „Slová“.

Kód sme napísali na jeden riadok malými písmenami. Všimnite si, ako MySQL zmenila farbu kľúčových slov, typov údajov a čísel. Teraz sa nebudeme zaoberať softvérom ad-hoc, pretože sa zameriavame na Workbench. Po umiestnení kurzora niekde v tomto dotaze môžete stlačením malej ikony štetca preformátovať skript. Ak chcete vykonať rovnakú operáciu rýchlejšie, nezabudnite na skratky Ctrl a B.

Wow! Fungovalo to.

Kľúčové slová sú napísané veľkými písmenami a údaje pre každý stĺpec tabuľky začínajú na novom riadku. Skvelé!

Štýl odsadenia

Predstavte si, že máte ďalšie preferencie týkajúce sa horizontálnej organizácie tohto kódu a zarovnania všetkých typov údajov. Pomocou tlačidla Tab na klávesnici môžete nastaviť INT a VARCHAR tak, aby začínali v rovnakom horizontálnom bode. Podľa niektorých používateľov tento trik ďalej zlepšuje čitateľnosť kódu.

Technický termín sa nazýva odsadenie. Hovoríme, že názvy stĺpcov a ich typy údajov boli odsadené doprava.

Komentáre

Ďalším aspektom udržiavania dobrého štýlu kódovania je použitie komentárov. Toto sú riadky textu, ktoré Workbench nebude fungovať ako kód; sprostredkujú správu niekomu, kto číta náš kód. Technicky v MySQL môžete začať písať napísaním lomky a hviezdy a recipročne ju uzavrieť hviezdičkou a lomkou. Tento prístup sa používa hlavne na veľké komentáre.
Pre jednoriadkové komentáre môžete použiť buď dve pomlčky alebo jedno alebo viac značiek hash. Na ich odlíšenie od obyčajného kódu MySQL Workbench označí všetky komentáre sivou farbou.

Fantastické!

Vykonajte kód

Nakoniec by som chcel rozpracovať symbol blesku, ktorý vám pomôže spustiť váš kód.

Začnime tým, že váš kód je rozdelený do blokov, ako je vyznačené bodkočiarkou. Ok.

Ak umiestnite kurzor na jeden blok a potom stlačte ikonu blesku alebo kombináciu klávesov Ctrl, Shift, Enter, SQL spustí vybraté a všetky zostávajúce otázky.

Z tohto dôvodu, ak kliknem na FROM a vykonám kód týmto spôsobom, uvidím výstup z príkazu SELECT a zruším testovaciu tabuľku.

Ak chcete spustiť iba príkaz pod kurzorom, musíte stlačiť susednú ikonu, na ktorej sú zobrazené blesky a kurzor. Zodpovedajúca kombinácia klávesov je Ctrl a Enter.

Môžem vám sľúbiť, že túto klávesovú kombináciu neprestanete používať, pretože umožňuje rýchlo zobraziť výstup určitého dotazu bez toho, aby ste museli spúšťať celý kód SQL.

No ... dúfam, že sa vám tento príspevok páčil! Jeho cieľom bolo upovedomiť vás o čistom kódovaní a kódovaní v dobrom štýle. Tieto nástroje považujeme za nevyhnutné pre dobré profesionálne kódovanie, preto by sme boli radi, keby ste cítili, že ste začali vytvárať dobré návyky v štýle kódovania.