SonarQube与SonarRunner安装配置

  使用的安装包：

（1）sonarqube-4.5.zip （2） sonar-runner-dist-2.4.zip 下载后解压缩到/usr/local下

（3）mysql-5.6.14.tar.gz

Sonar介绍

Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。同时 Sonar 还对大量的持续集成工具提供了接口支持，可以很方便地在持续集成中使用 Sonar。此外，Sonar 的插件还可以对 Java 以外的其他编程语言提供支持，对国际化以及报告文档化也有良好的支持。

1、安装配置MySQL数据库

Apache Derby 是Sonar自带并且默认安装使用的数据库，此外Sonar对如下数据库提供支持：MySQL 5.x, Oracle 10g XE, Postgresql, MS SqlServer等，本文以mysql为例介绍如何配置数据库：

（1）创建数据库及用户

在mysql中执行如下脚本创建数据库及mysql用户

#mysql -u root -pmysql> 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_HOME}/conf/sonar.properties配置数据库:

sonar.jdbc.username=sonarsonar.jdbc.password=sonarsonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=truesonar.jdbc.driverClassName=com.mysql.jdbc.Driver

2、安装、配置Sonar

（1）设置环境变量

# vi /etc/profile

增加和修改下面内容

export SONAR_HOME=/usr/local/sonarqube-4.5
export SONAR_RUNNER_HOME=/usr/local/sonar-runner-2.4export PATH=$PATH:$SONAR_HOME/bin:$SONAR_RUNNER_HOME/bin

使环境变量生效

# source /etc/profile

（2）启动Sonar

[root@vm-bd /]#cd /usr/local/sonarqube-4.5/bin/linux-x86-64[root@vm-bd linux-x86-64]#./sonar.sh start

（3）打开浏览器输入 http://localhost:9000/ 出现运行界面；

（4）修改访问端口和路径

Sonar默认的端口是”9000”、默认的上下文路径是”/”、默认的网络接口是”0.0.0.0”，默认的管理员帐号和密码为:admin/admin，这些参数都可以在配置文件中修改：

$ vi ${SONAR_HOME}/conf/sonar.properties

3、配置中文插件

下载地址：http://docs.codehaus.org/display/SONAR/Chinese+Pack

将下载后的插件上传到${SONAR_HOME}\extensions\plugins目录下，重新启动sonar。然后可以以系统管理员身份登录Sonar配置插件，或者升级。

Sonar支持多种插件，插件的下载地址为：http://docs.codehaus.org/display/SONAR/Plugin+Library

将下载后的插件上传到${SONAR_HOME}extensions\plugins目录下，重新启动sonar。

sonar默认集成了Java Ecosystem插件，该插件是一组插件的合集

• Java [sonar-java-plugin]：java源代码解析，计算指标等
• Squid [sonar-squid-java-plugin]：检查违反Sonar定义规则的代码
• Checkstyle [sonar-checkstyle-plugin]：使用CheckStyle检查违反统一代码编写风格的代码
• FindBugs [sonar-findbugs-plugin]：使用FindBugs检查违反规则的缺陷代码
• PMD [sonar-pmd-plugin]：使用pmd检查违反规则的代码
• Surefire [sonar-surefire-plugin]：使用Surefire执行单元测试
• Cobertura [sonar-cobertura-plugin]：使用Cobertura获取代码覆盖率
• JaCoCo [sonar-jacoco-plugin]：使用JaCOCO获取代码覆盖率

下面列出了一些常用的插件：

• JavaScript代码检查：http://docs.codehaus.org/display/SONAR/JavaScript+Plugin
• python代码检查：http://docs.codehaus.org/display/SONAR/Python+Plugin
• Web页面检查（HTML、JSP、JSF、Ruby、PHP等）：http://docs.codehaus.org/display/SONAR/Web+Plugin
• xml文件检查：http://docs.codehaus.org/display/SONAR/XML+Plugin
• scm源码库统计分析：http://docs.codehaus.org/display/SONAR/SCM+Stats+Plugin
• 文件度量：http://docs.codehaus.org/display/SONAR/Tab+Metrics+Plugin
• 中文语言包：http://docs.codehaus.org/display/SONAR/Chinese+Pack
• 时间表显示度量结果：http://docs.codehaus.org/display/SONAR/Timeline+Plugin
• 度量结果演进图：http://docs.codehaus.org/display/SONAR/Motion+Chart+Plugin

b）插件配置示例（本段内容来自http://www.ibm.com/developerworks/cn/java/j-lo-sonar/）

Sonar 的主要特色是对不同工具产生的检查结果进行再加工处理，Sonar 还向用户提供了对数据进行个性化处理的方法

4、安装、配置Sonar-Runner

解压缩sonar-runner-dist-2.4.zip到 /usr/local目录下，修改配置文件sonar-runner.properties

#----- Default Sonar server#sonar.host.url=http://localhost:9000#----- MySQL#sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8#sonar.jdbc.driver=com.mysql.jdbc.Driver#----- Global database settings#sonar.jdbc.username=sonar#sonar.jdbc.password=sonar#----- Default directory layout#sonar.sources=src/main/java#sonar.tests=src/test/java#sonar.binaries=target/classes#----- Default source code encoding#sonar.sourceEncoding=UTF-8

5、测试Sonar-Runner运行

#sonar-runner -h

6、分析代码

在代码文件夹的根目录下新建Sonar-Runner的配置文件sonar-project.properties

# required metadatasonar.projectKey=my:projectsonar.projectName=My projectsonar.projectVersion=1.0# path to source directories (required)sonar.sources=src/main/java# path to test source directories (optional)#sonar.tests=testDir1,testDir2# path to project binaries (optional), for example directory of Java bytecode#sonar.binaries=binDir# optional comma-separated list of paths to libraries. Only path to JAR file and path to directory of classes are supported.sonar.libraries=web/WEB-INF/lib# Uncomment this line to analyse a project which is not a java project.# The value of the property must be the key of the language.sonar.language=java# Additional parameterssonar.my.property=value

然后在命令行下执行

#sonar-runner

控制台会打印分析过程，当出现SUCCESS时，分析成功！

官网：http://www.sonarqube.org/
示例：http://nemo.sonarsource.org/