一逗余、sonarqube介紹
sonarqube管理代碼質(zhì)量一個開放平臺呼巴,用于檢測是否代碼冗余、隱藏bug以及技術(shù)債等患民。不僅可以顯示應(yīng)用程序的健康狀況缩举,還可以突出新引入的問題。有了sonarqube匹颤,您就可以修復(fù)bug仅孩,從而系統(tǒng)地提高代碼質(zhì)量。
github地址
二印蓖、sonarcloud使用
1辽慕、sonarcloud登錄
sonarcloud地址可以使用github賬號登錄。
2赦肃、創(chuàng)建project
注意:sonarcloud對開源項目分析是免費的溅蛉,如果想測試私有項目,則需要付費摆尝。3温艇、生成token
上一步信息填寫完成后點擊set up即可到這個頁面。創(chuàng)建新的token或者使用已有token堕汞。這里我們一般選擇已有token勺爱,因為在分析完代碼之后,我們做完修改之后再次提交分析讯检,使用已有token時分析的還是同一個project琐鲁,不然每次都會創(chuàng)建新的project。
點擊user account生成唯一token人灼。
輸入token name 點擊Generate生成token围段。將token保存起來,因為這個token無法再推出之后查到投放,而我們再次提交分析時也會使用這個token奈泪。 將剛剛生成的token復(fù)制到輸入框之后點擊Continue進入下一步
4、環(huán)境配置
接著我們需要下載兩個插件灸芳,點擊Download即可涝桅。
插件下載完成后解壓,配置環(huán)境變量烙样。
yellow@jiangchongdeMacBook-Pro ~ cd /Users/yellow/Documents/bin/sonarcloud
yellow@jiangchongdeMacBook-Pro ~/Documents/bin/sonarcloud ls
// 下載解壓之后的文件夾
build-wrapper sonar-scanner
yellow@jiangchongdeMacBook-Pro ~/Documents/bin/sonarcloud cd build-wrapper
yellow@jiangchongdeMacBook-Pro ~/Documents/bin/sonarcloud/build-wrapper pwd
// build-wrapper-macosx-x86的路徑
/Users/yellow/Documents/bin/sonarcloud/build-wrapper
yellow@jiangchongdeMacBook-Pro ~/Documents/bin/sonarcloud/build-wrapper cd ../sonar-scanner/bin
yellow@jiangchongdeMacBook-Pro ~/Documents/bin/sonarcloud/sonar-scanner/bin pwd
// sonar-scanner的路徑
/Users/yellow/Documents/bin/sonarcloud/sonar-scanner/bin
下載完成之后冯遂,查看build-wrapper-macosx-x86和sonar-scanner的路徑。
// 編輯環(huán)境配置文件
yellow@jiangchongdeMacBook-Pro ~ cd ~
yellow@jiangchongdeMacBook-Pro ~ vim ./.bash_profile
// 將之前得到的路徑配置進去谒获,并保持退出
export PATH=/Users/yellow/Documents/bin/sonarcloud/sonar-scanner/bin:$PATH
export PATH=/Users/yellow/Documents/bin/sonarcloud/build-wrapper:$PATH
// 使環(huán)境配置立即生效
yellow@jiangchongdeMacBook-Pro ~ source ./.bash_profile
到這里環(huán)境配置就完成了蛤肌,此步驟只需要操作一次壁却。
5、分析代碼
進入到想要分析的代碼路徑下裸准,分別執(zhí)行命令展东。
// 最后幾行的輸出結(jié)果,表示分析成功
INFO: Analysis total time: 47.597 s
INFO: ------------------------------------------------------------------------
INFO: EXECUTION SUCCESS
INFO: ------------------------------------------------------------------------
INFO: Total time: 21:03.234s
INFO: Final Memory: 44M/802M
INFO: ------------------------------------------------------------------------
注意:第一次分析時會比較慢炒俱,因為還需要下載相應(yīng)插件琅锻,請耐心等待,之后就會比較快了向胡。
6、查看分析結(jié)果
點擊My Projects可以看到分析結(jié)果惊完。如圖表示我們的代碼非常完美僵芹,沒有任何問題。
點擊項目可查看更詳細的報告小槐,如果有問題也會有標注拇派,這里就不過多介紹了。
7凿跳、檢測規(guī)則介紹
Objective-C 檢測規(guī)則一共有235個有個規(guī)則比較奇葩件豌,需要注釋量達到代碼量的25%.... 條件很苛刻,當然25%這個閾值可以修改的控嗜,大家按需求添加規(guī)則即可茧彤。
三、結(jié)語
通過sonarcloud疆栏,可以很方便的檢測我們代碼里的問題曾掂,技術(shù)債時長,與哪段代碼存在重復(fù)等壁顶,而且還會標注出這段代碼的作者珠洗,這樣對于大型項目的質(zhì)量管理就會非常簡潔方便。當然了若专,還有很多強大的功能本篇文章沒有介紹许蓖,需要大家自己去挖掘。