前言碎语
博主所在公司是个创业公司,项目开发是典型的敏捷迭代模式,快速开发上线,后面再持续迭代需求。项目秩序迭代到一定阶段后,发现留下了很多代码质量方面的技术栈。下面博主会使用sonarqube详细介绍并搭建一个代码可持续优化的质量管控平台,解决这些问题。
sonarqube是什么?
sonarqube是一个开源的代码质量管控平台,代码检测规则可定制,支持java,C++等语言的代码质量检测。权限体系完善。周边插件非常丰富,基于这些周边产品可以很轻松的搭建一套完整的可持续优化的代码质量管控平台。
平台流程走向如下:
1..jenkins上持续集成时,使用jenkins的sonar插件,将扫描结果上传到sonarqube平台,sonarqube平台有各种视图展示扫描结果,如图。所有问题可以指定到人
2.开发认领到自己的代码质量问题后,通过IDEA插件,可以在次检测下,直到修复完成提交,如图:
环境搭建
sonarqube安装
官网地址:https://www.sonarqube.org/#_
下载好安装包解压后结构如下:
我们需要关注两个目录,bin,conf,bin目录下有系统对应的启动脚本,Windows下除了启动脚本外,还提供了注册成service的脚本,和卸载service的脚本。conf下包含了sonarqube本身的配置信息,如端口号(默认9000),数据库(默认H2),elasticSeach(默认9001)。一般情况下我们需要修改下数据源的配置即可
注意点:sonarqube需要jkd1.8的支持
启动服务,配置好配置信息后,执行bin目录下对应平台的启动脚本即可,打开http://localhost:9000会看到如下界面
插件安装
sonarqube插件很多,基于插件扩展,可以支持更多的语言的代码检测,如js等。这里实例下中文插件Chinese Pack的安装
Chinese Pack插件项目地址:https://github.com/SonarQubeCommunity/sonar-l10n-zh。
插件安装可能会失败,提示未设置代理地址,下载不下来,这个时候可以参考下面的方法也行。
除了如上可在sonarqube平台上直接安装外,还可以从如上项目地址下载插件,是一个jar包。放到sonarqube-5.6.7\data\web\deploy\plugins这个目录下即可
jenkins插件安装
1.在jenkins系统配置中,找到插件管理,搜索sonar,插件全称是:SonarQube Scanner for Jenkins。对应的版本如下:
SonarQube Scanner for Jenkins
Jenkins
2.设置sonarqube服务
2.1
2.2.1
2.3
2.4
2.5 - 2.7
1.491+
1.580.1+
1.587+
1.587+
1.651+
进入系统设置,设置好sonarqube服务信息,如图
3.构建任务中,添加构建执行sonarqube扫描
安装IDEA插件
安装IDEA插件是为了方便解决扫描出来的问题,达到更好的持续优化的效果。插件中心搜索sonarlint,安装好后,左下角就会出现SonarLint。点击如下图所示标志就可以配置sonarServer的信息了。
sonar支持账号密码和token两种验证方式。token方式,可以到sonarqube平台的用户中心生成,如下图
最后结语
码这么一篇教程不易啊,可能流程并没有描述清楚,有啥问题可在留言区直接留言。sonarqube质量平台功能很强大,osc码云平台也使用了sonar作为代码质量检测。搭建这样的一个平台只要是为了持续优化团队的代码质量,相信经过修复sonarqube提示问题后,团队整体代码质量写作习惯会有质的飞越。