Java代碼規范與質量檢測插件SonarLint的使用

1.SonarLint

SonarLint是一個代碼質量檢測插件,可以幫助我們檢測出代碼中的壞味道

下載與安裝

在需要檢測的單個文件或者單個項目上右鍵 –> Analyze –> Analyze with SonarLint

或者選中文件或目錄,點擊菜單欄 Analyze –> Analyze with SonarLint

我們還可以禁用某些規則

如果需要同步自定義的規則時,可以綁定到SonarQube

查看檢測的結果

對於代碼中的警告我們不能視而不見

有瞭代碼質量檢測工具以後,在一定程度上可以保證代碼的質量

對於每一個問題,SonarLint都給出瞭示例,還有相應的解決方案,教我們怎麼修改,極大的方便瞭我們的開發

比如,對於日期類型盡量用LocalDate、LocalTime、LocalDateTime,還有重復代碼、潛在的空指針異常、循環嵌套等等問題

有瞭代碼規范與質量檢測工具以後,很多東西就可以量化瞭,比如bug率、代碼重復率等,還可以自定義各種指標,方便管理人員查看

為此,我們需要一個平臺來記錄每次檢測分析的結果,這樣就可以進行分析和統計,並且可以直觀的看到這一切

於是,SonarQube 閃亮登場!

2. SonarQube

SonarQube是一個開源的代碼質量管理平臺

解壓&本地啟動

https://docs.sonarqube.org/latest/setup/get-started-2-minutes/

unzip sonarqube-7.7.zip
cd sonarqube-7.7
bin/[OS]/sonar.sh consol

啟動成功後,訪問http://localhost:9000 用管理員賬號(admin/admin)登錄

接下來,為瞭把檢測的結果傳到服務器,我們需要配置一個Scanner

https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Maven

這裡我在項目中添加sonar-maven-plugin 插件

<build>
    <plugins>
        <plugin>
            <groupId>org.sonarsource.scanner.maven</groupId>
            <artifactId>sonar-maven-plugin</artifactId>
            <version>3.6.0.1398</version>
        </plugin>
    </plugins>
</build>

命令行執行:mvn clean compile sonar:sonar

成功後,可以在控制臺中看到這樣的輸出

再次刷新 http://localhost:9000/ 會看到跟剛才不一樣瞭

以上隻是本地演示,在正式環境中這些數據當然要保存到數據庫中,具體安裝就不演示瞭,下面是文檔

https://docs.sonarqube.org/latest/setup/install-server/

3. Alibaba代碼規約插件

阿裡代碼規范,相信大傢都不陌生

4. 文檔

https://www.sonarqube.org/

https://www.sonarsource.com/plans-and-pricing/community/

https://www.sonarlint.org/

https://docs.sonarqube.org/latest/setup/overview/

https://docs.sonarqube.org/latest/

https://github.com/SonarSource/sonar-scanning-examples/tree/master/sonarqube-scanner-maven

https://github.com/SonarSource

到此這篇關於Java代碼規范與質量檢測插件SonarLint的使用的文章就介紹到這瞭,更多相關Java SonarLint內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: