Meilleures pratiques SQL - Comment taper du code proprement et parfaitement organisé

Code propre

Dans cet article, nous ferons attention au style de codage. Vous pouvez écrire votre code de nombreuses façons, mais seules quelques-unes sont considérées comme professionnelles.

Le respect des règles de style de codage est crucial. Lorsque vous avancez dans la programmation, non seulement en SQL mais dans n’importe quel langage, vous ne travaillerez jamais seul. Vous travaillerez toujours en équipe. Même si vous êtes un pigiste travaillant en ligne, il y aura toujours quelqu'un qui lira votre code à un moment donné. Ensuite, vous découvrirez qu’il existe une notion qui ne vous donnera pas de répit: la notion de code propre.

Un code propre est un code ciblé et compréhensible, ce qui signifie qu'il doit être lisible, logique et modifiable. Rappelez-vous qu'un bon code n'est pas celui que les ordinateurs comprennent; c'est ce que les humains peuvent comprendre.

Un programme peut souvent être créé de nombreuses manières et le code, en général, peut être organisé de plusieurs manières. Une bonne pratique implique que vous choisissiez la version qui sera la plus facile à lire et à comprendre et qui n’empêchera pas vos collègues de la mettre à jour au besoin. Ils travailleront probablement sur votre code, il est donc préférable de ne pas perdre de temps à trouver des idées sous des lignes de code complexes. C’est pourquoi nous partons du principe que sur votre lieu de travail, vous saisirez toujours le code proprement dit - aussi simple que possible, parfaitement organisé, en maintenant un flux logique constant.

Bon style

Concentrons-nous maintenant sur un autre aspect du codage. Lorsque vous attribuez des noms à des variables ou à des objets SQL, choisissez toujours des noms évocateurs et explicites, véhiculant des informations spécifiques. Par «significatif», nous entendons des noms prononçables, dans lesquels un mot par concept a été choisi. Par exemple, c’est la raison pour laquelle nous avons choisi «numéro d’achat» et non «numéro unique d’achat client» dans le tableau «Ventes».

Sur ce compte, vous ne devez pas être pressé de choisir des noms, car ils doivent refléter autant de fonctionnalités que possible de l’objet. Les noms constitueront plus de 80% de votre code, il est donc important de savoir avec qui vous travaillez!

Il est souvent discuté si des lettres majuscules ou minuscules doivent être utilisées lors du codage. La vérité est que cela dépend de votre style ou du style de l'entreprise pour laquelle vous travaillez. Le plus souvent, les professionnels capitalisent les mots-clés SQL et écrivent les noms des objets de manière différente.

Lorsqu'un nom comprend plus d'un mot, tel que «numéro d'achat», les mots sont généralement séparés par un trait de soulignement ou associés les uns aux autres, et chaque mot commence par une lettre majuscule. Les deux approches se rencontrent dans le codage professionnel. Une chose est sûre, vous ne pouvez pas laisser d’espace vide entre les mots. MySQL affichera un message d'erreur si vous essayez de le faire.

Lisibilité du code

La troisième facette sur laquelle nous allons nous concentrer dans cet article est la lisibilité de votre code. D'une part, cela concerne l'organisation horizontale et verticale du code, d'autre part, la couleur d'affichage des mots.

Techniquement, toute requête SQL peut être écrite sur une seule ligne. Cependant, de nombreuses requêtes sont trop longues et deviendront difficiles à lire si nous le faisons. Dans ce cas, il convient d’organiser le code non seulement horizontalement, mais aussi verticalement.

En fonction de leur signification dans une requête et de la manière dont on souhaite les lire, les mots peuvent être écrits avec des couleurs différentes. Les mots-clés SQL sont écrits en bleu, les noms des objets en noir, les nombres en orange, etc.

Maintenir votre code

Au fur et à mesure que nous avançons dans le post, vous développerez un œil pour une organisation impeccable du code que vous écrivez. Pour l’instant, rappelez-vous qu’il existe trois méthodes principales pour bien gérer votre code:

