SQL geriausios praktikos pavyzdžiai - kaip švariai ir puikiai sutvarkyti kodą

Švarus kodas

Šiame įraše atkreipsime dėmesį į kodavimo stilių. Kodą galite rašyti įvairiais būdais, tačiau profesionalu laikomas tik keletas.

Labai svarbu laikytis kodavimo stiliaus taisyklių. Kai žengsite į priekį programuodami ne tik SQL, bet ir bet kuria kalba, niekada nedirbsite savarankiškai. Jūs visada dirbsite komandoje. Net jei esate laisvai samdomas vertėjas, dirbantis internete, visada bus kažkas, kuris kada nors perskaitys jūsų kodą. Tada sužinosite, kad yra viena mintis, kuri jums nepadarys pertraukos, - švaraus kodo sąvoka.

Nešvarus kodas yra sutelktas ir suprantamas kodas, tai reiškia, kad jis turi būti lengvai skaitomas, logiškas ir keičiamas. Atminkite - geras kodas nėra tas, kurį supranta kompiuteriai; tai žmogus gali suprasti.

Dažnai programa gali būti kuriama įvairiais būdais, o kodas paprastai gali būti organizuojamas keliais būdais. Geroji praktika reiškia, kad pasirinksite versiją, kuri bus lengviausiai skaitoma ir suprantama, ir bus tokia, kuri netrukdo kolegoms ją atnaujinti, kai to reikia. Jie greičiausiai dirbs prie jūsų kodo, todėl geriausia, jei jie nepraranda laiko idėjoms kurti pagal sudėtingas kodo eilutes. Štai kodėl daroma prielaida, kad savo darbo vietoje visada rašysite kodą švariai - kiek įmanoma paprasčiau, puikiai organizuodami ir išlaikydami pastovų loginį srautą.

Geras stilius

Dabar susitelkime į kitą gero stiliaus kodavimo aspektą. Priskirdami vardus kintamiesiems ar SQL objektams, visada rinkitės trumpesnius, reikšmingus pavadinimus, perteikdami konkrečią informaciją. Turėdami omenyje „reikšmingą“, mes turime omenyje tariamus vardus, kai kiekvienai sąvokai buvo pasirinktas vienas žodis. Pavyzdžiui, dėl šios priežasties lentelėje „Pardavimai“ pasirinkome „pirkimo numerį“, o ne „kliento įsigytą unikalų numerį“.

Šioje paskyroje jums nereikia skubėti pasirinkti vardus, nes jie turi atspindėti kuo daugiau objekto funkcijų. Vardai sudarys daugiau nei 80% jūsų kodo, todėl svarbu, su kuriais dirbate!

Dažnai diskutuojama, ar koduojant reikia naudoti didžiąsias ar mažąsias raides. Tiesa yra - tai priklauso nuo jūsų stiliaus ar nuo įmonės, kurioje dirbate, stiliaus. Dažniausiai specialistai SQL raktinius žodžius rašys didžiosiomis raidėmis ir objektų pavadinimus rašys kitaip.

Kai pavadinimą sudaro daugiau nei vienas žodis, pvz., „Pirkimo numeris“, žodžiai paprastai atskiriami apatinėmis brūkšniais arba pridedami vienas prie kito, o kiekvienas žodis prasideda didžiąja raide. Abu būdai susiduria su profesionaliu kodavimu. Vis dėlto vienas dalykas yra tikras - tarp žodžių negalima palikti tuščios vietos. Jei bandysite tai padaryti, „MySQL“ parodys klaidos pranešimą.

Kodo skaitomumas

Trečias aspektas, į kurį daugiausia dėmesio skirsime šiame įraše, yra jūsų kodo skaitomumas. Viena vertus, tai susiję su horizontaliu ir vertikaliu kodo organizavimu, kita vertus, su spalva, kuria rodomi žodžiai.

Techniškai bet kokia SQL užklausa gali būti parašyta vienoje eilutėje. Tačiau daugelis užklausų yra per ilgi ir bus sunkiai skaitomi, jei mes tai padarysime. Tokiais atvejais reikia sutvarkyti kodą ne tik horizontaliai, bet ir vertikaliai.

Atsižvelgiant į jų reikšmę užklausoje ir tai, kaip norime juos perskaityti, žodžiai gali būti rašomi skirtingomis spalvomis. SQL raktiniai žodžiai parašyti mėlynai, objektų pavadinimai - juodai, skaičiai - oranžinėmis ir tt.

Palaikykite savo kodą

Toliau eidami į paštą pastebėsite nepriekaištingą jūsų parašyto kodo organizavimą. Kol kas atminkite, kad yra trys pagrindiniai būdai, kaip gerai išlaikyti savo kodą:

