一、SonarQube的介绍
1、SonarQube的介绍 :
SonarQube是一个管理代码质量的开放平台。
可以从七个维度检测代码质量(为什么要用SonarQube):
(1) 复杂度分布(complexity) :代码复杂度过高将难以理解、难以维护
(2) 重复代码(duplications) :程序中包含大量复制粘贴的代码是质量低下的表现
(3) 单元测试(unit tests) :统计并展示单元测试覆盖率
(4) 编码规范(coding rules) :通过Findbugs,PMD,CheckStyle等规范代码编写
(5) 注释(comments) :少了可读性差,多了看起来费劲
(6) 潜在的Bug(potential bugs) :通过Findbugs,PMD,CheckStyle等检测潜在的bug
(7) 结构与设计(architecture & design) :依赖、耦合等
Sonar 可以集成不同的测试工具、代码分析工具、持续集成工具、IDE。
Sonar通过对代码质量分析结果数据进行再加工处理,通过量化的方式来度量
代码质量的变化,从而可以方便地对工程进行代码质量管理。
支持的语言包括:Java、PHP、C#、C、Cobol、PL/SQL、Flex 等。
2、SonarQube平台的组成:
(1) 数据库:存放SonarQube的配置数据、代码质量的快照数据
(2) Web服务:用于查看SonarQube的配置数据、代码质量的快照数据
(3) 分析器:对项目代码进行分析,生成质量结果数据并存入数据库中
(分析器有多种,我们选用 SonarQube Maven Plugin)
二、SonarQube的安装
安装环境要求说明:
http://docs.sonarqube.org/display/SONAR/Requirements
本教程安装环境:
(1) CentOS 6.6
(2) Oracle JDK 7u72
(3) MySQL5.1
(4) SonarQube-4.5.4 (LTS)
安装步骤:
http://docs.sonarqube.org/display/SONAR/Installing
(具体安装步骤请参照安装详细步骤文档和视频教程)
IP: 192.168.4.221
环境 : CentOS 6.6 、 JDK7 、 MySQL5.1 、 SonarQ ube- - 4.5.4 (LTS)
root 用 户操作
准备工作:已安装 JDK7 并配置好了环境变量
1、安装MySQL5 .1
( 可参 考 前面 面 N SVN 管 理平台的 的 L MySQL 安 装步骤,如果已安装则 无 需安装 )
# rpm -qa | grep mysql ## 查看该操作系统上是否已经安装了 mysql 数据库,
有的话,可以通过 rpm -e 命令 或者 rpm -e --nodeps 命令来卸载掉
# yum install mysql-server mysql mysql-devel
# service mysqld start
# chkconfig --list | grep mysqld
mysqld 0:off 1:off 2:off 3:off 4:off 5:off 6:off
用上面的命令查看到 MySQL 并没有设置开机启动,所以需要设置开机启动
# chkconfig mysqld on
为了方便远程管理,防火墙中打开 3306 端口
# vi /etc/sysconfig/iptables
-A INPUT -m state --state NEW -m tcp -p tcp --dport 3306 -j ACCEPT
重启防火墙,使端口配置生效
# service iptables restart
设置 MySQL 数据库 root 用户的密码:
# mysqladmin -u root password 'wusc.123'
登录数据库:
# mysql -u root -p
MySQL 授权远程访问(先用 root 登录 mysql)
mysql> GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'wusc.321' WITH
GRANT OPTION;
mysql> FLUSH PRIVILEGES;
2、配置MySQL
结合SonarQube,MySQL数据库最好使用 B InnoDB 引擎 , 可提高性能。
看你的 mysql 现在已提供什么存储引擎:mysql> show engines;
看你的 mysql 当前默认的存储引擎:
mysql> show variables like '%storage_engine%';
修改 MySQL 存储引擎为 InnoDB, 在配置文件/etc/my.cnf 中的
[mysqld] 下面加入 default-storage-engine=INNODB
# vi /etc/my.cnf
[mysqld]
default-storage-engine=INNODB
重启 mysql 服务器
# service mysqld restart
再次登录 MySQL 查看默认引擎设置是否生效
mysql> show variables like '%storage_engine%';
+----------------+--------+
| Variable_name | Value |
+----------------+--------+
| storage_engine | InnoDB |
+----------------+--------+
innodb_buffer_pool_size 参 数值设置得尽可能大 一 点
这个参数主要作用是缓存 innodb 表的索引,数据,插入数据时的缓冲
默认值:128M,专用 mysql 服务器设置的大小:操作系统内存的 70%-80%最佳。
设置方法:my.cnf 文件[mysqld] 下面加入 innodb_buffer_pool_size 参数
# vi /etc/my.cnf
[mysqld]
innodb_buffer_pool_size = 256M
(我们这里设置为 256M,因为我们的不是专用的 MySQL 数据库服务器,还有很多其他的服
务需要占用系统内存)
设置 MySQL 的 查询缓存 query_cache_size , , 最 少设置 15M
# vi /etc/my.cnf
[mysqld]
query_cache_type=1
query_cache_size=32M
重启 mysql 服务器
# service mysqld restart
验证缓存设置是否生效:
mysql> show variables like '%query_cache%';
+------------------------------+----------+
| Variable_name | Value |
+------------------------------+----------+
| have_query_cache | YES |
| query_cache_limit | 1048576 |
| query_cache_min_res_unit | 4096 |
| query_cache_size | 33554432 |
| query_cache_type | ON |
| query_cache_wlock_invalidate | OFF |
+------------------------------+----------+
3、创建sonarqube数据库(UTF-8编码)
三、安装SonarQube的Web Server
下载最新 LTS 版的 SonarQube 安装包(当前版本为 sonarqube-4.5.4.zip):
下载地址:http://www.sonarqube.org/downloads/
http://dist.sonar.codehaus.org/sonarqube-4.5.4.zip
下载:
# wget http://dist.sonar.codehaus.org/sonarqube-4.5.4.zip
解压安装:
# unzip sonarqube-4.5.4.zip
# mv sonarqube-4.5.4 sonarqube
编辑 sonar 配置:
# cd sonarqube/conf/
# vi sonar.properties
sonar.jdbc.username=yulei
sonar.jdbc.password=123456
#----- MySQL 5.x
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonarqube?useUnicode=true&characterE
ncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.web.host=0.0.0.0
sonar.web.context=/sonarqube
sonar.web.port=9090
保存以上配置(注意,要看看默认的 9000 端口是否已被占用)
防火墙中打开 9090 端口:
# vi /etc/sysconfig/iptables
-A INPUT -m state --state NEW -m tcp -p tcp --dport 9090 -j ACCEPT
重启防火墙,使端口配置生效
# service iptables restart
启动 SonarQube Web Server
# /root/sonarqube/bin/linux-x86-64/sonar.sh start
(初次启动会自动建表和做相应的初始化)
浏览器中输入:http://192.168.4.221:9090/sonarqube/
登录,默认用户名/密码为 admin/admin
到此,SonarQub已安装完毕,接下来是对SonarQube做相应的配置和使用