分布式架构学习之持续集成：011--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）






http://docs.sonarqube.org/display/SONAR/Requirements http://docs.sonarqube.org/display/SONAR/Installing





代码质量管理平台SonarQube的安装
 

IP:192.168.4.221

环境：CentOS 6.6、JDK7、MySQL5.1 、SonarQube-4.5.4(LTS)

root 用户操作

准备工作：已安装 JDK7 并配置好了环境变量

1 、安装 MySQL5.1（可参考前面 SVN 管理平台的 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 数据库最好使用 InnoDB 引擎，可提高性能。

现在已提供什么存储引擎：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%';

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%';

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=root 

sonar.jdbc.password=wusc.123

#----- 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



 到此，SonarQube 已安装完毕，接下来是对SonarQube 做相应的配置和使用

SonarQube 代码质量管理平台的配置与使用
 

一、SonarQube 的配置（前提，先用 admin 用户登录）

1、 安装中文汉化包：

Setting >> Update Center >> Available Plugins >> LOCALIZATION >> Chinese Pack >> Install

安装完汉化包之后需要重启 SonarQube 才能生效（重启前可顺便把 CheckStyle、PMD 等插件安装一下）

# /root/sonarqube/bin/linux-x86-64/sonar.sh restart

Stopping SonarQube...

Stopped SonarQube.

Starting SonarQube...

Started SonarQube.

重启完之后刷新 SonarQube：http://192.168.4.221:9090/sonarqube/

汉化成功（注意，汉化包并没有完全汉化）,重新登录

2、 MyEclipse/Eclipse 中安装 SonarQube 插件的安装、配置、使用：

http://docs.sonarqube.org/display/SONAR/SonarQube+in+Eclipse

http://docs.sonarqube.org/display/SONAR/Installing+SonarQube+in+Eclipse

http://docs.sonarqube.org/display/SONAR/Configuring+SonarQube+in+Eclipse

http://docs.sonarqube.org/display/SONAR/Working+with+SonarQube+in+Eclipse

3、 Maven 分析器插件的配置与使用

http://docs.sonarqube.org/display/SONAR/Installing+and+Configuring+Maven

在 Maven 本地库中的 settings.xml（我这里是 settings_edu.xml）配置文件中的

<profiles></profiles>节点中添加如下配置: 

<profile>
<id>sonar</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<!-- Example for MySQL-->
<sonar.jdbc.url>jdbc:mysql://192.168.4.221:3306/sonarqube?useUnicode=true&characterEncoding=utf8</sonar.jdbc.url>
<sonar.jdbc.username>root</sonar.jdbc.username>
<sonar.jdbc.password>wusc.321</sonar.jdbc.password>

<!-- Optional URL to server. Default value is http://localhost:9000 -->
<sonar.host.url>http://192.168.4.221:9090/sonarqube</sonar.host.url>
</properties>
</profile>

使用 Maven 分析器进行分析，命令：

纯 Maven 命令：mvn clean install sonar:sonar

MyEclipse 中执行：clean install sonar:sonar

（如果第一次运行此命令，看执行日志会发现它会先下载 sonar-runner 等插件）成功执行完分析命令后便可到 Web Server 中查看代码质量分析结果数据。



4、 配置：

(1) 配置
(2) 权限
(3) 系统
5、 质量配置介绍（切换默认配置）

 




6、 代码规则介绍（自定义规则）



7、 问题处理介绍（质量管理的体现）



8、 指表



9、 仪表盘（自定义）



参考sonar.oschina.net的代码质量管理