SQL Best Practices - Kako upisati kôd čisto i savršeno organizirano

Čisti kod

U ovom postu obratit ćemo pažnju na stil kodiranja. Postoji mnogo načina na koje možete napisati svoj kôd, ali postoji samo nekoliko koji se smatraju profesionalnim.

Ključno je poštivanje pravila stila kodiranja. Kada napredujete u programiranju, ne samo u SQL-u, već i na bilo kojem jeziku, nikada nećete raditi sami. Uvijek ćete raditi u timu. Čak i ako ste freelancer koji radi na mreži, uvijek će netko pronaći vaš kôd. Tada ćete saznati da postoji jedan pojam koji vam neće popustiti - pojam čistog koda.

Clean code je kod koji je fokusiran i razumljiv, što znači da mora biti čitljiv, logičan i promjenjiv. Zapamtite - dobar kod nije onaj koji računala razumiju; to je onaj koji ljudi mogu razumjeti.

Program se često može stvoriti na više načina, a kod se, uglavnom, može organizirati na više načina. Dobra praksa podrazumijeva da ćete odabrati verziju koja će se najlakše pročitati i razumjeti i bit će ona koja ne koči vaše kolege da je ažuriraju kada je to potrebno. Oni će vjerojatno funkcionirati iznad vašeg koda, tako da je najbolje ako ne izgube vrijeme na pronalaženju ideja ispod složenih linija koda. Zato je pretpostavka da ćete na svom radnom mjestu uvijek unositi kôd čisto - što jednostavnije, savršeno organizirano, održavajući stalni logički tijek.

Dobar stil

Sada se usredotočimo na drugi aspekt kodiranja u dobrom stilu. Kad dodijelite imena varijablama ili SQL objektima, uvijek odaberite kraća, smislenija imena, prenoseći određene informacije. Pod "značajnim" podrazumijevamo imena koja se mogu izgovoriti, a koja je odabrana jedna riječ po konceptu. Na primjer, to je razlog što smo u tablici „Prodaja“ odabrali „broj kupnje“, a ne „jedinstveni broj kupnje kupca“.

Na tom računu ne morate žuriti s odabirom imena jer moraju odražavati što veći dio funkcionalnosti objekta. Imena će činiti više od 80% vašeg koda, tako da je važno s kojima radite!

Često se raspravlja o tome moraju li se kodirati velika i mala slova. Istina je - to ovisi o vašem stilu ili o stilu tvrtke u kojoj radite. Profesionalci će najčešće upotrebljavati velika slova u SQL ključnim riječima te će imena objekata pisati na drugačiji način.

Kada naziv sadrži više od jedne riječi, kao što je "broj za kupnju", riječi su obično ili odvojene podvlakom ili međusobno povezane, a svaka riječ započinje velikim slovom. U profesionalnom se kodiranju susreću oba pristupa. Jedno je sigurno, međutim, ne možete ostaviti prazan prostor između riječi. Ako to pokušate, MySQL će prikazati poruku pogreške.

Čitljivost koda

Treće lice na koje ćemo se fokusirati u ovom postu je čitljivost vašeg koda. S jedne strane, ovo se odnosi na horizontalnu i vertikalnu organizaciju koda, s druge, na boju kojom se prikazuju riječi.

Tehnički se bilo koji SQL upit može napisati u jednom retku. Međutim, mnogi su upiti predugi te će ih biti teško pročitati ako to učinimo. Ono što u takvim slučajevima treba učiniti jest organizirati kôd, ne samo vodoravno, već i okomito.

Ovisno o njihovom značenju u upitu i o načinu na koji želimo da ih se pročita, riječi se mogu pisati različitim bojama. SQL ključne riječi su napisane plavom bojom, imena objekata u crnoj boji, brojevi u narančastoj itd.

Održavajte svoj kôd

Kako krećemo dalje u postu, razvit ćete pažnju za besprijekornom organizacijom koda koji pišete. Za sada zapamtite da postoje tri glavna načina za dobro održavanje koda:

