Conventions de codage Java. Lesquelles suivre et pourquoi

Connaître et suivre les normes et les meilleures pratiques de l'industrie est très important dans tous les domaines, et en particulier dans la programmation avec son mélange complexe et parfois chaotique de langages de codage, d'outils, d'approches et de technologies. C'est pourquoi un programmeur Java professionnel doit bien connaître les conventions de codage Java, dont nous allons parler aujourd'hui.

Quelles sont les conventions de codage ?

Les conventions de codage sont des ensembles de directives pour chaque langage de programmation spécifique avec des recommandations sur différents aspects du développement logiciel dans ce langage, y compris le style de codage, les meilleures pratiques et les méthodes. Les conventions de codage sont censées être suivies par les programmeurs de logiciels qui codent dans ce langage en tant que guides de qualité pour s'assurer que leur code est lisible et que la maintenance appropriée du logiciel par d'autres personnes est possible. Les conventions de codage couvrent normalement tous les composants essentiels de la création de logiciels dans ce langage de programmation, y compris l'organisation des fichiers, l'indentation, les commentaires, les déclarations, les déclarations, les espaces blancs, les conventions de dénomination, les pratiques de programmation, les principes de programmation, les règles empiriques de programmation, les meilleures pratiques architecturales, etc. .

A quoi servent les conventions de codage ?

Il existe un certain nombre de raisons pour lesquelles les conventions de codage jouent un rôle important dans le développement de logiciels.

• Maintenir un style de code unifié

Le respect d'une convention de codage permet au projet logiciel d'être écrit dans un seul style unifié, ce qui est bénéfique de plusieurs manières différentes, telles que les suivantes.

• Minimiser les coûts de maintenance des logiciels

L'un des plus importants est de faciliter la maintenance et le support du produit logiciel, car très souvent les auteurs originaux du programme ne sont pas ceux qui le supportent. Ceci est important car 80% du coût de la durée de vie d'un logiciel est consacré à la maintenance.

• Amélioration de la lisibilité du logiciel

L'amélioration de la lisibilité du logiciel est un autre avantage majeur, qui a également de multiples implications telles que la simplification de l'introduction de nouveaux développeurs dans le projet et l'augmentation de l'efficacité de la collaboration des membres de l'équipe de développement.

• Accélérer le travail

Enfin, avoir un code correctement écrit et structuré est nécessaire pour que le processus de développement logiciel aille aussi vite que possible.

Conventions de codage Java

En ce qui concerne Java, il existe deux conventions de codage les plus courantes et les plus connues : les conventions de code Java d'Oracle et la convention de codage Java Style Guide de Google .

• Convention de code Java d'Oracle

La convention de code d'Oracle est reconnue comme la plus importante pour un certain nombre de raisons évidentes : la convention d'Oracle est la convention officielle car Oracle est le propriétaire de Java, ainsi que l'une des plus anciennes (la dernière révision de ce document a été faite le 20 avril 1999). Certaines des parties importantes de la convention de code Java d'Oracle seraient la recommandation d'utiliser la casse camel lors de la définition de classes, de méthodes ou de variables, de commencer les classes par une lettre majuscule et d'utiliser des noms pour les nommer, tout en utilisant des verbes à la forme impérative et en commençant d'une lettre minuscule pour les méthodes, et ainsi de suite.

• Guide de style Java de Google

Les conventions de codage Java de Google sont considérées comme importantes en raison du statut de Google en tant que société d'apprentissage de l'Internet et de la technologie avec une énorme expérience dans le développement de toutes sortes d'applications Java. Une autre raison importante est le fait que la convention de code Java de Google a été mise à jour le 22 mai 2018, ce qui la rend plus pertinente que la convention de code d'Oracle, en particulier lorsqu'il s'agit de décrire des fonctionnalités relativement nouvelles de Java qui n'ont été publiées que dans le cadre de Java 8. en 2014, tels que les lambdas et les flux. Voici comment les auteurs du Java Style Guide de Google décrivent le contenu de cette convention de codage : « Ce document sert de définition complète des normes de codage de Google pour le code source en Java. Comme d'autres guides de style de programmation, les problèmes couverts couvrent non seulement les problèmes esthétiques de formatage, mais aussi d'autres types de conventions ou de normes de codage. Cependant, ce document se concentre principalement sur les règles strictes que nous suivons universellement et évite de donner des conseils qui ne sont pas clairement applicables (que ce soit par un humain ou un outil). "Le Google Java Style Guide est une bonne référence pour la plupart, mais il est un peu permissif sur certains sujets. D'autre part, en tant que programmeur Java, vous devez être habitué à 4 espaces pour l'indentation du code, entre autres choses », a déclaré David Rios, architecte logiciel et programmeur Java expérimenté, dans un LinkedIn mais c'est un peu permissif sur certains sujets. D'autre part, en tant que programmeur Java, vous devez être habitué à 4 espaces pour l'indentation du code, entre autres choses », a déclaré David Rios, architecte logiciel et programmeur Java expérimenté, dans un LinkedIn mais c'est un peu permissif sur certains sujets. D'autre part, en tant que programmeur Java, vous devez être habitué à 4 espaces pour l'indentation du code, entre autres choses », a déclaré David Rios, architecte logiciel et programmeur Java expérimenté, dans un LinkedInpost avec quelques propositions d'adaptations à son propre Guide de style Java de Google.

Normes de codage Java les plus utilisées

Voici quelques-unes des normes de codage Java les plus utilisées que l'on peut trouver dans les conventions de codage mentionnées ci-dessus d'Oracle et de Google, ainsi que dans d'autres documents de ce type.

• Suivez la convention de dénomination appropriée ;
• Ajoutez des commentaires;
• Identificateur signifie un nom symbolique qui fait référence au nom des classes, des packages, des méthodes et des variables dans un programme Java ;
• Le nom de la variable doit être lié à son objectif ;
• Le nom de la méthode doit se rapporter à la fonctionnalité de la méthode ;
• La méthode ne doit pas contenir plus de 50 lignes ;
• Il ne doit pas y avoir de code en double dans la même classe ou dans une autre classe ;
• Déclarez les variables globales uniquement si nécessaire pour les utiliser dans les autres méthodes ;
• Vérifiez la création de variables statiques à l'intérieur d'une classe ;
• Évitez d'accéder directement aux variables à partir d'autres classes, utilisez plutôt les méthodes getter et setter ;
• Toute la logique métier doit être gérée dans la classe de service uniquement ;
• Tout le code lié à la base de données doit se trouver uniquement dans les classes DAO ;
• Utilisez des getters et des setters ;
• Déclarez la variable d'instance comme privée ;
• Gardez la portée des variables minimale ;
• Attribuez des noms significatifs aux variables ;
• Évitez les fuites de mémoire en libérant les connexions à la base de données lorsque l'interrogation est terminée ;
• Essayez d'utiliser le bloc Enfin aussi souvent que possible ;
• Utilisez le framework Executor pour la programmation multithread.