一 手冊說明
本篇使用手冊是一篇關於 SonarLint 插件的使用手冊,詳細闡述了 SonarLint 綁定服務器、SonarLint 分析項目的使用方法,手冊仍然處於不斷完善的過程中。
二 SonarLint簡介
官網地址: https://www.sonarlint.org/
SonarLint是一個IDE插件,可幫助開發人員在編寫代碼時檢測和修復質量問題。就像拼寫檢查器一樣,SonarLint也會在提交代碼之前對錯誤進行修正。開發人員可以直接從IDE市場獲得它,然後它將在編碼時(Java、JavaScript、PHP、Python和HTML)檢測新的bug和質量問題。
三 eclipse安裝使用SonarLint插件
1)Eclipse 的 MarkPlace 中查詢並安裝 SonarLint 插件。more info中查看requirements——SonarLint要求Eclipse使用Java 8+作爲運行環境,但是可以分析針對舊Java版本的Java項目。
2)配置連接sonarqube server。右鍵項目名稱——sonarlint——bind to sonarqube
自定義connection name
配置成功
新增的窗口
3)在分析代碼前需要綁定sonarqube中的項目,所以需要在sonarqube server上創建一個項目(最好是同名)
項目綁定成功之後可以在sonarlint bindings窗口中看見相應的項目名稱:
然後就可以做本地代碼分析了:分析全部代碼則在項目處右鍵選擇sonarlint analyze,分析部分代碼則在想要分析的.java文件處右鍵選擇
sonarlint analyze即可!
分析結束之後能夠在sonarlint report中看到報告。點擊報告的每條內容即可自動跳轉到報告指出有問題的部分,從而可以進行修改。
4)在使用 SonarLint 的時候,基於語言的配置使用的是 Sonarqube 默認配置。以 java 爲例,改變配置後,eclipse 中執行 SonarLint Analyze 時,
分析代碼時仍舊使用的是原先的配置,則會導致代碼檢測標準出現不一致。
爲保持 SonarQube 服務器和 Eclipse 保持配置信息的一致,每次 SonarQube 服務器更新配置後,用戶應及時更新。