Sonar简介
Sonar是一个用于代码质量管理的开源平台,用于管理源代码的质量,可以从七个维度检测代码质量
通过插件形式,可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测
糟糕的复杂度分布
文件、类、方法等,如果复杂度过高将难以改变,这会使得开发人员难以理解它们, 且如果没有自动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全面的回归测试
重复
显然程序中包含大量复制粘贴的代码是质量低下的 , sonar可以展示源码中重复严重的地方
缺乏单元测试
sonar可以很方便地统计并展示单元测试覆盖率
没有代码标准
sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写
没有足够的或者过多的注释
没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降,而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷
潜在的bug
sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检测出潜在的bug
糟糕的设计(原文Spaghetti Design,意大利面式设计)
通过sonar可以找出循环,展示包与包、类与类之间的相互依赖关系,可以检测自定义的架构规则;
通过sonar可以管理第三方的jar包可以利用LCOM4检测单个任务规则的应用情况 ,检测耦合
Sonar 组成
Sonar 集成过程
- 开发人员在他们的ide中使用SonarLint运行分析本地代码。
- 开发人员将他们的代码提交到代码管理平台中(SVN,GIT等)
- 持续集成工具自动触发构建,调用SonarScanner对项目代码进行扫描分析
- 分析报告发送到SonarQube Server中进行加工
- SonarQube Server 加工并且保存分析报告到SonarQube Database中,通过UI显示分析报告
centos安装sonarqube7.7
1、准备
SonarQube版本:sonarqube-7.7.0.zip,官网地址:https://www.sonarqube.org/downloads/
jdk版本:jdk-1.8.0_linux-x64_bin.tar.gz(注:sonarqube从7.9起,不再支持jdk11以下版本)
数据库:mysql5.6-5.7(sonarqube从7.8起,不再支持mysql)(功能验证也可以SonarQube内置的数据库,这样就不需要改数据库配置
2、安装jdk1.8
详见:linux安装jdk8
3、解压SonarQube
yum install -y zip unzip // 安装解压工具
unzip /home/data/soft/sonarqube/sonarqube-7.7.zip
4、修改 /home/data/soft/sonarqube/sonarqube-7.7/conf/sonar.properties 文件,更改数据连接配置
sonar.jdbc.url=jdbc:mysql://192.168.1.165:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
sonar.jdbc.username=root
sonar.jdbc.password=root
5、创建SonarQube启动用户(SonarQube内置了elasticsearch,elasticsearch不允许使用root用户启动)
useradd sonar
passwd sonar
7、设置系统参数(elasticsearch启动需要设置一些参数)
详细见:elasticsearch启动常见错误
未设置这些参数在$SONARQUBE_HOME/logs/es.log中出现以下错误:
8、赋予启动用户执行权限
chown -R sonar:sonar /home/data/soft/sonarqube/sonarqube-7.7
9、登陆启动用户,启动程序
su - sonar // 以sonarqube用户登陆
cd /usr/local/sonarqube-7.9.1/bin/linux-x86-64 // 进入启动命令目录
./sonar.sh start // 启动程序
10、登陆http://192.168.1.224:9000访问,默认用户名/密码为:admin/admin
11、安装中文语言包
登录后, 打开 Administration → Marketplace
, 搜索 chinese pack
, 点击 install
会提示重启系统, 选择 Restart
注:如何 Intall 出错可以直接去官网下载jar包。上传到到服务器 /home/data/soft/sonarqube/sonarqube-7.7/extensions/downloads 目录下,并重启sonarqube服务即可。
12、常用命令:
service sonar start // 启动服务
service sonar stop // 关闭服务
service sonar restart // 重启服务
chkconfig sonar on // 设置开机启动
chkconfig sonar off // 关闭开机启动
Jenkins中使用sonar扫描java项目
安装sonar插件
由于安装插件需要翻墙,有可能无法安装成功,这里提供插件sonar.hpi,选择离线上传同样可以安装。
sonar.hpi:链接: https://pan.baidu.com/s/11L_uon8gakmZHoc_xTI1gQ 提取码: g9pw
sonar插件配置
系统设置
全局配置
在原项目上增加Excute Sonarqube Scanner
Scanner Analysis properties
sonar.projectKey=$JOB_NAME
sonar.projectName=$JOB_NAME
sonar.projectVersion=1.0
sonar.sourceEncoding=UTF-8
sonar.language=java
sonar.login=admin
sonar.password=admin
sonar.java.binaries=$WORKSPACE/iot-network/iot-netty-route/target/classes/
构建成功
IDEA中使用插件sonarlint连接到SonarQube对代码质量进行管控
sonarLint插件安装
File–Setting-Plugin 输入SonarLint搜索插件
配置插件
1、配置Token
打开本地SonarQube管理后台,输入账户密码,默认admin/admin
创建项目
在上面画圈的任意一处,点击新建项目
创建令牌
获得令牌
分析你的项目–选择Maven
插件安装成功以后,打开插件配置界面,路径:File–Tools
打开SonarLint General Settings,按照下图输入
把上一步的token输入(写博客截图,忘记保存了token,下面是错误的)
2、绑定到当前项目
打开SonarLint Project Settings
connection选择刚刚的配置“sonarqube”,选择我们刚刚创建的项目
项目全局分析
Terminal中执行
mvn sonar:sonar \
-Dsonar.projectKey=test-project \
-Dsonar.host.url=http://192.168.1.224:9000 \
-Dsonar.login=78e2f0ea396d9cd941d77a3f14429a566c951a34
登录SonarQube管理后台 http://192.168.1.224:9000后台效果,查看质检效果