一、sonarqube介绍
sonarqube管理代码质量一个开放平台,用于检测是否代码冗余、隐藏bug以及技术债等。不仅可以显示应用程序的健康状况,还可以突出新引入的问题。有了sonarqube,您就可以修复bug,从而系统地提高代码质量。
github地址
二、sonarcloud使用
1、sonarcloud登录
sonarcloud地址可以使用github账号登录。
2、创建project
注意:sonarcloud对开源项目分析是免费的,如果想测试私有项目,则需要付费。3、生成token
上一步信息填写完成后点击set up即可到这个页面。创建新的token或者使用已有token。这里我们一般选择已有token,因为在分析完代码之后,我们做完修改之后再次提交分析,使用已有token时分析的还是同一个project,不然每次都会创建新的project。
点击user account生成唯一token。
输入token name 点击Generate生成token。将token保存起来,因为这个token无法再推出之后查到,而我们再次提交分析时也会使用这个token。 将刚刚生成的token复制到输入框之后点击Continue进入下一步
4、环境配置
接着我们需要下载两个插件,点击Download即可。
插件下载完成后解压,配置环境变量。
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的路径。
// 编辑环境配置文件
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
// 使环境配置立即生效
yellow@jiangchongdeMacBook-Pro ~ source ./.bash_profile
到这里环境配置就完成了,此步骤只需要操作一次。
5、分析代码
进入到想要分析的代码路径下,分别执行命令。
// 最后几行的输出结果,表示分析成功
INFO: Analysis total time: 47.597 s
INFO: ------------------------------------------------------------------------
INFO: EXECUTION SUCCESS
INFO: ------------------------------------------------------------------------
INFO: Total time: 21:03.234s
INFO: Final Memory: 44M/802M
INFO: ------------------------------------------------------------------------
注意:第一次分析时会比较慢,因为还需要下载相应插件,请耐心等待,之后就会比较快了。
6、查看分析结果
点击My Projects可以看到分析结果。如图表示我们的代码非常完美,没有任何问题。
点击项目可查看更详细的报告,如果有问题也会有标注,这里就不过多介绍了。
7、检测规则介绍
Objective-C 检测规则一共有235个有个规则比较奇葩,需要注释量达到代码量的25%.... 条件很苛刻,当然25%这个阈值可以修改的,大家按需求添加规则即可。
三、结语
通过sonarcloud,可以很方便的检测我们代码里的问题,技术债时长,与哪段代码存在重复等,而且还会标注出这段代码的作者,这样对于大型项目的质量管理就会非常简洁方便。当然了,还有很多强大的功能本篇文章没有介绍,需要大家自己去挖掘。