使用 Sonar 进行代码质量管理
原文链接：http://www.wekri.com/2017/11/22/sonar/quickstart-sonar/
Sonar 是一个开源的代码质量管理平台。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具（如Jenkins）。
Sonar 并不是简单地把不同的代码检查工具结果（例如 FindBugs，PMD 等）直接显示在 Web 页面上，而是通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。
Sonar 的安装
我安装的是sonarQube6.7，要求JDK1.8，MySQL5.6及以上，maven3.0.2以上。
下载
sonarQube官网下载安装包
下载 zip 包后，直接解压到任意目录。
数据库配置
sonar默认使用H2内存数据库，可以直接使用。不过建议用其他数据库，Sonar 可以支持大多数主流关系型数据库（例如 Microsoft SQL Server, MySQL, Oracle, PostgreSQL 等）。
本文使用mysql，需要提前装好MySQL，并创建sonar库（不详述）。
修改/conf/sonar.properties文件
sonar.jdbc.username= root
sonar.jdbc.password= 123456
sonar.jdbc.url= jdbc:mysql://192.168.1.56:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false运行
- windows环境
在 windows 环境中，直接启动 Soanr 的 bin 目录下 windows-x86-64\StartSonar.bat 即可。
然后在浏览器中访问：http://localhost:9000 默认账户：admin/admin
- linux环境
使用命令bin/linux-x86-64/sonar.sh start启动服务。
注意：由于elasticsearch不支持root用户启动，需要在非root用户下启动sonar
- docker环境
镜像详情
安装镜像
docker pull sonarqube启动
默认使用h2数据库
docker run -p 9000:9000 sonarqube使用外置数据库
docker run -e SONARQUBE_JDBC_USERNAME=sonar -e SONARQUBE_JDBC_PASSWORD=pwd -e SONARQUBE_JDBC_URL='jdbc:mysql://101.132.184.251:3306/sonar?useUnicode=true&characterEncoding=utf8' -p 9000:9000 sonarqube- marathon中部署
{
"id": "/sonarqube",
"cmd": null,
"cpus": 0.2,
"mem": 1024,
"disk": 0,
"instances": 1,
"container": {
"type": "DOCKER",
"volumes": [],
"docker": {
"image": "sonarqube:6.7.5",
"network": "BRIDGE",
"portMappings": [
{
"containerPort": 9000,
"hostPort": 0,
"servicePort": 19999,
"protocol": "tcp",
"labels": {
"VIP_0": "sonarqube:19999" }
}
],
"privileged": true,
"parameters": [],
"forcePullImage": true
}
},
"env": {
"SONARQUBE_JDBC_USERNAME": "sonar",
"SONARQUBE_JDBC_PASSWORD": "pwd",
"SONARQUBE_JDBC_URL": "jdbc:mysql://192.168.1.193:3306/sonar?useUnicode=true&characterEncoding=utf8"
},
"healthChecks": [
{
"protocol": "TCP",
"portIndex": 0,
"gracePeriodSeconds": 60,
"intervalSeconds": 30,
"timeoutSeconds": 60,
"maxConsecutiveFailures": 3,
"ignoreHttp1xx": false
}
],
"labels": {
"HAPROXY_GROUP": "external",
"LOAN_SONAR_BUILD_ID": "1"
},
"portDefinitions": [
{
"port": 19999,
"protocol": "tcp",
"labels": {}
}
]
}安装插件
举个栗子，我们安装一个汉化插件：Chinese Pack
进入Administration->Marketplace
搜索Chinese Pack，点击install。
再安装一个分析java的插件：
搜索SonarJava 点击install
安装后重启sonar。
使用 Sonar maven插件进行代码解析
使用前提：
- 需要maven版本3.0.2及以上。
- 安装好SonarQube。
- 使用了已安装的SonarQube支持的最低的JDK。
- 已经安装好了你要分析的语言的插件。
配置 settings.xml
进入$MAVEN_HOME/conf or ~/.m2编辑settings.xml，添加插件和sonarQube server地址：
<settings>
<pluginGroups>
<pluginGroup>org.sonarsource.scanner.mavenpluginGroup>
pluginGroups>
<profiles>
<profile>
<id>sonarid>
<activation>
<activeByDefault>trueactiveByDefault>
activation>
<properties>
<sonar.host.url>
http://192.168.1.56:9000
sonar.host.url>
properties>
profile>
profiles>
settings>开始分析项目
编译命令如下：
mvn clean install编译成功后，再使用如下命令：
mvn sonar:sonarMaven 插件会自动把所需数据（如单元测试结果、静态检测结果等）上传到 Sonar 服务器上，需要说明的是，关于 Sonar 的配置并不在每个工程的 pom.xml 文件里，而是在 Maven 的配置文件 settings.xml 文件里。
将 Soanr 所需要的数据上传到 Sonar 服务器上之后，Sonar 安装的插件会对这些数据进行分析和处理，并以各种方式显示给用户，从而使用户方便地对代码质量的监测和管理。
如果使用其他方式分析项目，请参考https://docs.sonarqube.org/display/SCAN/Analyzing+Source+Code，这里提供了Gradle，Ant，Jenkins等方式。
本文参考
Analyzing with SonarQube Scanner for Maven