Comment utiliser les normes de codage et les plug-ins de vérification de code statique

Cet article vous présentera les normes de codage et comment utiliser les plug-ins de vérification de code statique. Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer. J'espère qu'il sera utile à tout le monde.

Directives de codage Java d'Alibaba

La première chose que je présente, ce sont les conventions de codage d'Alibaba. Je pense que tout le monde les connaît. La méthode d'installation est

settings->plugins里面搜索
Alibaba Java Coding Guidelines-
>install->重启Idea

Ce plug-in se concentre sur les défauts de code. Des spécifications de codage détaillées ont été définies dans le "Manuel de développement Alibaba".

Si vous souhaitez vérifier tous les fichiers de l'ensemble du projet, vous pouvez fermer la classe dans la fenêtre et appuyer sur la touche de raccourci Ctrl+Alt+Shift+J, ou vous pouvez effectuer l'opération comme indiqué ci-dessous.

Le résultat de la vérification est tel qu'indiqué sur la figure :

Si vous souhaitez vérifier un seul fichier, vous pouvez faites un clic droit sur la classe, sélectionnez Alibaba Coding Guidelines Analyze

CheckStyle

Le deuxième plug-in à être introduit est le plug-in CheckStyle. Ce plugin se concentre sur la vérification du format du code. L'utilisation est la suivante : dans le panneau de style de vérification, cliquez sur le bouton de vérification pour vérifier, ou vous pouvez vérifier un seul fichier.

Comme le montre l'image ci-dessus, vous pouvez voir qu'il existe certaines normes de codage pour l'indentation, etc., vous n'avez donc pas besoin d'y prêter trop d'attention. .

Findbugs

La fonction de findBugs-idea se concentre sur la recherche d'éventuels bugs dans le code. Il inspecte une classe ou un fichier JAR, en comparant le bytecode à un ensemble de modèles de défauts (avec des détecteurs intégrés) pour détecter d'éventuels problèmes. Exécutez l'analyse des conventions de codage Findbugs PMD

(Programming Mistake Detector) est un outil d'inspection de code statique open source. PMD prend en charge plusieurs langages, tels que Java pour le projet lui-même, Apex et VisualForce liés à Salesforce, ainsi que JavaScript, XML, etc. PMD dispose d'un ensemble prédéfini de règles de codage pour différents langages et prend également en charge le développement de règles personnalisées, à l'aide de classes Java ou XPath.

Sélectionnez un morceau de code, puis cliquez avec le bouton droit Run PMD->Pre Defined Vous avez le choix entre de nombreux types d'inspection, notamment le style de code, la conception, etc.

SonarLint

La dernière chose que je veux présenter est le plug-in SonarLint, ce plug-in et le Alibaba Java Coding Guidelines plug-in Il s'agit de deux plug-ins qui sont utilisés plus fréquemment dans les projets réels. Ce qui suit présentera en détail l’installation et l’utilisation du plug-in.

Installer

settings->plugins里面搜索
SonarLint
>install->重启Idea

Configurer SonnarLint Vérifier l'adresse :

settings->Tools->SonarLint->Settings 
中增加sonarqube的地址

Configurer l'adresse de sonarqube comme indiqué ci-dessous

Utiliser SonarList

Après avoir configuré SonarList, vous pouvez l'utiliser. SonarLint peut vérifier tous les fichiers. La façon de vérifier tous les fichiers est : cliquez sur Analyze->Analyze All Files with SonarLint.

Vous pouvez également vérifier un seul fichier. Un seul fichier peut être cliqué avec le bouton droit dans la zone d'édition de fichier :

Le rapport généré est le suivant : Il y a ici des problèmes de violation (c'est-à-dire des bogues et des vulnérabilités potentiels). Par exemple : NullPointerException, qui présente également de mauvaises odeurs de code (Code Smells). D'une manière générale, nous devons gérer les problèmes au niveau des bugs et les mauvaises odeurs peuvent être ignorées. Un autre indicateur est le taux de duplication du code, c'est-à-dire le code répété dans le code.

Comparaison de différents plug-ins

L'objectif de l'inspection est différent

工具	分析对象	侧重	应用技术
Alibaba Java Coding Guidelines	源代码	代码缺陷	Inspection机制提供实时检测功能
CheckStyle	源文件	格式缺陷	缺陷模式匹配
FindBugs	字节码	代码缺陷	缺陷模式匹配，数据流分析
PMD	源代码	代码缺陷	缺陷模式匹配
SonarList	源代码	代码缺陷	缺陷模式匹配，多个维度处理

Différents éléments de vérification

工具	目的	检查项
Alibaba Java Coding Guidelines	扫描出所有潜在的代码隐患	方法名 参数名 成员变量 局部变量 枚举类 try-catch
CheckStyle	检查Java源文件是否与代码规范相符	Javadoc注释 命名规范 标题import语句 体积大小 空白
FindBugs	基于Bug Patterns 概念，查找javabytecode（.class文件）中的潜在bug	NullPoint空指针检查，没有不合理关闭资源
PMD	检查Java源文件潜在问题	未使用的本地变量 空的catch块，未使用参数空 if语句，重复的import语句，未使用的私有方法 可能是Singleton的类 短/长变量及方法名字
SonarList	扫描出所有潜在的代码隐患	方法名 参数名 成员变量 局部变量 枚举类 try-catch

Recommandations d'apprentissage gratuites associées : Tutoriel de base Java

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!