1. Profesionalai naudoja ad-hoc programinę įrangą, kuri nuosekliai tvarko kodą ir spalvina skirtingus žodžius. Dinamiškesnėje kodavimo aplinkoje laikas bus veiksnys, o kodavimo stiliaus suvienodinimas bus svarbiausias prioritetas. Neįmanoma, kad jūsų įmonėje būtų 50 programuotojų, visi rašo tuo pačiu stiliumi. Neprofesionalu sujungti kodus, parašytus ta pačia kalba, bet kitokiu stiliumi. Taigi, pabaigę darbinį kodą, patikrinsite tokią programinę įrangą, o jūsų viršininkas turės daugybę kodų, parašytų tuo pačiu stiliumi.

2. Naudokite atitinkamą analogišką įrankį, pateiktą „Workbench“. Šis mažas šepetėlis pagražina jūsų kodą. Spartusis klavišų derinys, skirtas naudoti šią funkciją užklausai, kur yra žymeklis, yra Ctrl ir B. Matote? Nuostabu!

3. Jei norite valyti savo kodą kitaip, turėtumėte įsikišti rankiniu būdu ir sureguliuoti jį taip, kaip jums patinka.

Pratimas

Šioje paprastoje eilutėje sukursime bandymų lentelę su dviem stulpeliais - „Skaičiai“ ir „Žodžiai“.

Kodas yra užrašytas vienoje eilutėje mažomis raidėmis. Atkreipkite dėmesį, kaip „MySQL“ pakeitė raktinių žodžių, duomenų tipų ir skaičių spalvą. Dabar mes nenagrinėsime ad-hoc programinės įrangos, nes mes daugiausia dėmesio skiriame „Workbench“. Įvedę žymeklį kur nors šioje užklausoje, galite paspausti mažą teptuko piktogramą, kad formatuotumėte scenarijų. Norėdami atlikti tą pačią operaciją greičiau, atsiminkite „Ctrl“ ir „B“ klavišus.

Oho! Pavyko.

Raktažodžiai rašomi didžiosiomis raidėmis, o kiekvieno lentelės stulpelio duomenys prasideda naujoje eilutėje. Puiku!

Įtraukimo stilius

Įsivaizduokite, kad turite daugiau pirmenybės horizontaliam šio kodo organizavimui ir visų duomenų tipų suderinimui. Naudodamiesi klaviatūros skirtuko mygtuku, galite nustatyti, kad INT ir VARCHAR prasidėtų tame pačiame horizontaliame taške. Kai kurių vartotojų teigimu, šis triukas dar labiau pagerina kodo skaitomumą.

Techninis terminas vadinamas įtrauka. Mes sakome, kad stulpelių pavadinimai ir jų duomenų tipai buvo įbrėžti į dešinę.

Komentarai

Kitas gero kodavimo stiliaus palaikymo aspektas yra komentarų naudojimas. Tai yra teksto eilutės, kurių „Workbench“ neveiks kaip kodo; jie perduoda žinutę tam, kuris skaito mūsų kodą. Techniškai „MySQL“ galite pradėti komentarą įvesdami brūkšnį į priekį ir žvaigždę ir uždarydami jį abipusiškai naudodami žvaigždę ir priekinę brūkšnį. Šis požiūris dažniausiai naudojamas didelėms pastaboms.
Vienos eilutės komentarams galite naudoti du brūkšnelius arba vieną ar kelis maišos ženklus. Be to, norėdamas atskirti juos nuo paprasto kodo, „MySQL Workbench“ visus komentarus žymi pilka spalva.

Fantastinis!

Vykdyti kodą

Galiausiai norėčiau patobulinti žaibo simbolį, kuris padeda vykdyti kodą.

Pradėkime nuo to, kad jūsų kodas yra padalintas į blokus, kaip pažymėta kabliataškio skirtuku. Gerai.

Taigi, jei sudedate žymeklį ant vieno bloko ir paspausite žaibo piktogramą arba „Ctrl“, „Shift“, „Enter“ derinį, „SQL“ vykdys pasirinktas ir visas likusias užklausas.

Štai kodėl, spustelėjęs FROM ir atlikdamas kodą tokiu būdu, pamatysiu išvestį iš SELECT sakinio ir nustosiu bandymo lentelę.

Jei norėtumėte paleisti tik teiginį po žymekliu, turite paspausti gretimą piktogramą, kur pavaizduotas žaibas ir žymeklis. Atitinkama klaviatūros kombinacija yra „Ctrl“ ir „Enter“.

Galiu pažadėti, kad nenustosite naudoti šios klaviatūros kombinacijos, nes tai leidžia greitai pamatyti tam tikros užklausos išvestį, nereikia paleisti viso SQL kodo.

Na ... tikiuosi, kad jums patiko šis įrašas! Ja buvo siekiama supažindinti jus su švaraus kodavimo ir gero stiliaus kodavimu. Mes manome, kad šios priemonės yra būtinos siekiant gero profesionalaus kodavimo, todėl būtume laimingi, jei suprastumėte, kad pradėjote formuoti gerus kodavimo stiliaus įpročius.