如何使用編碼規格與靜態程式碼檢查插件

本篇文章為大家介紹編碼規範與靜態程式碼檢查外掛程式的使用方法。有一定的參考價值，有需要的朋友可以參考一下，希望對大家有幫助。

Alibaba Java Coding Guidelines

首先介紹的是阿里巴巴的程式碼規約，相信大家對這個都比較熟悉了。安裝方式是在

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

這個外掛專注於程式碼的缺陷，詳細的編碼規格在《阿里開發手冊》已經定義，大家有興趣的可以看看。

如果要檢查整個專案所有文件的話，可以關閉視窗中的類，然後按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里面搜索
SonarLint
>install->重启Idea

設定SonnarLint 檢查位址：

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

如下圖設定了sonarqube的位址

##使用SonarList

#配置SonarList之後，就是使用了，SonarLint既可以對所有文件進行檢查，檢查全部文件的方式是：點擊

Analyze->Analyze All Files with SonarLint。

又可以單一檔案檢查，單一檔案就是在檔案編輯區右鍵選取：

產生的報表如下：這裡既有違規的問題(即潛在的Bugs & Vulnerabilities)。例如：NullPointerException，又有程式碼的壞味道（Code Smells）。一般而言Bug等級的問題需要我們處理，壞味道可以忽略。還有另一個指標就是程式碼的重複率，也就是程式碼內部的重複程式碼。

各類別外掛程式的比較

#檢查重點不同

##程式碼缺陷缺陷模式匹配SonarList原始碼#代碼缺陷缺陷模式匹配，多個維度處理

工具	分析物件	專注	#應用技術
Alibaba Java Coding Guidelines	原始碼	程式碼缺陷	Inspection機制提供即時偵測功能
CheckStyle	原始檔	格式缺陷	缺陷模式符合
#FindBugs	字節碼	程式碼缺陷	缺陷模式匹配，資料流分析
PMD	原始碼

檢查項目不同

#工具目的檢查項目Alibaba Java Coding Guidelines掃描所有潛在的程式碼隱患方法名稱參數名稱成員變數局部變數列舉類別try -catchCheckStyle檢查Java原始檔是否與程式碼規格相符Javadoc註解命名規格標題import語句體積大小空白#FindBugs基於Bug Patterns 概念，尋找javabytecode（.class檔案）中的潛在bugNullPoint空指標檢查，沒有不合理關閉資源PMD檢查Java來源檔案潛在問題未使用的本機變數空的catch區塊，未使用參數空if語句，重複的import語句，未使用的私有方法可能是Singleton的類別短/長變數及方法名稱#SonarList掃描所有潛在的程式碼隱患方法名稱參數名稱成員變數局部變數枚舉類別try-catch

#相關免費學習推薦：##java基礎教學

以上是如何使用編碼規格與靜態程式碼檢查插件的詳細內容。更多資訊請關注PHP中文網其他相關文章！