Best practice SQL: come digitare il codice in modo pulito e perfettamente organizzato

Codice pulito

In questo post, presteremo attenzione allo stile di codifica. Esistono molti modi per scrivere il codice, ma solo alcuni sono considerati professionali.

Il rispetto delle regole di stile di codifica è fondamentale. Quando avanzi nella programmazione, non solo in SQL ma in qualsiasi lingua, non lavorerai mai da solo. Lavorerai sempre in gruppo. Anche se sei un libero professionista che lavora online, ci sarà sempre qualcuno che leggerà il tuo codice a un certo punto. Quindi, scoprirai che esiste una nozione che non ti darà una pausa: la nozione di codice pulito.

Il codice pulito è un codice focalizzato e comprensibile, il che significa che deve essere leggibile, logico e modificabile. Ricorda: un buon codice non è quello che i computer capiscono; è quello che gli umani possono capire.

Spesso un programma può essere creato in molti modi e il codice, in generale, può essere organizzato in diversi modi. La buona pratica implica che sceglierai la versione che sarà più facile da leggere e comprendere e sarà quella che non impedirà ai tuoi colleghi di aggiornarla quando necessario. Probabilmente funzioneranno in cima al tuo codice, quindi è meglio se non perdono tempo a capire idee al di sotto di linee di codice complesse. Ecco perché si suppone che, sul posto di lavoro, digiti sempre il codice in modo pulito, il più semplice possibile, perfettamente organizzato, mantenendo un flusso logico costante.

Bello stile

Ora, concentriamoci su un altro aspetto della programmazione in buon stile. Quando si assegnano nomi a variabili o oggetti SQL, scegliere sempre nomi più brevi e significativi, trasmettendo informazioni specifiche. Per "significativo" intendiamo nomi pronunciabili, in cui è stata scelta una parola per concetto. Ad esempio, questo è il motivo per cui abbiamo scelto "numero di acquisto", non "numero univoco di acquisto cliente" nella tabella "Vendite".

Per questo motivo, non è necessario avere fretta di scegliere i nomi, poiché devono riflettere il maggior numero possibile di funzionalità dell'oggetto. I nomi costituiranno oltre l'80% del tuo codice, quindi importa con quali lavori!

Viene spesso discusso se utilizzare lettere maiuscole o minuscole durante la codifica. La verità è che dipende dal tuo stile o dallo stile dell'azienda per cui lavori. Molto spesso, i professionisti capitalizzeranno le parole chiave SQL e scriveranno i nomi degli oggetti in modo diverso.

Quando un nome comprende più di una parola, ad esempio "numero di acquisto", le parole sono generalmente separate da un carattere di sottolineatura o attaccate l'una all'altra e ogni parola inizia con una lettera maiuscola. Entrambi gli approcci si incontrano nella codifica professionale. Una cosa è certa, però: non puoi lasciare uno spazio vuoto tra le parole. MySQL mostrerà un messaggio di errore se si tenta di farlo.

Leggibilità del codice

Il terzo aspetto su cui ci concentreremo in questo post è la leggibilità del tuo codice. Da un lato, ciò riguarda l'organizzazione orizzontale e verticale del codice, dall'altro il colore con cui vengono visualizzate le parole.

Tecnicamente, qualsiasi query SQL può essere scritta su una singola riga. Tuttavia, molte query sono troppo lunghe e diventeranno difficili da leggere se lo facciamo. Ciò che deve essere fatto in questi casi è organizzare il codice, non solo in orizzontale, ma anche in verticale.

A seconda del loro significato in una query e del modo in cui vogliamo che vengano letti, le parole possono essere scritte in diversi colori. Le parole chiave SQL sono scritte in blu, i nomi degli oggetti in nero, i numeri in arancione e così via.

Mantieni il tuo codice

Procedendo nel post, svilupperai un occhio per l'organizzazione impeccabile del codice che scrivi. Per ora, ricorda che ci sono tre modi principali per mantenere bene il tuo codice:

1. I professionisti utilizzano software ad hoc che riorganizza il codice e colora in modo coerente parole diverse. In un ambiente di codifica più dinamico, il tempo sarà un fattore e l'unificazione dello stile di codifica sarà una priorità assoluta. È impossibile avere 50 programmatori nella tua azienda, tutti scritti nello stesso stile. Non è professionale unire il codice scritto nella stessa lingua ma in uno stile diverso. Quindi, una volta completato, pezzi di codice funzionante passano attraverso il controllo di tale software e il tuo capo avrà una pila di codice tutti scritti nello stesso stile.

2. Utilizzare lo strumento analogico pertinente fornito in Workbench. Questo piccolo pennello abbellisce il tuo codice. La combinazione di tasti di scelta rapida per applicare questa funzione alla query in cui si trova il cursore è Ctrl e B. Vedi? Eccezionale!

3. Se preferisci pulire il codice in modo diverso, dovresti intervenire manualmente e modificarlo come preferisci.

Esercizio

In questa semplice riga, creeremo una tabella di prova con due colonne: "Numeri" e "Parole".

Abbiamo scritto il codice su una riga con lettere minuscole. Nota come MySQL ha cambiato il colore di parole chiave, tipi di dati e numeri. Ora, non ci occuperemo di un software ad hoc, poiché ci stiamo concentrando su Workbench. Dopo aver posizionato il cursore da qualche parte in questa query, è possibile premere la piccola icona del pennello per riformattare lo script. Per eseguire la stessa operazione più velocemente, ricorda le scorciatoie Ctrl e B.

Wow! Ha funzionato.

Le parole chiave sono in maiuscolo e i dati per ciascuna colonna della tabella iniziano su una nuova riga. Grande!

Stile di rientro

Immagina di avere un'ulteriore preferenza per quanto riguarda l'organizzazione orizzontale di questo codice e l'allineamento di tutti i tipi di dati. Utilizzando il pulsante della scheda dalla tastiera, è possibile impostare INT e VARCHAR per iniziare nello stesso punto orizzontale. Secondo alcuni utenti, questo trucco migliora ulteriormente la leggibilità del codice.

Il termine tecnico si chiama rientro. Diciamo che i nomi delle colonne e i loro tipi di dati sono stati rientrati a destra.

Commenti

Un altro aspetto del mantenimento di un buon stile di codifica è l'utilizzo dei commenti. Queste sono righe di testo che Workbench non eseguirà come codice; trasmettono un messaggio a qualcuno che legge il nostro codice. Tecnicamente, in MySQL, puoi iniziare un commento digitando una barra e una stella e chiudendole reciprocamente con una stella e una barra. Questo approccio viene utilizzato principalmente per commenti di grandi dimensioni.
Per i commenti di una riga, puoi utilizzare due trattini o uno o più segni di hash. Inoltre, per differenziarli dal semplice codice, MySQL Workbench contrassegna tutti i commenti in grigio.

Fantastico!

Esegui codice

Infine, vorrei approfondire il simbolo del fulmine, che ti aiuta a eseguire il tuo codice.

Partiamo dal fatto che il tuo codice è separato in blocchi, come indicato dal punto e virgola. Ok.

Pertanto, se si posiziona il cursore su un blocco e si preme l'icona del fulmine o la combinazione Ctrl, Maiusc, Invio, SQL eseguirà le query selezionate e tutte le rimanenti.

Ecco perché, se faccio clic su DA ed eseguo il codice in questo modo, vedrò l'output dall'istruzione SELECT e lascerò cadere la tabella di test.

Se desideri eseguire solo l'istruzione sotto il cursore, devi premere l'icona adiacente, dove sono raffigurati un lampo e un cursore. La combinazione di tastiera corrispondente è Ctrl e Invio.

Posso promettere che non smetterai di usare questa combinazione di tastiere, poiché ti consente di vedere rapidamente l'output di una determinata query, senza dover eseguire l'intero codice SQL.

Bene ... spero che questo post ti sia piaciuto! Aveva lo scopo di renderti consapevole del concetto di codifica pulita e codifica in buon stile. Consideriamo questi strumenti essenziali per una buona codifica professionale, quindi saremmo felici se potessi sentire che hai iniziato a costruire buone abitudini di stile di codifica.