sonarqube(Sonar)使⽤⽅法
Sonar简介
Sonar是⼀个⽤于代码质量管理的开源平台,⽤于管理源代码的质量,可以从七个维度检测代码质量
通过插件形式,可以⽀持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等⼆⼗⼏种编程语⾔的代码质量管理与检测sonarQube能带来什么?
Developers' Seven Deadly Sins
1.糟糕的复杂度分布
⽂件、类、⽅法等,如果复杂度过⾼将难以改变,这会使得开发⼈员难以理解它们,
且如果没有⾃动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全⾯的回归测试
2.重复
显然程序中包含⼤量复制粘贴的代码是质量低下的
sonar可以展⽰源码中重复严重的地⽅
3.缺乏单元测试
sonar可以很⽅便地统计并展⽰单元测试覆盖率
4.没有代码标准
sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测⼯具规范代码编写
5.没有⾜够的或者过多的注释
没有注释将使代码可读性变差,特别是当不可避免地出现⼈员变动时,程序的可读性将⼤幅下降
⽽过多的注释⼜会使得开发⼈员将精⼒过多地花费在阅读注释上,亦违背初衷
6.潜在的bug
sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测⼯具检测出潜在的bug
7.糟糕的设计(原⽂Spaghetti Design,意⼤利⾯式设计)
通过sonar可以出循环,展⽰包与包、类与类之间的相互依赖关系
可以检测⾃定义的架构规则
通过sonar可以管理第三⽅的jar包
可以利⽤LCOM4检测单个任务规则的应⽤情况
检测耦合
通过sonar可以有效检测以上在程序开发过程中的七⼤问题
SonarQube安装
预置条件
1.已安装JAVA环境
2.已安装有MySQL数据库
1.数据库配置
进⼊数据库命令
#mysql -u root -p
mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
mysql> FLUSH PRIVILEGES;
2.安装sonar与sonar-runner
将下载的sonar-3.7.zip包解压⾄Linux某路径如/usr/local
将下载的sonar-runner-dist-2.3.zip包解压某路径/usr/local
添加SONAR_HOME、SONAR_RUNNER_HOME环境变量,并将SONAR_RUNNER_HOME加⼊PATH
修改sonar配置⽂件
编辑<install_directory>/conf/sonar.properties⽂件,配置数据库设置,默认已经提供了各类数据库的⽀持
这⾥使⽤mysql,因此取消mysql模块的注释
#vi sonar.properties
[java] view plain copy
sonar.jdbc.username: sonar
sonar.jdbc.password: sonar
sonar.jdbc.url: jdbc:mysql://localhost:3306/sonar?
useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true
# Optional properties
sonar.jdbc.driverClassName: sql.jdbc.Driver
修改sonar-runner的配置⽂件
切换⾄sonar-runner的安装⽬录下,修改sonar-runner.properties
根据实际使⽤数据库情况取消相应注释
[java] view plain copy
3.添加数据库驱动
除了Oracle数据库外,其它数据库驱动都默认已经提供了,且这些已添加的驱动是sonar唯⼀⽀持的,因此不需要修改如果是Oracle数据库,需要复制JDBC驱动⾄<install_directory>/extensions/jdbc-driver/oracle⽬录
4.启动服务
⽬录切换⾄sonar的<install_directory>/bin/linux-x86-64/⽬录,启动服务
#./sonar.sh start 启动服务
#./sonar.sh stop 停⽌服务
#./sonar.sh restart 重启服务
⾄此,sonar就安装好了
访问http:\\localhost:9000即可
5.sonar中⽂补丁包安装
中⽂包安装
安装中⽂补丁包可以通过访问http:\\localhost:9000,打开sonar后,进⼊更新中⼼安装
或者下载中⽂补丁包后,放到SONARQUBE_HOME/extensions/plugins⽬录,然后重启SonarQube服务
sonar作为Linux服务并开机⾃启动
新建⽂件/etc/init.d/sonar,输⼊如下内容:
[java] view plain copy
#!/bin/sh
#
# rc file for SonarQube
#
# chkconfig: 345 96 10
# description: SonarQube system ()
#
### BEGIN INIT INFO
# Provides: sonar
# Required-Start: $network
# Required-Stop: $network
# Default-Start: 3 4 5
# Default-Stop: 0 1 2 6
# Short-Description: SonarQube system ()
# Description: SonarQube system ()
### END INIT INFO
/usr/bin/sonar $*
SonarQube开机⾃启动(Ubuntu, 32位):
sudo ln -s $SONAR_HOME/bin/linux-x86-32/sonar.sh /usr/bin/sonar
sudo chmod 755 /etc/init.d/sonar
sudo update-rc.d sonar defaults
SonarQube开机⾃启动(RedHat, CentOS, 64位):
sudo ln -s $SONAR_HOME/bin/linux-x86-64/sonar.sh /usr/bin/sonar
sudo chmod 755 /etc/init.d/sonar
sudo chkconfig --add sonar
使⽤SonarQube Runner分析源码
预置条件
已安装SonarQube Runner且环境变量已配置,即sonar-runner命令可在任意⽬录下执⾏
1.在项⽬源码的根⽬录下创建sonar-project.properties配置⽂件
以android项⽬为例:
[java] view plain copy
sonar.projectKey=android-sonarqube-runner
sonar.projectName=Simple Android project analyzed with the SonarQube Runner sonar.projectVersion=1.0
sonar.sources=src
sonar.binaries=bin/classes
sonar.language=java
sonar.sourceEncoding=UTF-8
sonar.profile=Android Lint
注:要使⽤Android Lint
规则分析需要先访问http:\\localhost:9000更新中⼼添加Android Lint插件,使其可以分析Android Lint规则
2.执⾏分析
切换到项⽬源码根⽬录,执⾏命令
# sonar-runner
分析成功后访问http:\\localhost:9000即可查看分析结果
与IDE关联
最后,当然了,得与IDE相关联,才能更⽅便地实时查看
mysql下载jar包附:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论