Najboljše prakse SQL - Kako vtipkati kodo čisto in popolnoma organizirano

Čista koda

V tej objavi bomo pozorni na stil kodiranja. Obstaja več načinov, kako lahko napišete kodo, vendar obstaja le nekaj, ki velja za profesionalnega.

Upoštevanje pravil o slogu kodiranja je ključnega pomena. Ko napredujete v programiranju, ne samo v SQL, ampak v katerem koli jeziku, ne boste nikoli delali sami. Vedno boste delali v timu. Tudi če ste samostojni delavec na spletu, bo nekje nekdo prebral vašo kodo. Nato boste ugotovili, da obstaja en pojem, ki vas ne bo motil - pojem čiste kode.

Čista koda je koda, ki je osredotočena in razumljiva, kar pomeni, da mora biti berljiva, logična in spremenljiva. Ne pozabite - dobra koda ni tista, ki jo računalniki razumejo; človek lahko razume.

Pogosto je mogoče program ustvariti na več načinov, kodo pa je na splošno mogoče organizirati na več načinov. Dobra praksa pomeni, da boste izbrali različico, ki jo bo najlažje prebrati in razumeti in bo tisto, ki ne ovira vaših kolegov, da jo posodabljajo, kadar je to potrebno. Verjetno bodo delovali nad vašo kodo, zato je najbolje, če ne izgubijo časa za iskanje idej pod zapletenimi vrsticami kode. Zato je predpostavka, da boste na svojem delovnem mestu kodo vedno vnašali čisto - čim bolj preprosto, brezhibno organizirano in ohranjali enakomeren logični tok.

Dober slog

Zdaj se osredotočimo na drug vidik kodiranja v dobrem slogu. Pri dodeljevanju imen spremenljivkam ali objektom SQL vedno izberite krajša, smiselna imena, ki prenašajo določene informacije. S "pomenljivimi" mislimo na imena, ki jih je mogoče izgovoriti, pri čemer je izbrana ena beseda na koncept. Tako smo na primer v tabeli »Prodaja« izbrali »številko nakupa« in ne »edinstveno številko nakupa stranke«.

V tem računu vam ni treba hiteti z izbiro imen, saj morajo odražati čim več funkcionalnosti predmeta. Imena bodo predstavljala več kot 80% vaše kode, zato je pomembno, s katerimi delom sodelujete!

Pogosto se razpravlja, ali je pri kodiranju treba uporabiti velike ali male črke. Resnica je - odvisno je od vašega stila ali od sloga podjetja, v katerem delate. Najpogosteje bodo profesionalci izkoristili velike besede SQL in bodo imena predmetov zapisali na drugačen način.

Kadar ime vsebuje več besed, kot je "številka nakupa", so besede običajno ločene s podčrtajem ali pritrjene druga na drugo in vsaka beseda se začne z veliko začetnico. Pri profesionalnem kodiranju se srečujeta oba pristopa. Eno je vsekakor zagotovo - med besedami ne smete pustiti praznega prostora. Če poskusite to storiti, bo MySQL prikazal sporočilo o napaki.

Čitljivost kode

Tretja plat, na katero se bomo osredotočili v tej objavi, je berljivost vaše kode. Po eni strani to zadeva vodoravno in navpično organizacijo kode, na drugi pa barvo, s katero so besede prikazane.

Tehnično lahko vsako poizvedbo SQL zapišemo v eno vrstico. Vendar pa je veliko poizvedb predolgo in jih bomo težko brali, če to storimo. V takšnih primerih je treba kode organizirati, ne samo vodoravno, ampak tudi navpično.

Besede lahko zapišemo v različnih barvah, odvisno od njihovega pomena v poizvedbi in od načina, kako želimo, da jih berejo. Ključne besede SQL so napisane v modri barvi, imena predmetov v črni barvi, številke v oranžni ipd.

Vzdržujte svojo kodo

Ko bomo nadaljevali z objavo, boste razvili pozornost za brezhibno organizacijo kode, ki jo napišete. Za zdaj ne pozabite, da obstajajo trije glavni načini za dobro vzdrževanje kode:

