Best practices voor SQL - Hoe code netjes en perfect georganiseerd te typen

Schone code

In dit bericht zullen we aandacht besteden aan de codeerstijl. Er zijn veel manieren waarop u uw code kunt schrijven, maar er zijn er maar een paar die als professioneel worden beschouwd.

Het naleven van regels voor codeerstijlen is cruciaal. Wanneer u verder gaat met programmeren, niet alleen in SQL maar in elke taal, werkt u nooit alleen. Je werkt altijd in teamverband. Zelfs als u een freelancer online werkt, zal er altijd iemand zijn die uw code op enig moment zal lezen. Dan zul je ontdekken dat er één idee is dat je geen pauze geeft - het idee van schone code.

Schone code is code die gericht en begrijpelijk is, wat betekent dat deze leesbaar, logisch en veranderlijk moet zijn. Onthoud - goede code is niet wat computers begrijpen; het is wat mensen kunnen begrijpen.

Vaak kan een programma op vele manieren worden gemaakt en kan code in het algemeen op verschillende manieren worden georganiseerd. Goede praktijk houdt in dat u de versie kiest die het gemakkelijkst te lezen en te begrijpen is en de versie is die uw collega's niet belemmert om deze indien nodig bij te werken. Ze zullen waarschijnlijk bovenop uw code werken, dus het is het beste als ze geen tijd verliezen om ideeën uit te zoeken onder complexe coderegels. Daarom wordt ervan uitgegaan dat u op uw werkplek code altijd netjes typt - zo eenvoudig mogelijk, perfect georganiseerd, met behoud van een gestage logische stroom.

Goede stijl

Laten we nu eens kijken naar een ander aspect van codering in goede stijl. Kies bij het toekennen van namen aan variabelen of SQL-objecten altijd kortere, betekenisvolle namen, die specifieke informatie overbrengen. Met ‘betekenisvol’ bedoelen we namen die uit te spreken zijn, waarbij één woord per concept is gekozen. Dat is bijvoorbeeld de reden waarom we in de tabel "Verkoop" hebben gekozen voor "inkoopnummer", niet "klantaankoop uniek nummer".

Om die reden hoeft u niet gehaast te zijn om namen te kiezen, omdat ze zoveel mogelijk van de functionaliteit van het object moeten weerspiegelen. Namen vormen meer dan 80% van uw code, dus het maakt uit met welke u werkt!

Er wordt vaak besproken of hoofdletters of kleine letters moeten worden gebruikt bij het coderen. De waarheid is - het hangt af van je stijl of van de stijl van het bedrijf waar je voor werkt. Meestal zullen professionals de SQL-trefwoorden met een hoofdletter schrijven en de namen van objecten op een andere manier schrijven.

Wanneer een naam meer dan één woord bevat, zoals 'inkoopnummer', worden woorden meestal gescheiden door een onderstrepingsteken of aan elkaar gehecht en begint elk woord met een hoofdletter. Beide benaderingen komen voor in professionele codering. Eén ding is echter zeker - u kunt geen lege ruimte tussen woorden laten. MySQL zal een foutmelding tonen als u dat probeert te doen.

Code leesbaarheid

Het derde facet waarop we ons in dit bericht zullen concentreren, is de leesbaarheid van uw code. Enerzijds betreft dit de horizontale en verticale ordening van code, anderzijds de kleur waarmee woorden worden weergegeven.

Technisch gezien kan elke SQL-query op één regel worden geschreven. Veel vragen zijn echter te lang en zullen moeilijk te lezen worden als we dat doen. In dergelijke gevallen moet de code worden georganiseerd, niet alleen horizontaal, maar ook verticaal.

Afhankelijk van hun betekenis in een zoekopdracht en de manier waarop we willen dat ze worden gelezen, kunnen woorden in verschillende kleuren worden geschreven. SQL-trefwoorden worden in het blauw geschreven, de namen van objecten in het zwart, de nummers in het oranje, enzovoort.

Onderhoud uw code

Naarmate we verder gaan in de post, zul je een oog ontwikkelen voor een onberispelijke organisatie van de code die je schrijft. Onthoud dat er voor nu drie belangrijke manieren zijn om uw code goed te onderhouden:

