Comment éviter les erreurs Java courantes

Devenez un développeur Java plus productif

Avec 9 millions de développeurs dans le monde*, Java (Oracle Corporation) est l'un des langages de programmation les plus populaires au monde. De nombreux cadres d'application ont été construits sur Java car c'est un langage très polyvalent qui peut exécuter des programmes sur de nombreux appareils différents qui prennent en charge l'environnement d'exécution Java (JRE) - un environnement dans lequel tous les programmes Java s'exécutent. Les communautés de développeurs sont très actives et le soutien approfondi offert aux nouveaux programmeurs contribue à sa popularité croissante.

Comme Java existe depuis longtemps, les communautés ont passé des années à développer des normes, des outils, des modèles de codage et à atténuer les erreurs courantes auxquelles les développeurs sont confrontés à maintes reprises. Toutes ces initiatives communautaires ont un objectif commun : aider les développeurs à être aussi productifs que possible lorsqu'ils développent des applications avec Java. Mais lorsqu'il s'agit d'appliquer les meilleures pratiques ou les modèles dans le code de l'application, la responsabilité incombe au développeur. L'application des bonnes pratiques est assez variée et il est donc difficile d'avoir une approche standard d'une pratique de codage lorsque les opinions diffèrent beaucoup au sein des communautés. Les développeurs ont recours à des communautés en ligne qui peuvent parfois, par inadvertance, vous donner des solutions peu sûres à vos problèmes de codage.

Pour aider les développeurs à mettre en œuvre des solutions sécurisées aux problèmes courants de codage Java, nous avons créé Sensei - un plugin IntelliJ pour corriger les mauvais modèles de codage selon une recette (ou des règles) définie par vous ou votre organisation dans un environnement professionnel. Sensei permet aux développeurs d'identifier et de corriger les erreurs Java courantes (gotchas) en un seul clic.

Continuez à lire pour savoir comment Sensei augmente la productivité des développeurs en résolvant certaines erreurs de codage Java courantes.

Une erreur récurrente qui frustre les développeurs

Un exemple de ces erreurs courantes est la vérification incorrecte de l'égalité des valeurs de l'enveloppe. Les valeurs des primitives encadrées doivent être comparées en utilisant la méthode equals au lieu de l'opérateur de comparaison de référence (==) afin d'éviter des résultats inattendus.

Par exemple, l'utilisation de l'opérateur de comparaison de référence pour des valeurs entières comprises entre -128 et 127 se comportera (généralement) de la même manière que la méthode des égalités. Toutefois, si nous effectuons la même comparaison avec des valeurs situées en dehors de cette plage, les résultats seront différents. Cela est dû au fait que Java maintient un pool constant pour la plage mentionnée de valeurs entières. L'utilisation de la méthode equals donnera toujours les résultats escomptés et constitue donc la bonne méthode de comparaison.

Dans cet exemple, nous utilisons à tort l'opérateur (==) pour vérifier l'égalité.

Ce qui donne le résultat suivant :

vrai

faux

faux

vrai

La bonne façon de comparer est d'utiliser la méthode des égalités.

Le résultat serait alors le suivant :

vrai

faux

vrai

faux

Cette meilleure pratique bien connue existe depuis un certain temps, mais elle est souvent mise en œuvre de manière incorrecte dans le code existant, attendant de lever la tête au moment le plus inopportun. Nous avons donc créé des recettes (ou règles) qui permettent d'identifier localement de tels schémas de codage indésirables et d'appliquer une correction en un seul clic à l'aide de Sensei.

Sensei est un plugin IDE hautement personnalisable qui analyse et corrige le code indésirable au fur et à mesure que vous le tapez - avec des centaines de transformations de code et de recettes de migration (règles) téléchargeables, ainsi qu'une capacité intégrée à créer vos propres recettes. Avec Sensei, les développeurs peuvent remédier aux mauvais modèles de code au fur et à mesure qu'ils tapent, afin de fournir plus rapidement un code de qualité et, en fin de compte, de l'écrire d'une manière cohérente et standardisée au sein des équipes et des projets.

Comment Sensei corrige les problèmes Java les plus courants

Comme Sensei vous permet de créer vos propres recettes, nous avons créé une recette pour corriger l'erreur susmentionnée.

Pour cet exemple, nous voulons trouver où nous utilisons l'opérateur de comparaison (==) dans le type primitif encadré.

Une recette Sensei ressemble à ceci (en YAML) :

Il est possible de rechercher le mauvais modèle récurrent au fur et à mesure que vous le tapez ou le fichier entier, la portée configurée et même la base de code complète. Une fois le modèle trouvé, l'étape suivante est naturellement de pouvoir le corriger instantanément sans avoir à chercher en ligne. Sensei vous permet de créer des corrections qui peuvent ajouter/modifier/supprimer du code comme spécifié. Vous pouvez même fournir plusieurs correctifs, ce qui permet aux développeurs de choisir le correctif le plus approprié.

Dans notre exemple, nous voulons réécrire la comparaison en utilisant la méthode equals au lieu de l'opérateur (==).

Un correctif disponible est décrit comme suit :

Comment cela fonctionne-t-il ?

Mettre en œuvre des lignes directrices de codage standard en toute simplicité

Java Gotchas Cookbook propose 22 recettes pour vous aider à éviter les erreurs courantes et à garder votre code propre et sûr. Il détecte l'utilisation incorrecte ou dangereuse de diverses fonctionnalités et API du langage Java, telles que l'égalité des objets, la gestion des exceptions, les expressions régulières et les collections. En adoptant Sensei et ce livre de recettes, vous pouvez commencer à écrire un meilleur code dès le départ et même créer vos propres recettes pour les adapter à votre équipe, votre projet ou votre organisation.

Ce n'est qu'un exemple des nombreuses façons dont Sensei peut être utilisé pour normaliser vos projets. Vous pouvez toujours être à l'affût des anti-modèles ou de certaines transformations de code manuelles que vous rencontrez fréquemment dans les demandes d'extraction ou lorsque vous codez vous-même. Si vous disposez d'un ensemble de directives de codage qui sont souvent ignorées par les développeurs, vous pouvez les convertir en recettes, ce qui permettra aux développeurs d'appliquer les transformations de code approuvées en toute confiance.

Installez Sensei maintenant et activez Java Gotchas Cookbook pour une expérience de développement productive. https://sensei.securecodewarrior.com/cookbooks/scw:java

*2021, État de la nation des développeurs, https://www.developernation.net/developer-reports/de20

‍