1. Strokovnjaki uporabljajo ad-hoc programsko opremo, ki kodo in barvanje različnih besed dosledno reorganizira. V bolj dinamičnem okolju kodiranja bo čas pomemben čas, poenotenje sloga kodiranja pa bo glavna prednostna naloga. Nemogoče je imeti v vašem podjetju 50 programerjev, ki pišejo v istem slogu. Spajanje kode, napisane v istem jeziku, vendar v drugačnem slogu, je nestrokovno. Torej, ko je končan, bodo delovi kode preverjali takšno programsko opremo, vaš šef pa bo kupil kodo, vse napisano v istem slogu.

2. Uporabite ustrezno analogno orodje, ki je na voljo v Workbenchu. Ta mali čopič polepša vašo kodo. Kombinacija tipk za bližnjico za uporabo te funkcije pri poizvedbi, kjer se nahaja vaš kazalec, sta Ctrl in B. Ali vidite? Super!

3. Če želite kodo očistiti drugače, raje posežite ročno in jo prilagodite, kot želite.

Vaja

V tej preprosti vrstici bomo ustvarili testno tabelo z dvema stolpcema - "Številke" in "Besede".

Kodo smo napisali v eno vrstico z majhnimi črkami. Opazite, kako je MySQL spremenil barvo ključnih besed, vrst podatkov in številk. Zdaj se ne bomo ukvarjali s ad hoc programsko opremo, saj se osredotočamo na Workbench. Ko ste kazalec postavili nekje v to poizvedbo, lahko pritisnete ikono majhne ščetke, da spremenite skript. Če želite isto operacijo narediti hitreje, si zapomnite bližnjico Ctrl in B.

Vau! Delovalo je.

Ključne besede so napisane z velikimi tiskanimi črkami in podatki za vsak stolpec tabele se začnejo v novi vrstici. Super!

Stil vdolbine

Predstavljajte si, da imate dodatno prednost glede horizontalne organizacije te kode in poravnave vseh vrst podatkov. S tipko na zavihku lahko nastavite INT in VARCHAR, da se začneta na isti vodoravni točki. Po mnenju nekaterih uporabnikov ta trik še izboljšuje berljivost kode.

Tehnični izraz se imenuje vdolbina. Pravimo, da so bila imena stolpcev in njihove vrste podatkov z vdolbinami na desni.

Pripombe

Drug vidik ohranjanja dobrega načina kodiranja je uporaba komentarjev. To so vrstice besedila, ki jih Workbench ne bo izvajal kot koda; prenašajo sporočilo nekomu, ki bere našo kodo. Tehnično lahko v MySQL pričnete s komentarjem tako, da vnesete prednjo poševnico in zvezdo ter jo vzajemno zaprete z zvezdo in poševnico naprej. Ta pristop se uporablja predvsem za velike pripombe.
Za komentar z eno vrstico lahko uporabite dve črtici ali enega ali več znakov. Poleg tega MySQL Workbench za razlikovanje od zgolj kode označuje vse komentarje v sivi barvi.

Fantastično!

Izvedi kodo

Na koncu želim podrobneje predstaviti simbol strele, ki vam pomaga izvesti kodo.

Začnimo s tem, da je vaša koda ločena na bloke, ki jih označuje ločnik s podpičjem. V redu.

Če torej postavite kazalec na en blok in nato pritisnete ikono strele ali kombinacijo Ctrl, Shift, Enter, bo SQL izvedel izbrana in vsa preostala poizvedba.

Zato bom, če kliknem IZ in izvedem kodo na ta način, videl izhod iz stavka SELECT in spustil testno tabelo.

Če želite zagnati samo stavek pod kazalcem, morate pritisniti na sosednjo ikono, kjer sta prikazana strela in kazalec. Ustrezna kombinacija tipkovnice sta Ctrl in Enter.

Lahko obljubim, da ne boste prenehali uporabljati te kombinacije tipkovnic, saj vam omogoča, da hitro vidite izhod določene poizvedbe, ne da bi vam bilo treba zagnati celotno kodo SQL.

No ... upam, da vam je bila ta objava všeč! Njegov namen je bil seznaniti s pojmom čisto kodiranje in kodiranje v dobrem slogu. Menimo, da so ta orodja ključnega pomena za dobro profesionalno kodiranje, zato bomo veseli, če zaznate, da ste začeli graditi dobre navade v načinu kodiranja.