SonarQube代码质量管理平台安装与配置

1.安装说明

PS:为什么要有安装说明？江边望海在网上找资料的时候发现很多教程是没有交代清楚安装环境的。所以，不清楚他们的教程是否适合我的环境。明确『安装说明』方便网友了解我的配置环境，便于大家深入理解此教程。

虚拟机：VirtualBox4.3.26

操作用户：root

系统环境：centos6.6-x86_64（最小化安装）

软件下载目录：/root/opt

================

2.预置条件

1.需要JDK1.6+支持；（如果不知道如何安装JDK,请访问我写的《Centos下安装JDK》）

2.需要Mysql数据库支持；（虽然SonarQube自带了H2数据库，但是为了方便管理数据推荐使用Mysql数据库）

多说一句：JDK是必须安装的，Mysql数据库并不是必须要安装的，如果公司有Mysql服务器，直接拿来使用就行，江边望海这次就没有安装Mysql直接用公司内网提供的Mysql数据库。

================

3.安装

在安装之前，介绍一下SonarQube和SonarQube Runner之间的关系。

SonarQube是服务器端，它主要有两个功能：1.分析源代码；2.因为它内嵌了Apache模块，所以提供Web端的界面访问。

SonarQube Runner是一个利用SonarQube服务端分析代码的命令行工具，可以把它简单理解为客户端。

下载地址：http://www.sonarqube.org/downloads/

所以，为了安装和调试方便，江边望海建议SonarQube和SonarQube Runner都下载。

3.1安装SonarQube

第一步：将下载的http://downloads.sonarsource.com/sonarqube/sonarqube-5.1.1.zip解压后放到/usr/local目录下。具体步骤如下：

[root@vb004 opt]# wget -c http://downloads.sonarsource.com/sonarqube/sonarqube-5.1.1.zip
[root@vb004 opt]# unzip sonarqube-5.1.1.zip
[root@vb004 opt]# mv sonarqube-5.1.1 /usr/local/

第二步：配置环境变量

[root@vb004 ~]# vi + /etc/profile
添加
SONAR_HOME=/usr/local/sonarqube-5.1.1 
export SONAR_HOME
保存退出并使配置生效
[root@vb004 ~]# source /etc/profile

第三步：配置sonar-runner.properties

[root@vb004 ~]# vi /usr/local/sonarqube-5.1.1/conf/sonar.properties
打开后，找到
sonar.host.url=http://localhost:9000
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:mysql://192.168.8.234:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.web.host=0.0.0.0
sonar.web.context=
sonar.web.port=80

PS:SonarQube默认监听9000端口。由于我这个虚拟机打算专门给Sonar使用。所以，修改成了80.sonar.jdbc.url中的连接地址也修改成了内网中Mysql服务器的地址。

第四步：启动服务

[root@vb004 ~]# /usr/local/sonarqube-5.1.1/bin/linux-x86-64/sonar.sh start

另外，启动/停止/重启命令如下：
#./sonar.sh start 启动服务
#./sonar.sh stop 停止服务
#./sonar.sh restart 重启服务

第四步：访问SonarQube Web管理界面。如果能够看到这个界面证明SonarQube安装成功啦。

3.2安装SonarQube Runner

第一步：将下载的http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip解压后放到/usr/local目录下。具体步骤如下：

[root@vb004 opt]# wget -c http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip
[root@vb004 opt]# unzip sonar-runner-dist-2.4.zip
[root@vb004 opt]# mv sonar-runner-2.4/ /usr/local/

第二步：配置环境变量

[root@vb004 ~]# vi + /etc/profile
添加
SONAR_RUNNER_HOME=/usr/local/sonar-runner-2.4/
PATH=.:$SONAR_RUNNER_HOME/bin 
export SONAR_RUNNER_HOME
保存并退出 
[root@vb004 ~]# source /etc/profile

第三步：配置sonar-runner.properties

[root@vb004 conf]# vi /usr/local/sonar-runner-2.4/conf/sonar-runner.properties
找到
sonar.host.url=http://192.168.199.123
sonar.jdbc.url=jdbc:mysql://192.168.8.234:3306/sonar?useUnicode=true&amp;characterEncoding=utf8
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.login=admin
sonar.password=admin
将前面的#去掉