1. Les professionnels utilisent un logiciel ad-hoc qui réorganise le code et colorie les mots différents de manière cohérente. Dans un environnement de codage plus dynamique, le temps sera un facteur et l'unification du style de codage sera une priorité absolue. Il est impossible d'avoir 50 programmeurs dans votre entreprise, écrivant tous dans le même style. Il n'est pas professionnel de fusionner du code écrit dans le même langage mais dans un style différent. Ainsi, une fois terminé, des morceaux de code de travail passent par la vérification d'un tel logiciel, et votre supérieur hiérarchique disposera d'une pile de codes écrits dans le même style.

2. Utilisez l'outil analogique approprié fourni dans Workbench. Ce petit pinceau embellit votre code. La combinaison de touches de raccourci pour appliquer cette fonction à la requête où se trouve votre curseur est Ctrl et B. Vous voyez? Impressionnant!

3. Si vous préférez nettoyer votre code différemment, vous devez intervenir manuellement et l’ajuster à votre guise.

Exercice

Dans cette ligne simple, nous allons créer une table de test avec deux colonnes - "Nombres" et "Mots".

Nous avons écrit le code sur une ligne avec de petites lettres. Remarquez comment MySQL a changé la couleur des mots-clés, des types de données et des nombres. À présent, nous ne traiterons pas avec un logiciel ad-hoc, car nous nous concentrons sur Workbench. Après avoir placé le curseur quelque part dans cette requête, vous pouvez appuyer sur la petite icône de pinceau pour reformater le script. Pour effectuer la même opération plus rapidement, rappelez-vous les raccourcis Ctrl et B.

Hou la la! Ça a marché.

Les mots-clés sont en majuscules et les données de chaque colonne du tableau commencent sur une nouvelle ligne. Génial!

Style d'indentation

Imaginez que vous ayez une préférence supplémentaire pour l'organisation horizontale de ce code et l'alignement de tous les types de données. En utilisant le bouton de tabulation de votre clavier, vous pouvez définir INT et VARCHAR pour qu'ils commencent au même point horizontal. Selon certains utilisateurs, cette astuce améliore encore la lisibilité du code.

Le terme technique s'appelle indentation. Nous disons que les noms de colonne et leurs types de données ont été mis en retrait à droite.

commentaires

L'utilisation de commentaires est un autre aspect du maintien d'un bon style de codage. Ce sont des lignes de texte que Workbench ne fonctionnera pas en tant que code. ils transmettent un message à quelqu'un qui lit notre code. Techniquement, dans MySQL, vous pouvez commencer un commentaire en tapant une barre oblique et une étoile, puis fermez-le réciproquement avec une étoile et une barre oblique. Cette approche est principalement utilisée pour les commentaires volumineux.
Pour les commentaires d'une ligne, vous pouvez utiliser deux tirets ou un ou plusieurs signes de hachage. De plus, pour les différencier du simple code, MySQL Workbench marque tous les commentaires en gris.

Fantastique!

Exécuter le code

Enfin, je voudrais élaborer sur le symbole éclair, qui vous aide à exécuter votre code.

Commençons par le fait que votre code est séparé en blocs, comme indiqué par le séparateur de point-virgule. D'accord.

Ainsi, si vous placez votre curseur sur un bloc, puis que vous appuyez sur l’icône éclair ou sur la combinaison Ctrl, Maj, Entrée, SQL exécutera la requête sélectionnée et toutes les requêtes restantes.

C’est pourquoi, si je clique sur FROM et exécute le code de cette façon, je verrai le résultat de l’instruction SELECT et jetterai la table de test.

Si vous souhaitez exécuter uniquement l'instruction sous le curseur, vous devez appuyer sur l'icône adjacente, où figurent un éclair et un curseur. La combinaison de clavier correspondante est Ctrl et Entrée.

Je peux vous promettre que vous ne cessez pas d'utiliser cette combinaison de clavier, car elle vous permet de visualiser rapidement le résultat d'une requête donnée, sans avoir à exécuter le code SQL complet.

Eh bien… j'espère que vous avez aimé ce post! Il visait à vous faire prendre conscience de la notion de codage propre et de codage en bon style. Nous estimons que ces outils sont essentiels à un codage professionnel de qualité. Nous serions heureux si vous pouviez sentir que vous aviez commencé à adopter de bonnes habitudes de style de codage.