目錄

• Issues Report Plugins 介紹
• Issues Report Plugins 使用
• SonarLint For IntelliJ IDEA 安裝及配置

1、Issues Report Plugins 介紹

使用 Issues Report Plugins 外掛可以為我們生成一份 HTML 格式的問題報告，對於開發人員來說是很有好處的，我們可以在改動程式碼後 Push 程式碼到倉庫前，檢測一下程式碼質量，生成問題報告，提醒自己避擴音交有明顯問題的程式碼到倉庫中，當然也可以去 SonarQube Web 上檢視詳細情況。

2、Issues Report Plugins 使用

Issues Report Plugins 外掛的使用很簡單，只需要 Maven 命令列指定引數執行即可。注意：SonarQube > 5.1 版本，該外掛已經過時了，不過我們還是直接可以使用，免安裝。5.1 版本以後由 SonarLint 替代該外掛。

mvn sonar:sonar 
    -Dsonar.analysis.mode=preview  # 設定 mode，預設為preview

    -Dsonar.issuesReport.lightModeOnly=true # 設定是否只生成新增問題的報告

    -Dsonar.issuesReport.html
 
.enable=true # 設定生成 HTML 格式的報告
    -Dsonar.issuesReport.html.name=xxxx # 設定生成 HTML 報告的檔名字
    -Dsonar.issuesReport.html.location=/xx/xx # 設定生成 HTML 報告的檔案儲存路徑

    -Dsonar.issuesReport.console.enable=true # 設定報告輸出到控制檯

當設定-Dsonar.issuesReport.html.enable=true時，該外掛預設會生成兩份 HTML 報告，一份是包含所有問題的報告 ，一份為只包含新增問題的報告 ，除非設定了-Dsonar.issuesReport.lightModeOnly=true

示例：

$ mvn sonar:sonar -Dsonar.analysis.mode=preview -Dsonar.issuesReport.html.enable=true

...
[INFO] HTML Issues Report generated: /Users/wanyang3/Documents/hwy/IdeaProjects/mavenDemo/target/sonar/issues-report/issues-report.html
[INFO] Light HTML Issues Report generated: /Users/wanyang3/Documents/hwy/IdeaProjects/mavenDemo/target/sonar/issues-report/issues-report-light.html
...

$ mvn sonar:sonar -Dsonar.analysis.mode=preview -Dsonar.issuesReport.console.enable=true

...
[INFO] 
-------------  Issues Report  -------------

        +2 issues

        +1 critical
        +1 major

-------------------------------------------
...

3、SonarLint For IntelliJ IDEA 安裝及配置

SonarLint 是為了替代上邊 Issues Report Plugins 外掛，並且更方便的整合到我們日常的開發工具裡面去。SonarLint For IntelliJ IDEA 就是專門為 IDEA 工具提供的外掛，它可以為開發人員時刻返回新的 Bug 以及其他質量問題，並且很直觀顯示在工具上邊。現在支援的語言有 Java、 JavaScript 、PHP。

SonarLint 外掛安裝也很簡單，點選 IntelliJ -> Plugins -> Browse Repositories -> 輸入 SonarLint search -> install 等待下載安裝完畢，點選 restart 重啟 IDEA即可。

設定 SonarLint 全域性配置。點選 IntelliJ -> Other Settings -> SonarLint General Settings -> Add 彈出框新增一個 New SonarQube Server，這裡我們新增之前本地搭建的 SonarQube 服務 URL：http://127.0.0.1:9000，服務別名為：my_sonarqube，下一步配置認證，可以設定 Token 或者 Login / Password，配置完成後點選 Update Binding，更新繫結資訊，最後點選 Apply 即可。注意：認證 Token 可以去 SonarQube Web 上生成一個認證 Token 或者用使用者名稱密碼登入均可。

設定 SonarLint 專案配置，點選 IntelliJ -> Other Settings -> SonarLint Project Settings -> Bind to Server，選擇剛我們配置的全域性配置 my_sonarqube，在 SonarQube project 專案列表裡面選擇對應的專案，最後點選 Apply 即可。注意：這裡的專案列表是從配置的 SonarQube 服務上拉取下來的專案，如果沒有載入，可以點選 Update project list 重新載入。

以上配置完成後，就可以愉快的使用 SonarLint 外掛了，這裡我們以 mavenDemo 專案為例，故意寫一些垃圾程式碼，看下檢測結果吧。

參考資料