SQL Best Practices - Jak čistě a dokonale uspořádat kód

Čistý kód

V tomto příspěvku budeme věnovat pozornost stylu kódování. Existuje mnoho způsobů, jak můžete napsat kód, ale existuje jen několik považovaných za profesionální.

Dodržování pravidel stylu kódování je zásadní. Když postupujete v programování, nejen v SQL, ale v jakémkoli jazyce, nikdy nebudete pracovat sami. Vždy budete pracovat v týmu. I když pracujete online na volné noze, vždy bude někdo, kdo si váš kód přečte. Pak zjistíte, že existuje jeden pojem, který vám nedá přestávku - pojem čistého kódu.

Čistý kód je kód, který je zaměřen a srozumitelný, což znamená, že musí být čitelný, logický a měnitelný. Pamatujte - dobrý kód není ten, kterému počítače rozumějí; je to člověk, kterému rozumějí.

Program lze často vytvořit mnoha způsoby a kód obecně lze uspořádat několika způsoby. Osvědčený postup znamená, že si vyberete verzi, která bude nejjednodušší na čtení a porozumění, a bude ta, která nebrání vašim kolegům v její aktualizaci v případě potřeby. Pravděpodobně budou fungovat nad vaším kódem, takže je nejlepší, pokud neztrácejí čas vymýšlením nápadů pod složitými řádky kódu. To je důvod, proč se předpokládá, že na vašem pracovišti budete vždy psát kód čistě - co nejjednodušší, dokonale uspořádaný a udržet stabilní logický tok.

Dobrý styl

Nyní se zaměřme na jiný aspekt kódování v dobrém stylu. Při přiřazování jmen proměnným nebo objektům SQL vždy volte kratší, smysluplná jména a předávejte konkrétní informace. Pojem „smysluplný“ znamená jména, která jsou vyslovitelná, kde bylo vybráno jedno slovo na koncept. Například proto jsme v tabulce „Prodej“ vybrali „nákupní číslo“, nikoli „jedinečné nákupní číslo zákazníka“.

Z tohoto důvodu nemusíte být ve spěchu, abyste si mohli vybrat jména, protože musí odrážet co nejvíce funkcí objektu. Jména budou tvořit více než 80% vašeho kódu, takže záleží na tom, s nimiž pracujete!

Často se diskutuje, zda při kódování musí být použita velká nebo malá písmena. Pravda je - záleží na vašem stylu nebo na stylu společnosti, pro kterou pracujete. Nejčastěji profesionálové kapitalizují klíčová slova SQL a budou psát názvy objektů jiným způsobem.

Pokud název obsahuje více než jedno slovo, například „nákupní číslo“, slova se obvykle buď oddělí podtržítkem, nebo se k sobě připojí, a každé slovo začíná velkým písmenem. Oba přístupy se setkávají v profesionálním kódování. Jedna věc je však jistá - mezi slovy nemůžete nechat mezeru. MySQL zobrazí chybovou zprávu, pokud se o to pokusíte.

Čitelnost kódu

Třetí aspekt, na který se v tomto příspěvku zaměříme, je čitelnost vašeho kódu. Na jedné straně se jedná o horizontální a vertikální uspořádání kódu, na druhé straně o barvu, se kterou se slova zobrazují.

Technicky lze libovolný dotaz SQL napsat na jeden řádek. Mnoho dotazů je však příliš dlouhé a bude obtížné si je přečíst, pokud to uděláme. V takových případech je třeba udělat kód, a to nejen horizontálně, ale také vertikálně.

V závislosti na jejich významu v dotazu a na způsobu, jakým chceme, aby byly čteny, lze slova psát v různých barvách. Klíčová slova SQL jsou psána modrou barvou, jména objektů černě, čísla oranžově atd.

Udržujte svůj kód

Jak postupujeme v příspěvku, vytvoříte si oko pro bezvadnou organizaci kódu, který píšete. Prozatím si pamatujte, že existují tři hlavní způsoby, jak udržovat kód dobře:

1. Profesionálové používají software ad-hoc, který důsledně reorganizuje kód a barvy různých slov. V dynamičtějším prostředí kódování bude faktorem faktor času a sjednocení stylu kódování bude nejvyšší prioritou. Je nemožné mít ve vaší společnosti 50 programátorů, všichni psaní stejným stylem. Sloučit kód psaný ve stejném jazyce, ale v jiném stylu, je neprofesionální. Po dokončení tedy kus pracovního kódu projde kontrolou takového softwaru a váš šéf bude mít hromadu kódu všeho psaného stejným stylem.

2. Použijte příslušný analogický nástroj dodávaný v Workbench. Tento malý štětec zkrášluje váš kód. Kombinace klávesových zkratek pro použití této funkce v dotazu, kde se nachází kurzor, je Ctrl a B. Vidíte? Skvělý!

3. Pokud chcete kód čistit jinak, měli byste zasáhnout ručně a upravit podle potřeby.

Cvičení

V tomto jednoduchém řádku vytvoříme testovací tabulku se dvěma sloupci - „Čísla“ a „Slova“.

Kód jsme napsali na jeden řádek malými písmeny. Všimněte si, jak MySQL změnila barvu klíčových slov, datových typů a čísel. Nyní se nebudeme zabývat ad-hoc softwarem, protože se zaměřujeme na Workbench. Poté, co umístíte kurzor někde do tohoto dotazu, můžete přeformátovat skript stisknutím malé ikony štětce. Chcete-li stejnou operaci provést rychleji, nezapomeňte na zkratky Ctrl a B.

Wow! Fungovalo to.

Klíčová slova jsou psána velkými písmeny a data pro každý sloupec tabulky začínají na novém řádku. Skvělý!

Styl odsazení

Představte si, že máte další přednost, pokud jde o horizontální organizaci tohoto kódu a zarovnání všech typů dat. Pomocí tlačítka na kartě můžete nastavit INT a VARCHAR tak, aby začínaly ve stejném vodorovném bodě. Podle některých uživatelů tento trik dále zlepšuje čitelnost kódu.

Technický termín se nazývá odsazení. Říkáme, že názvy sloupců a jejich datové typy byly odsazeny doprava.

Komentáře

Dalším aspektem udržování dobrého stylu kódování je použití komentářů. Toto jsou řádky textu, které Workbench nebude fungovat jako kód; předávají zprávu někomu, kdo čte náš kód. Technicky lze v MySQL začít komentovat zadáním lomítka a hvězdy a recipročně je uzavřít hvězdou a lomítkem. Tento přístup se používá hlavně pro velké komentáře.
U jednolínkových komentářů můžete použít buď dvě pomlčky nebo jedno nebo více značek hash. Navíc je MySQL Workbench odlišuje od pouhého kódu šedě.

Fantastický!

Spusťte kód

Nakonec bych rád rozpracoval symbol blesku, který vám pomůže s provedením kódu.

Začněme tím, že váš kód je rozdělen do bloků, jak je označeno středníkem. OK.

Pokud tedy umístíte kurzor na jeden blok a poté stisknete ikonu blesku nebo kombinaci kláves Ctrl, Shift, Enter, SQL spustí vybrané a všechny zbývající dotazy.

Proto, když kliknu na FROM a provedu kód tímto způsobem, uvidím výstup z příkazu SELECT a zruší testovací tabulku.

Pokud chcete spustit pouze příkaz pod kurzorem, musíte stisknout sousední ikonu, kde je zobrazen blesk a kurzor. Odpovídající kombinace kláves je Ctrl a Enter.

Mohu vám slíbit, že nepřestanete používat tuto kombinaci kláves, protože umožňuje rychle zobrazit výstup určitého dotazu, aniž byste museli spouštět celý kód SQL.

No ... doufám, že se vám tento příspěvek líbil! Jeho cílem bylo upozornit vás na pojem čistého kódování a kódování v dobrém stylu. Tyto nástroje považujeme za nezbytné pro dobré profesionální kódování, takže bychom byli rádi, kdybyste cítili, že jste začali stavět dobré návyky ve stylu kódování.