SQL Best Practices - Hvordan skrive kode rent og perfekt organisert

Ren kode

I dette innlegget vil vi ta hensyn til kodingsstil. Det er mange måter du kan skrive koden på, men det er bare noen få som anses som profesjonelle.

Det er avgjørende å overholde kodingsstilreglene. Når du går videre i programmering, ikke bare i SQL, men på noe språk, vil du aldri jobbe på egen hånd. Du vil alltid jobbe i et team. Selv om du er en frilanser som jobber online, vil det alltid være noen som vil lese koden din på et tidspunkt. Så vil du finne ut at det er en forestilling som ikke gir deg en pause - forestillingen om ren kode.

Ren kode er kode som er fokusert og forståelig, noe som betyr at den må være lesbar, logisk og skiftbar. Husk - god kode er ikke den datamaskiner forstår; det er den mennesker kan forstå.

Ofte kan et program lages på mange måter, og kode, generelt, kan organiseres på flere måter. God praksis innebærer at du velger den versjonen som vil være enklest å lese og forstå, og vil være den som ikke er til hinder for kollegene dine fra å oppdatere den når det er nødvendig. De vil sannsynligvis fungere på toppen av koden din, så det er best hvis de ikke mister tid på å finne ut av ideer under komplekse kodelinjer. Det er grunnen til at antagelsen alltid er at du på arbeidsplassen din vil skrive inn koden rent - så enkelt som mulig, perfekt organisert og opprettholde en jevn logisk flyt.

God stil

La oss nå fokusere på et annet aspekt av koding i god stil. Når du tilordner navn til variabler eller SQL-objekter, må du alltid velge kortere, meningsfylte navn og formidle spesifikk informasjon. Med ‘meningsfull’ mener vi navn som kan uttales, der det er plukket ut ett ord per konsept. Det er for eksempel grunnen til at vi valgte “kjøpnummer”, ikke “kundekjøp unikt nummer” i “Salg” -tabellen.

På den kontoen trenger du ikke ha det travelt med å velge navn, siden de må gjenspeile så mye av objektets funksjonalitet som mulig. Navn vil utgjøre mer enn 80% av koden din, så det betyr noe for hvilke du jobber med!

Det diskuteres ofte om store eller små bokstaver må brukes når du skal kode. Sannheten er - det kommer an på stilen din eller stilen til selskapet du jobber for. Oftest vil fagpersoner benytte SQL-nøkkelordene og skrive navn på objekter på en annen måte.

Når et navn inneholder mer enn ett ord, for eksempel “kjøpsnummer”, skilles ord vanligvis enten med understrek eller festes til hverandre, og hvert ord starter med en stor bokstav. Begge tilnærminger blir møtt i profesjonell koding. Én ting er imidlertid sikker - du kan ikke legge igjen et tomt mellomrom mellom ord. MySQL vil vise en feilmelding hvis du prøver å gjøre det.

Kodelesbarhet

Den tredje fasiten vi vil fokusere på i dette innlegget, er lesbarheten til koden din. På den ene siden angår dette den horisontale og vertikale organisasjonen av koden, på den annen side fargen som ordene vises med.

Teknisk sett kan alle SQL-spørsmål skrives på en enkelt linje. Imidlertid er mange spørsmål for lange og vil bli vanskelige å lese hvis vi gjør det. Det som må gjøres i slike tilfeller er å organisere koden, ikke bare horisontalt, men også vertikalt.

Avhengig av betydningen i en spørring og hvordan vi vil at de skal leses, kan ord skrives i forskjellige farger. SQL-nøkkelord er skrevet i blått, objektenavn i svart, tall i oransje, og så videre.

Vedlikehold koden

Når vi går videre i innlegget, vil du utvikle et øye for plettfri organisering av koden du skriver. Husk at det er tre måter å vedlikeholde koden godt på nå:

1. Fagfolk bruker ad-hoc programvare som omorganiserer kode og farger forskjellige ord konsekvent. I et mer dynamisk kodingsmiljø vil tid være en faktor, og forening av kodestil vil være en topp prioritet. Det er umulig å ha 50 programmerere i bedriften, som alle skriver i samme stil. Det er uprofesjonelt å slå sammen kode skrevet på samme språk, men i en annen stil. Så når det er fullført, går deler av arbeidskoden gjennom sjekken av en slik programvare, og sjefen din vil ha en bunke med kode som alle er skrevet i samme stil.

2. Bruk det relevante analoge verktøyet som følger med i Workbench. Denne lille børsten forskjønner koden din. Snarveietastkombinasjonen for å bruke denne funksjonen på spørsmålet der markøren din er, er Ctrl og B. Ser du? Rått!

3. Hvis du foretrekker å rense koden din på en annen måte, bør du gripe inn manuelt og justere den som du vil.

Trening

I denne enkle linjen vil vi lage en testtabell med to kolonner - “Numbers” og “Words”.

Vi har skrevet koden på en linje med små bokstaver. Legg merke til hvordan MySQL endret fargen på nøkkelord, datatyper og tall. Nå har vi ikke å gjøre med en ad-hoc-programvare, da vi fokuserer på Workbench. Etter å ha plassert markøren et sted i denne spørringen, kan du trykke på det lille børsteikonet for å formatere skriptet. For å utføre den samme operasjonen raskere, husk snarveien Ctrl og B.

Wow! Det funket.

Nøkkelord er med store bokstaver, og dataene for hver kolonne i tabellen starter på en ny linje. Flott!

Innrykkstil

Se for deg at du har en ytterligere preferanse angående den horisontale organisasjonen av denne koden og justeringen av alle datatyper. Ved å bruke tabusknappen fra tastaturet, kan du stille INT og VARCHAR til å begynne på samme horisontale punkt. I følge noen brukere forbedrer dette trikset kodens lesbarhet ytterligere.

Den tekniske betegnelsen kalles innrykk. Vi sier at kolonnenavnene og datatypene deres var innrykket til høyre.

kommentarer

Et annet aspekt ved å opprettholde god kodingsstil er å bruke kommentarer. Dette er tekstlinjer som Workbench ikke vil kjøre som kode; de formidler et budskap til noen som leser koden vår. Teknisk sett kan du i MySQL starte en kommentar ved å skrive inn en skråstrek og en stjerne og lukke den gjensidig med en stjerne og en skråstrek. Denne tilnærmingen brukes hovedsakelig til store kommentarer.
For kommentarer på en linje, kan du bruke to streker eller ett eller flere hasj-tegn. I tillegg, for å skille dem fra bare kode, markerer MySQL Workbench alle kommentarer i grått.

Fantastisk!

Utfør kode

Til slutt vil jeg utdype lynsymbolet, som hjelper deg å utføre koden din.

La oss starte med at koden din er delt opp i blokker, som markert av semi-colon-separatoren. Ok.

Så hvis du plasserer markøren på en blokk og deretter trykker på lynikonet eller kombinasjonen Ctrl, Shift, Enter, vil SQL kjøre de valgte og alle gjenværende spørsmål.

Det er grunnen til at hvis jeg klikker på FROM og kjører koden på denne måten, vil jeg se utdataene fra SELECT-setningen og slippe testtabellen.

Hvis du ønsker å kjøre kun utsagnet under markøren, må du trykke på det tilstøtende ikonet, der en lyn og en markør er avbildet. Den tilsvarende tastaturkombinasjonen er Ctrl og Enter.

Jeg kan love at du ikke vil slutte å bruke denne tastaturkombinasjonen, siden den lar deg se utdataene fra et bestemt spørsmål raskt, uten å måtte kjøre hele SQL-koden.

Vel, jeg håper du likte dette innlegget! Det hadde som mål å gjøre deg oppmerksom på forestillingen om ren koding og koding i god stil. Vi anser disse verktøyene som viktige for god profesjonell koding, så vi ville være glade hvis du kan føle at du begynte å bygge gode kodingsstilvaner.