PS:刚才我们已经看到SonarQube已经可以访问了，所以就将sonar.host.url改成了实际的访问地址。

第四步：运行sonar-runner分析源代码

Sonar官方已经提供了非常全的代码样例便于新手入门用。

下载地址：https://github.com/SonarSource/sonar-examples/archive/master.zip

下载后使用unzip解压。进入php执行sonar-runner命令即可。操作命令如下：

[root@vb004 opt]# wget -c https://github.com/SonarSource/sonar-examples/archive/master.zip
[root@vb004 opt]# unzip master.zip
[root@vb004 opt]# cd sonar-examples-master/projects/languages/php/php-sonar-runner
[root@vb004 php-sonar-runner]# sonar-runner

如果能够看到下面的输出信息，证明你的SonarQube Runner安装并配置正确啦。

INFO: ------------------------------------------------------------------------
INFO: EXECUTION SUCCESS
INFO: ------------------------------------------------------------------------
Total time: 2:59.167s
Final Memory: 17M/204M
INFO: ------------------------------------------------------------------------

第五步：看看SonarQube的Web界面，是否已经可以看到分析的结果啦。

SonarQube默认是没有安装中文语言包的。可以看到我的截图显示的是中文，因为我安装了中文语言包。如何安装语言包呢。进入SonarQube插件目录，下载语言包即可。步骤如下：

root@vb004 ~]# cd /usr/local/sonarqube-5.1.1/extensions/plugins
[root@vb004 plugins]# wget -c http://repo1.maven.org/maven2/org/codehaus/sonar-plugins/l10n/sonar-l10n-zh-plugin/1.8/sonar-l10n-zh-plugin-1.8.jar

PS：最新版本的语言包是sonar-l10n-zh-plugin-1.8.jar。

这是中文语言包的源码地址：https://github.com/SonarCommunity/sonar-l10n-zh

如果大家有兴趣可以和老外一起来维护这个源码，如果想体验最新的源码直接下载下来，打包成jar就可以啦

================

4.配置时踩的那些坑

Sonar是一个非常不错的代码分析工具。但是网上很多教程讲的都是Jenkins+Sonar的配置。如果按照网上的教程去做，你会崩溃死的.为什么？原因如下：

1.网上很多教程的Jenkins+Sonar是基于对Java源代码进行分析的。所以，如果做php代码分析，有一个非常重要的步骤是装php插件。而如果将Jenkins+Sonar合在一起配置，坑很多，填到你崩溃为止；

2.Jenkins是一款自动化构建的工具，如果是第一次用，坑也非常多。

抛开Jenkins不谈，直接用Sonnar就可以对源代码进行质量分析。所以，你需要在Centos下先把Sonnar跑通，让它能在命令行下分析源代码。确定这一步没有问题啦，再跟Jenkins做持续集成。

我就是一开始Jenkins+Sonar一起配置，忙了半天，还是配置不好。不是这出问题，就是那里出问题。

PS：按照本教程配置，一定能够成功的，不成功可以在博客下方留言，我帮你解决。

================

5.SonarQube可以分析的语言

SonarQube可以分析当下最常用、流行的语言。如：Ruby,Python,Php,Css,Javascript,Java,Go,Web,C#。支持20多种语言。SonarQube安装成功后默认只能分析Java，如果想让它分析其他语言需要安装插件。

支持分析编程语言插件地址：

http://docs.sonarqube.org/display/PLUG/Plugin+Library

如果你是做Web开发的，可以选择安装Php,Css,Javascript,Web这四款就行啦。直接进入到SonarQube的Plugin目录下载，成功后重启SonarQube即可。

例如：安装Php分析插件

[root@vb004 ~]# cd /usr/local/sonarqube-5.1.1/extensions/plugins
[root@vb004 plugins]# wget -c http://downloads.sonarsource.com/plugins/org/codehaus/sonar-plugins/php/sonar-php-plugin/2.6/sonar-php-plugin-2.6.jar

================