SQL Best Practices - Hur man skriver koden rent och perfekt organiserat

Ren kod

I det här inlägget kommer vi att uppmärksamma kodningsstil. Det finns många sätt du kan skriva din kod, men det finns bara ett fåtal som anses vara professionella.

Att följa reglerna för kodningsstil är avgörande. När du går vidare med programmering, inte bara i SQL utan på något språk, kommer du aldrig att arbeta på egen hand. Du kommer alltid att arbeta i ett team. Även om du är frilansare som arbetar online kommer det alltid finnas någon som kommer att läsa din kod vid någon tidpunkt. Då kommer du att ta reda på att det finns en idé som inte ger dig en paus - tanken på ren kod.

Ren kod är kod som är fokuserad och förståelig, vilket innebär att den måste vara läsbar, logisk och förändrad. Kom ihåg - god kod är inte den datorer förstår; det är den som människor kan förstå.

Ofta kan ett program skapas på många sätt och koden i allmänhet kan organiseras på flera sätt. God praxis innebär att du väljer den version som är lättast att läsa och förstå och kommer att vara den som inte hindrar dina kollegor från att uppdatera den vid behov. De kommer sannolikt att fungera ovanpå din kod, så det är bäst om de inte tappar tid på att räkna ut idéer under komplexa kodrader. Det är därför antagandet är att du på din arbetsplats alltid kommer att skriva koden rent - så enkelt som möjligt, perfekt organiserat och upprätthålla ett stabilt logiskt flöde.

Bra stil

Låt oss nu fokusera på en annan aspekt av kodning i bra stil. När du tilldelar namn till variabler eller SQL-objekt, välj alltid kortare, meningsfulla namn, förmedla specifik information. Med "meningsfull" menar vi namn som kan uttalas, där ett ord per begrepp har valts. Det är till exempel anledningen till att vi valde ”köpnummer”, inte ”kundköp unikt nummer” i tabellen ”Försäljning”.

På det kontot behöver du inte ha bråttom att välja namn, eftersom de måste återspegla så mycket av objektets funktionalitet som möjligt. Namnen kommer att utgöra mer än 80% av din kod, så det spelar någon roll vilka du arbetar med!

Det diskuteras ofta om stora eller små bokstäver måste användas vid kodning. Sanningen är - det beror på din stil eller på stilen för företaget du arbetar för. Oftast kommer proffs att använda SQL-nyckelord och skriva objekt på ett annat sätt.

När ett namn består av mer än ett ord, till exempel "köpnummer", skiljs ord vanligtvis antingen med en understruk eller knytas till varandra, och varje ord börjar med en stor bokstav. Båda metoderna stöter på professionell kodning. En sak är dock säker - du kan inte lämna ett tomt utrymme mellan ord. MySQL visar ett felmeddelande om du försöker göra det.

Kodläsbarhet

Den tredje aspekten vi kommer att fokusera på i det här inlägget är läsbarheten för din kod. Å ena sidan avser detta den horisontella och vertikala organisationen av koden, å andra sidan färgen som ord visas med.

Tekniskt kan alla SQL-frågor skrivas på en enda rad. Men många frågor är för långa och kommer att bli svåra att läsa om vi gör det. Det som måste göras i sådana fall är att organisera koden, inte bara horisontellt utan också vertikalt.

Beroende på deras betydelse i en fråga och hur vi vill att de ska läsas, kan ord skrivas i olika färger. SQL-nyckelord skrivs i blått, objektens namn i svart, siffror i orange, och så vidare.

Behåll din kod

När vi går vidare i inlägget kommer du att utveckla ett öga för oklanderlig organisering av koden du skriver. Kom ihåg att det finns tre huvudsakliga sätt att behålla din kod väl:

1. Professionals använder ad-hoc-programvara som omorganiserar kod och färgar olika ord konsekvent. I en mer dynamisk kodningsmiljö kommer tiden att vara en faktor, och enande av kodningsstil kommer att vara högsta prioritet. Det är omöjligt att ha 50 programmerare i ditt företag, alla skriver i samma stil. Det är oprofessionellt att slå samman kod skriven på samma språk men i en annan stil. Så när det är klart går bitar av kod för arbete igenom kontrollen av en sådan programvara, och din chef kommer att ha en hög med kod alla skrivna i samma stil.

2. Använd det relevanta analoga verktyget som finns i Workbench. Den här lilla borsten förskönar din kod. Genvägstangentkombinationen för att tillämpa den här funktionen på frågan där markören finns är Ctrl och B. Ser du? Grymt bra!

3. Om du föredrar att rengöra din kod annorlunda, bör du ingripa manuellt och justera den som du vill.

Övning

I den här enkla raden skapar vi en testtabell med två kolumner - "Numbers" och "Words".

Vi har skrivit koden på en rad med små bokstäver. Lägg märke till hur MySQL ändrade färgen på nyckelord, datatyper och nummer. Nu kommer vi inte att ta itu med en ad-hoc-programvara, eftersom vi fokuserar på Workbench. Efter att ha placerat markören någonstans i den här frågan kan du trycka på den lilla borstikonen för att omformatera skriptet. Kom ihåg Ctrl och B-genvägen för att göra samma operation snabbare.

Wow! Det fungerade.

Nyckelord finns med stora bokstäver, och data för varje kolumn i tabellen börjar på en ny rad. Bra!

Intryckstil

Föreställ dig att du har en ytterligare preferens beträffande den horisontella organisationen av denna kod och anpassningen av alla datatyper. Med hjälp av tabbknappen från tangentbordet kan du ställa in INT och VARCHAR för att börja vid samma horisontella punkt. Enligt vissa användare förbättrar detta trick ytterligare kodens läsbarhet.

Den tekniska termen kallas intryck. Vi säger att kolumnnamnen och deras datatyper var indragna till höger.

kommentarer

En annan aspekt av att upprätthålla god kodningsstil är att använda kommentarer. Detta är textrader som Workbench inte kommer att köra som kod; de förmedlar ett meddelande till någon som läser vår kod. Tekniskt sett kan du i MySQL starta en kommentar genom att skriva en framstreck och en stjärna och stänga den ömsesidigt med en stjärna och en framåt snedstreck. Denna metod används främst för stora kommentarer.
För kommentarer på en rad kan du använda två streck eller ett eller flera hash-tecken. För att skilja dem från ren kod markerar MySQL Workbench alla kommentarer i grått.

Fantastisk!

Kör kod

Till sist vill jag utarbeta blixtnedslagssymbolen, som hjälper dig att köra din kod.

Låt oss börja från det faktum att din kod är uppdelad i block, som markeras av semi-colon-separatorn. Ok.

Så om du placerar markören på ett block och sedan trycker på blixtikonen eller Ctrl, Shift, Enter-kombinationen kommer SQL att köra den valda och alla återstående frågor.

Det är därför, om jag klickar på FROM och kör koden på det här sättet, ser jag utgången från SELECT-satsen och släpper testtabellen.

Om du vill köra bara påståendet under markören, måste du trycka på den intilliggande ikonen, där en blixt och en markör visas. Motsvarande tangentbordskombination är Ctrl och Enter.

Jag kan lova att du inte kommer att sluta använda den här tangentbordskombinationen, eftersom den låter dig se resultatet från en viss fråga snabbt utan att behöva köra hela SQL-koden.

Tja ... Jag hoppas att du gillade det här inlägget! Det syftade till att göra dig medveten om tanken på ren kodning och kodning i bra stil. Vi anser att dessa verktyg är viktiga för god professionell kodning, så vi skulle vara glada om du kan känna att du började bygga goda kodningsvanor.