1. Profesionalci koriste ad-hoc softver koji redovno organizira kôd i boje različite riječi dosljedno. U dinamičnijem okruženju kodiranja vrijeme će biti faktor, a objedinjavanje stila kodiranja bit će glavni prioritet. Nemoguće je imati 50 programera u vašoj tvrtki, a svi pišu u istom stilu. Spajanje koda napisanog na istom jeziku, ali u različitom stilu, neprofesionalno je. Dakle, kad su gotovi, dijelovi radnog koda prolaze provjeru takvog softvera, a vaš će šef imati hrpu koda sve napisano istim stilom.

2. Koristite odgovarajući analogni alat koji se nalazi u Workbench-u. Ova mala četkica uljepšava vaš kod. Kombinacija tipki prečaca za primjenu ove funkcije na upit gdje se nalazi vaš pokazivač su Ctrl i B. Vidite? Super!

3. Ako biste željeli svoj kist očistiti drugačije, intervenirajte ručno i prilagodite ga kako želite.

Vježba

U ovom ćemo jednostavnom retku stvoriti ispitnu tablicu s dva stupca - "Brojevi" i "Riječi".

Kôd smo napisali u jednom retku malim slovima. Uočite kako je MySQL promijenio boju ključnih riječi, vrsta podataka i brojeva. Sada se nećemo baviti ad-hoc softverom, jer se fokusiramo na Workbench. Nakon što postavite pokazivač negdje na ovaj upit, možete pritisnuti malu ikonu četke da biste preoblikovali skriptu. Da biste istu operaciju izveli brže, sjetite se prečaca Ctrl i B.

Wow! Upalilo je.

Ključne riječi su velikim slovima, a podaci za svaki stupac tablice počinju u novom retku. Sjajno!

Stil udubljenja

Zamislite da imate daljnju sklonost u pogledu horizontalne organizacije ovog koda i usklađivanja svih vrsta podataka. Pomoću gumba s kartice na tipkovnici možete postaviti INT i VARCHAR da počinju u istoj vodoravnoj točki. Prema nekim korisnicima, ovaj trik dodatno poboljšava čitljivost koda.

Tehnički se naziv naziva uvlačenje. Kažemo da su nazivi stupaca i njihove vrste podataka bili razvedeni s desne strane.

komentari

Drugi aspekt održavanja dobrog stila kodiranja je uporaba komentara. Ovo su redovi teksta koji Workbench neće pokrenuti kao kod; oni prenose poruku nekome tko čita naš kod. Tehnički gledano, u MySQL-u možete započeti komentar upisivanjem kosog naprijed i zvijezde i recipročno zatvoriti ga sa zvijezdom i naprijed. Ovaj se pristup uglavnom koristi za velike komentare.
Za komentare u jednom redu možete upotrijebiti dvije crtice ili jedan ili više hash znakova. Pored toga, kako bi ih razlikovao od pukog koda, MySQL Workbench sve komentare označava sivom bojom.

Fantastičan!

Izvršite kod

Na kraju, želio bih razraditi simbol munje koji vam pomaže u izvršavanju koda.

Počnimo od činjenice da je vaš kôd odvojen u blokove, kako ih je označio separatorom zarezne točke. U redu.

Dakle, ako postavite pokazivač na jedan blok, a zatim pritisnete ikonu munje ili kombinaciju Ctrl, Shift, Enter, SQL će pokrenuti odabrane i sve preostale upite.

Zato ću, ako kliknem OD i izvrši kôd na ovaj način, vidjeti izlaz iz naredbe SELECT i ispustiti ispitnu tablicu.

Ako želite pokrenuti samo izjavu ispod kursora, morate pritisnuti susjednu ikonu na kojoj su prikazani munje i pokazivač. Odgovarajuća kombinacija tipkovnice je Ctrl i Enter.

Mogu vam obećati da nećete prestati koristiti ovu kombinaciju tipkovnica, jer vam omogućava da brzo vidite rezultate određenog upita, bez potrebe za pokretanjem čitavog SQL koda.

Pa ... nadam se da vam se svidio ovaj post! Bilo je usmjereno na upoznavanje s pojmom čistog kodiranja i kodiranja u dobrom stilu. Smatramo da su ovi alati ključni za dobro profesionalno kodiranje, tako da ćemo biti sretni ako osjetite da ste počeli graditi dobre navike stila kodiranja.