sonar

见附件


预置条件
1、已安装Java环境
2、已安装MySQL数据库
下载
下载SonarQube 5.5：
http://www.sonarqube.org/downloads/
下载Scanner：
http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
安装
解压SonarQube 5.5、sonar-scanner-2.6.1
添加SONAR_HOME、SONAR_RUNNER_HOME环境变量，并将“%SONAR_RUNNER_HOME%\bin”加入PATH
配置
配置数据库
在mysql中执行如下脚本创建数据库及mysql用户
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'sonar' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';

配置SonarQube
1、编辑${SONAR_HOME}/conf/sonar.properties配置数据库
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: com.mysql.jdbc.Driver
2、配置DB驱动包
如果使用Oracle数据库，必须手动复制驱动类到${SONAR_HOME}/extensions/jdbc-driver/oracle/目录下。其它支持的数据库默认提供了驱动，http://docs.codehaus.org/display/SONAR/Analysis+Parameters 列举了一些常用的配置及默认值。
配置sonar-scanner
编辑${SONAR_RUNNER_HOME}/conf/sonar-scanner.properties配置数据库
#Configure here general information about the environment, such as SonarQube DB details for example
#No information about specific project should appear here

#----- Default SonarQube server
sonar.host.url=http://localhost:9000

#----- Default source code encoding
sonar.sourceEncoding=UTF-8

#----- Global database settings (not used for SonarQube 5.2+)
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar

#----- PostgreSQL
#sonar.jdbc.url=jdbc:postgresql://localhost/sonar

#----- MySQL
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8

#----- Oracle
#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE

#----- Microsoft SQLServer
#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor

启动
运行：$\sonarqube-5.5\bin\指定系统和位数\StartSonar.bat

启动成功。
登录
登录http://127.0.0.1:9000/
点击右上角登录按钮，默认账户名和密码为 admin和admin。
中文补丁包安装
下载安装 sonar-l10n-zh-plugin-1.4.jar 语言包(http://docs.codehaus.org/display/SONAR/Chinese+Pack)。直接将jar包放入你的%sonar_home%/sonarqube/extensions/plugins/目录下，重启sonarqube即可。
其它插件
Sonar支持多种插件，插件的下载地址为：http://docs.codehaus.org/display/SONAR/Plugin+Library
将下载后的插件上传到${SONAR_HOME}extensions\plugins目录下，重新启动sonar。
插件介绍
1)Java [sonar-java-plugin]：java源代码解析，计算指标等
2)Squid [sonar-squid-java-plugin]：检查违反Sonar定义规则的代码
3)Checkstyle [sonar-checkstyle-plugin]：使用CheckStyle检查违反统一代码编写风格的代码
4)FindBugs [sonar-findbugs-plugin]：使用FindBugs检查违反规则的缺陷代码
5)PMD [sonar-pmd-plugin]：使用pmd检查违反规则的代码
6)Surefire [sonar-surefire-plugin]：使用Surefire执行单元测试
7)Cobertura [sonar-cobertura-plugin]：使用Cobertura获取代码覆盖率
8)JaCoCo [sonar-jacoco-plugin]：使用JaCOCO获取代码覆盖率
下面列出了一些常用的插件：
1)JavaScript代码检查：http://docs.codehaus.org/display/SONAR/JavaScript+Plugin
2)python代码检查：http://docs.codehaus.org/display/SONAR/Python+Plugin
3)Web页面检查（HTML、JSP、JSF、Ruby、PHP等）：http://docs.codehaus.org/display/SONAR/Web+Plugin
4)xml文件检查：http://docs.codehaus.org/display/SONAR/XML+Plugin
5)scm源码库统计分析：http://docs.codehaus.org/display/SONAR/SCM+Stats+Plugin
6)文件度量：http://docs.codehaus.org/display/SONAR/Tab+Metrics+Plugin
7)中文语言包：http://docs.codehaus.org/display/SONAR/Chinese+Pack
8)时间表显示度量结果：http://docs.codehaus.org/display/SONAR/Timeline+Plugin
9)度量结果演进图：http://docs.codehaus.org/display/SONAR/Motion+Chart+Plugin
更新中心
以管理员用户登录Sonar，进入配置->系统，选择更新中心，如图：

其中Available Plugins选项卡提供了可以选择安装的插件，System Updates可以在线更新Sonar。
下载插件需要注意其中有些插件是需要购买才能使用的，其License类型为Commercial。
使用SonarQube Runner分析源码
官网下载示例：https://github.com/SonarSource/sonar-examples/zipball/master
解压缩，获取sonar-project.properties示例：
SonarSource-sonar-examples-ed8fafb\projects\languages\java\sonar-runner\java-sonar-runner-simple\sonar-project.properties

不同参数的意思：http://docs.codehaus.org/display/SONAR/Analysis+Parameters
以java工程为例
1、在java工程根目录下新建立一个sonar-project.properties配置文件
2、用记事本打开进行参数配置，最简参数配置如下
# Required metadata
sonar.projectKey=Monkey
sonar.projectName=Monkey
sonar.projectVersion=1.1
# Comma-separated paths to directories with sources (required)
sonar.sources=src
sonar.binaries=bin\classes
# Language
sonar.language=java
# Encoding of the source files
sonar.sourceEncoding=UTF-8
说明：
projectKey与projectName和工程名字一样即可
sources为源码目录
binaries为编译后的classes目录，这个目录要注意一下，如果都在bin下面或者目录还有很多层级才到classe目录，可以直接为sonar.binaries=bin，sonar会自动遍历所有目录
language为分析的语言
sourceEncoding源码编码格式

3、开始分析
（1）打开CMD命令
（2）cd进入java工程根目录
（3）敲入sonar-runner，即可进行分析
4、结果展示
分析完后只要进入 http://localhost:9000/
是不是发现多了一个刚才你设置的projectKey
点击你分析的工程，查看分析结果

与IDE关联
打开菜单：Eclipse -> help -> Eclipse Marketplace