SQL Best Practices - Koodin kirjoittaminen siististi ja täydellisesti järjestettynä

Puhdas koodi

Tässä viestissä kiinnitämme huomiota koodaustapaan. Koodisi voi kirjoittaa monella tapaa, mutta ammattilaisena pidetään vain muutamaa.

Koodaustyylisääntöjen noudattaminen on erittäin tärkeää. Kun etenet ohjelmoinnissa, ei vain SQL: ssä, vaan millä tahansa kielellä, et koskaan työskentele omallasi. Työskentelet aina ryhmässä. Vaikka olet verkossa työskentelevä freelancer, aina löytyy joku, joka lukee koodisi jossain vaiheessa. Sitten saat selville, että on olemassa yksi käsite, joka ei anna sinulle tauota - puhtaan koodin käsite.

Puhdas koodi on keskittynyt ja ymmärrettävä koodi, joka tarkoittaa, että sen on oltava luettavissa, looginen ja muutettavissa. Muista - hyvä koodi ei ole se, jota tietokoneet ymmärtävät; se on se, jonka ihmiset ymmärtävät.

Usein ohjelma voidaan luoda monin tavoin, ja koodi, yleensä, voidaan järjestää useilla tavoilla. Hyvä käytäntö tarkoittaa, että valitset version, joka on helpoin lukea ja ymmärtää ja joka ei estä kollegoitasi päivittämästä sitä tarvittaessa. He todennäköisesti työskentelevät koodin päällä, joten on parasta, jos he eivät hukkaa aikaa keksimään ideoita monimutkaisten koodirivien alla. Siksi oletetaan, että työpaikallasi kirjoitat aina koodin siististi - mahdollisimman yksinkertaisena, täydellisesti järjestettynä, ylläpitäen tasaista loogista virtausta.

Hyvä tyyli

Keskitytään nyt toiseen tyyliin koodaukseen. Kun määrität nimiä muuttujille tai SQL-objekteille, valitse aina lyhyemmät, merkitykselliset nimet, välittäen tietyt tiedot. 'Merkityksellisellä' tarkoitamme ääntäviä nimiä, joissa on valittu yksi sana konseptia kohden. Esimerkiksi tästä syystä valitsimme “Myynti” -taulukkoon ”ostonumeron”, ei ”asiakashankinnan yksilöivän numeron”.

Sillä tilillä sinun ei tarvitse kiirehtiä nimien valintaa, koska niiden on heijastettava mahdollisimman suurta määrää objektin toiminnallisuutta. Nimet muodostavat yli 80% koodistasi, joten on tärkeätä, minkä kanssa työskentelet!

Usein keskustellaan siitä, onko koodauksessa käytettävä isoja tai pieniä kirjaimia. Totuus on - se riippuu tyylistäsi tai yrityksesi tyylistä, jossa työskentelet. Useimmiten ammattilaiset käyttävät SQL-avainsanoja isoilla kirjaimilla ja kirjoittavat objektien nimet eri tavalla.

Kun nimessä on useampi kuin yksi sana, kuten ”ostonumero”, sanat yleensä joko erotetaan alaviivalla tai liitetään toisiinsa, ja jokainen sana alkaa isoilla kirjaimilla. Molemmat lähestymistavat kohdataan ammatillisessa koodauksessa. Yksi asia on kuitenkin varma - et voi jättää tyhjää tilaa sanojen väliin. MySQL näyttää virheilmoituksen, jos yrität tehdä niin.

Koodin luettavuus

Kolmas näkökohta, johon keskitymme tässä viestissä, on koodisi luettavuus. Toisaalta tämä koskee koodin vaaka- ja pystysuuntaista järjestelyä, toisaalta väriä, jolla sanat näytetään.

Teknisesti mikä tahansa SQL-kysely voidaan kirjoittaa yhdelle riville. Monet kyselyt ovat kuitenkin liian pitkiä ja niistä tulee vaikea lukea, jos teemme niin. Tällaisissa tapauksissa on tehtävä koodi järjestyksessä, ei vain vaakasuunnassa, mutta myös pystysuunnassa.

Sanat voidaan kirjoittaa eri väreillä riippuen niiden merkityksestä kyselyssä ja tavasta, jolla haluamme niiden lukevan. SQL-avainsanat kirjoitetaan sinisellä, esineiden nimet mustalla, numerot oranssilla ja niin edelleen.

Ylläpidä koodiasi

Kun siirrymme eteenpäin viestissä, kehotat silmää kirjoittamasi koodin moitteettomalle järjestämiselle. Muista nyt, että on kolme päätapaa ylläpitää koodiasi hyvin:

1. Ammattilaiset käyttävät ad-hoc-ohjelmistoa, joka järjestää koodin ja värit eri sanoihin johdonmukaisesti. Dynaamisemmassa koodausympäristössä aika on tekijä, ja koodaustavan yhtenäistäminen on etusijalla. On mahdotonta, että yrityksessäsi on 50 ohjelmoijaa, jotka kaikki kirjoittavat samalla tyylillä. Ei ole ammattimaista yhdistää samaan kieleen, mutta eri tyyliin kirjoitettua koodia. Joten valmistuttuaan työkoodin osat käyvät läpi tällaisen ohjelmiston tarkistuksen, ja pomollasi on kasa koodia, jotka kaikki on kirjoitettu samalla tyylillä.

2. Käytä Workbenchin mukana toimitettua analogista työkalua. Tämä pieni harja kaunistaa koodiasi. Pikavalintanäppäinyhdistelmä, jolla tätä toimintoa käytetään kohdistimen sijaintipaikkakyselyyn, on Ctrl ja B. Näet? Mahtava!

3. Jos haluat puhdistaa koodisi eri tavalla, sinun on puututtava manuaalisesti ja säädä sitä haluamallasi tavalla.

Liikunta

Tämän yksinkertaisen rivin avulla luomme testitaulukon, jossa on kaksi saraketta - ”Numerot” ja “Sanat”.

Olemme kirjoittaneet koodin yhdelle riville pienillä kirjaimilla. Huomaa, kuinka MySQL muutti avainsanojen, tietotyyppien ja numeroiden väriä. Nyt emme käsittele ad-hoc-ohjelmistoja, koska keskitymme Workbenchiin. Kun olet asentanut kohdistimen johonkin tähän kyselyyn, voit painaa pientä harjakuvaketta muotoillaksesi skriptin uudelleen. Jos haluat tehdä saman toiminnon nopeammin, muista Ctrl- ja B-pikavalinnat.

Vau! Se toimi.

Avainsanat ovat isoja kirjaimia, ja taulukon kunkin sarakkeen tiedot alkavat uudella rivillä. Loistava!

Sisennys tyyli

Kuvittele, että sinulla on toinen etu tämän koodin horisontaaliseen järjestelyyn ja kaikkien tietotyyppien kohdistamiseen. Käyttämällä näppäimistön välilehtipainiketta voit asettaa INT: n ja VARCHARin alkamaan samassa vaakapisteessä. Joidenkin käyttäjien mukaan tämä temppu parantaa edelleen koodin luettavuutta.

Teknistä termiä kutsutaan sisennykseksi. Sanomme, että sarakkeiden nimet ja niiden tietotyypit on sisennetty oikealle.

Kommentit

Toinen näkökohta hyvän koodaustyylin ylläpitämisessä on kommenttien käyttö. Nämä ovat tekstiä, joita Workbench ei toimi koodina; he välittävät viestin henkilölle, joka lukee koodimme. Teknisesti MySQL: ssä voit aloittaa kommentin kirjoittamalla eteenpäinviivan ja tähden ja sulkemalla sen vastavuoroisesti tähdellä ja eteenpäinviivalla. Tätä lähestymistapaa käytetään pääasiassa suuriin kommentteihin.
Yhden rivin kommentteihin voit käyttää joko kahta viivaa tai yhtä tai useampaa hajautusmerkkiä. MySQL Workbench merkitsee kaikki kommentit harmaalla erottaakseen ne pelkistä koodeista.

Fantastinen!

Suorita koodi

Lopuksi haluaisin selvittää salaman symbolin, joka auttaa sinua suorittamaan koodisi.

Aloitetaan siitä, että koodisi on jaettu lohkoihin, kuten puolipiste-erotin merkitsee. Ok.

Joten jos asetat kohdistimen yhteen lohkoon ja painat sitten salamakuvaketta tai Ctrl, Shift, Enter yhdistelmää, SQL suorittaa valitut ja kaikki jäljellä olevat kyselyt.

Siksi, jos napsautin FROM-painiketta ja suoritan koodin tällä tavalla, näen SELECT-käskyn tulosteen ja pudotan testitaulukon.

Jos haluat ajaa vain lauseen kohdistimen alla, sinun on painettava viereistä kuvaketta, jossa on kuvattu salama ja kohdistin. Vastaava näppäimistöyhdistelmä on Ctrl ja Enter.

Voin luvata, että et lopeta tämän näppäimistöyhdistelmän käyttöä, koska sen avulla voit nähdä tietyn kyselyn tulokset nopeasti, ilman että sinun täytyy suorittaa koko SQL-koodi.

No… Toivottavasti pidit tästä viestistä! Sen tarkoituksena oli saada sinut tietoiseksi käsitteestä puhdas koodaus ja hyvässä muodossa koodaus. Pidämme näitä työkaluja välttämättöminä hyvässä ammatillisessa koodauksessa, joten olisimme iloisia, jos ymmärrät, että aloit hyvien koodaustapojen rakentamisen.