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