Verwendung von Codierungsstandards und Plug-ins zur statischen Codeprüfung

In diesem Artikel erfahren Sie, wie Sie Codierungsstandards und Plug-ins zur statischen Codeprüfung verwenden. Es hat einen gewissen Referenzwert. Freunde in Not können sich darauf beziehen. Ich hoffe, es wird für alle hilfreich sein.

Alibaba Java Coding Guidelines

Das erste, was ich vorstelle, sind die Codierungskonventionen von Alibaba, die meiner Meinung nach jedem bekannt sind. Die Installationsmethode ist

rrree

Dieses Plug-in konzentriert sich auf Codefehler. Detaillierte Codierungsspezifikationen wurden im „Alibaba Development Manual“ definiert.

Wenn Sie alle Dateien im gesamten Projekt überprüfen möchten, können Sie die Klasse im Fenster schließen und dann die Tastenkombination Strg+Alt+Umschalt+J drücken oder Folgendes tun Betrieb wie unten gezeigt. Ctrl+Alt+Shift+J 快捷键，或者如下图操作也是可以的。

检查的结果如图所示：

如果要对单个的文件进行检查的话，可以在类上右键，选中Alibaba Coding Guidelines Analyze

CheckStyle

第二个要介绍的插件是CheckStyle插件。这个插件侧重于代码的格式检查。使用方式如下图：在checkstyle面板，点击检查按钮进行检查，也可以检查单个文件。

如上图，可以看到都是一些缩进啥的编码规范，可以不用太关注。

Findbugs

findBugs-idea的作用侧重于发现代码中可能存在的bug。它检查类或者JAR 文件，将字节码与一组缺陷模式（自带检测器）进行对比以发现可能的问题。执行Findbugs编码规约扫描PMD

(Programming Mistake Detector) 是一个开源的静态代码检查工具。PMD 支持多种语言，比如项目本身的 Java，Salesforce 相关的 Apex、VisualForce，还有 JavaScript、XML 等。PMD 对于各种语言都预设了一套代码规则，也支持开发自定义规则，可以使用 Java 类或者XPath。

选中一段代码，然后右键Run PMD->Pre Defined,这里有许多检查类型可以选择，有代码样式，设计等等。

SonarLint

最后要介绍的是SonarLint插件，这个插件和Alibaba Java Coding Guidelines插件是实际项目中用到的比较多的两个插件。下面就详细介绍一下插件的安装和使用。

安装

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

配置SonnarLint 检查地址：

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

如下图配置了sonarqube的地址

使用SonarList

配置好SonarList之后，就是使用了，SonarLint既可以对所有文件进行检查，检查全部文件的方式是：点击Analyze->Analyze All Files with SonarLint

Das Ergebnis wurde überprüft ist wie im Bild gezeigt:

Wenn Sie eine einzelne Datei überprüfen möchten, können Sie mit der rechten Maustaste auf die Klasse klicken und „Alibaba Coding Guidelines Analyze“ auswählen. In. Dieses Plugin konzentriert sich auf die Codeformatprüfung. Die Verwendung ist wie folgt: Klicken Sie im Checkstyle-Bedienfeld zum Überprüfen auf die Schaltfläche „Prüfen“, oder Sie können eine einzelne Datei überprüfen.

Wie im Bild oben gezeigt, können Sie sehen, dass sie sind alle Abkürzungen. Sie müssen den Codierungsstandards nicht allzu viel Aufmerksamkeit schenken.

Findbugs

findBugs-Idee konzentriert sich auf die Suche nach Fehlern, die möglicherweise im Code vorhanden sind. Es untersucht eine Klasse oder JAR-Datei und vergleicht den Bytecode mit einer Reihe von Fehlermustern (mit integrierten Detektoren), um mögliche Probleme zu finden. Führen Sie die Findbugs-Codierungskonvention aus, um PMD zu scannen.

(Programming Mistake Detector) ist ein Open-Source-Tool zur statischen Codeprüfung. PMD unterstützt mehrere Sprachen, wie zum Beispiel Java für das Projekt selbst, Apex und VisualForce im Zusammenhang mit Salesforce sowie JavaScript, XML usw. PMD verfügt über einen voreingestellten Satz an Codierungsregeln für verschiedene Sprachen und unterstützt auch die Entwicklung benutzerdefinierter Regeln mithilfe von Java-Klassen oder XPath.

Wählen Sie einen Code aus und klicken Sie dann mit der rechten Maustaste auf PMD ausführen->Vordefiniert. Es stehen viele Inspektionstypen zur Auswahl, einschließlich Codestil, Design usw.

SonarLint

Das Letzte, was ich vorstellen möchte, ist das

SonarLint

-Plugin. Dieses Plug-in und das

Alibaba Java Coding Guidelines🎜 sind die beiden Plug-ins, die in tatsächlichen Projekten häufiger verwendet werden. Im Folgenden wird die Installation und Verwendung des Plug-Ins ausführlich vorgestellt. 🎜🎜Installation🎜

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

🎜Konfigurieren Sie die SonnarLint-Check-Adresse: 🎜rrreee🎜Konfigurieren Sie die Adresse von Sonarqube wie unten gezeigt🎜🎜
SonarList verwenden🎜🎜Nach der Konfiguration von SonarList können Sie es verwenden. SonarLint kann alle Dateien überprüfen. So überprüfen Sie alle Dateien: Klicken Sie auf Analysieren->Alle Dateien mit SonarLint analysieren. 🎜🎜🎜🎜🎜Sie können auch eine einzelne Datei überprüfen, indem Sie im Dateibearbeitungsbereich mit der rechten Maustaste darauf klicken: 🎜🎜🎜🎜🎜Der generierte Bericht sieht wie folgt aus: Hier liegen Verstöße vor (d. h. potenzielle Fehler und Schwachstellen). Zum Beispiel: NullPointerException, die auch schlechte Code-Smells (Code Smells) aufweist. Im Allgemeinen müssen wir uns mit Problemen auf Fehlerebene befassen, und schlechte Gerüche können ignoriert werden. Ein weiterer Indikator ist die Codeduplikationsrate, also die Anzahl der Codewiederholungen innerhalb des Codes. 🎜🎜🎜🎜🎜🎜Vergleich verschiedener Plug-Ins🎜🎜🎜Der Schwerpunkt der Inspektion ist unterschiedlich🎜

Tools	Analyseobjekte	Fokus	Anwendungstechnologie
Alibaba Java Coding Guidelines	Quellcode	Codefehler	Inspektionsmechanismus ermöglicht Echtzeiterkennung Funktion
CheckStyle	Quelldatei	Formatfehler	Fehlermusterabgleich
FindBugs	Bytecode	Codefehler	Fehlermusterabgleich, Datenflussanalyse
PMD	Quellcode	Codefehler	Fehlermodus Passende
SonarList	Quellcode	Codefehler	Fehlermusterabgleich, Verarbeitung mehrerer Dimensionen

verschiedene Prüfelemente

Werkzeuge	Zweck	Prüfelemente
Alibaba Java Coding Guidelines	Scannen Sie alle potenziellen Coderisiken aus	Methodenname Parametername Mitgliedsvariable Lokale Variable Aufzählungsklasse Try-Catch
CheckStyle	Überprüfen Sie, ob die Java-Quelldatei der Codespezifikation entspricht	Javadoc-Kommentare Benennung Spezifikationstitel Importanweisungsgröße leer
FindBugs	Basierend auf dem Konzept von Bug Patterns finden Sie potenzielle Fehler in Javabytecode (.class-Datei)	NullPoint-Nullzeigerprüfung, kein unangemessenes Schließen von Ressourcen
PMD	Überprüfen Sie Java-Quelldateien auf potenzielle Probleme	Unbenutzte lokale Variablen, leere Catch-Blöcke, nicht verwendete Parameter, leere if-Anweisungen, wiederholte Importanweisungen, nicht verwendete private Methoden, bei denen es sich möglicherweise um kurze/lange Variablen und Methodennamen der Singleton-Klasse handelt
SonarList	Scannen Sie alle potenziellen Code-Gefahren. Methodenname, Parametername, Mitgliedsvariable, lokale Variable, Aufzählungsklasse, Try-Catch. Verwandte kostenlose Lernempfehlungen: Java-Grundlagen-Tutorial

Das obige ist der detaillierte Inhalt vonVerwendung von Codierungsstandards und Plug-ins zur statischen Codeprüfung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!