1. Professionals gebruiken ad-hoc software die code opnieuw organiseert en verschillende woorden consistent kleurt. In een meer dynamische codeeromgeving zal tijd een factor zijn en zal unificatie van de codeerstijl een topprioriteit zijn. Het is onmogelijk om 50 programmeurs in uw bedrijf te hebben die allemaal in dezelfde stijl schrijven. Het is onprofessioneel om code samen te voegen die in dezelfde taal is geschreven, maar in een andere stijl. Dus als ze zijn voltooid, worden stukjes werkende code door een dergelijke software gecontroleerd en heeft je baas een stapel code die allemaal in dezelfde stijl is geschreven.

2. Gebruik de relevante analoge tool in Workbench. Dit kleine penseel verfraait je code. De sneltoetscombinatie om deze functie toe te passen op de zoekopdracht waar uw cursor zich bevindt, is Ctrl en B. Ziet u? Geweldig!

3. Als u uw code liever anders wilt opschonen, moet u handmatig ingrijpen en deze naar wens aanpassen.

Oefening

In deze eenvoudige regel maken we een testtabel met twee kolommen - "Getallen" en "Woorden".

We hebben de code op één regel geschreven met kleine letters. Merk op hoe MySQL de kleur van zoekwoorden, gegevenstypen en getallen heeft gewijzigd. Nu zullen we niet te maken hebben met ad-hoc software, omdat we ons richten op Workbench. Nadat u de cursor ergens in deze query hebt geplaatst, kunt u op het kleine penseelpictogram drukken om het script opnieuw te formatteren. Onthoud de sneltoets Ctrl en B om dezelfde bewerking sneller uit te voeren.

Wauw! Het werkte.

Sleutelwoorden zijn in hoofdletters en de gegevens voor elke kolom van de tabel beginnen op een nieuwe regel. Super goed!

Inspringende stijl

Stel je voor dat je nog een voorkeur hebt voor de horizontale organisatie van deze code en de uitlijning van alle gegevenstypen. Met behulp van de tabknop op uw toetsenbord kunt u INT en VARCHAR instellen om op hetzelfde horizontale punt te beginnen. Volgens sommige gebruikers verbetert deze truc de leesbaarheid van de code verder.

De technische term wordt inspringen genoemd. We zeggen dat de kolomnamen en hun gegevenstypes rechts zijn ingesprongen.

Comments

Een ander aspect van het handhaven van een goede codeerstijl is het gebruik van opmerkingen. Dit zijn tekstregels die Workbench niet als code uitvoert; ze brengen een bericht over aan iemand die onze code leest. Technisch gezien kunt u in MySQL een opmerking starten door een schuine streep en een ster te typen en deze wederzijds te sluiten met een ster en een schuine streep. Deze aanpak wordt voornamelijk gebruikt voor grote opmerkingen.
Voor opmerkingen van één regel kunt u twee streepjes of een of meer hekjes gebruiken. Om ze te onderscheiden van louter code, markeert MySQL Workbench bovendien alle opmerkingen grijs.

Fantastisch!

Code uitvoeren

Tot slot wil ik ingaan op het bliksemsymbool, dat u helpt uw ​​code uit te voeren.

Laten we beginnen met het feit dat uw code is gescheiden in blokken, zoals aangegeven door het puntkomma-scheidingsteken. OK.

Dus, als u uw cursor op één blok plaatst en vervolgens op het bliksempictogram of de combinatie Ctrl, Shift, Enter drukt, voert SQL de geselecteerde en alle resterende query's uit.

Daarom, als ik op FROM klik en de code op deze manier voer, zie ik de uitvoer van de SELECT-instructie en laat ik de testtabel vallen.

Als u alleen de instructie onder de cursor wilt uitvoeren, moet u op het aangrenzende pictogram drukken, waar een bliksem en een cursor worden weergegeven. De bijbehorende toetsenbordcombinatie is Ctrl en Enter.

Ik kan beloven dat u niet zult stoppen met het gebruik van deze toetsenbordcombinatie, omdat u hiermee de uitvoer van een bepaalde query snel kunt zien, zonder dat u de volledige SQL-code hoeft uit te voeren.

Nou ... ik hoop dat je dit bericht leuk vond! Het was bedoeld om u bewust te maken van het idee van schone codering en codering in goede stijl. We beschouwen deze tools als essentieel voor een goede professionele codering, dus we zouden blij zijn als je merkt dat je bent begonnen met het ontwikkelen van goede gewoonten voor codeerstijlen.