SonarQube的Android环境配置

Sonar是一个用于代码质量管理的开源平台，用于管理源代码的质量，github源码。默认支持Java语言的静态代码审查，可以通过安装插件实现对绝大多数主流开发语言的代码审查，插件地址。还可以跟代码检查工具结果（例如 FindBugs，PMD 等）、持续集成工具（例如 Hudson/Jenkins 等）等集成起来，通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。支持多国语言、支持多个IDE插件等详情见官网和插件和Library。

一、安装要求和安装文件准备，具体安装要求，安装实例以win下Android为准，其他系统或参见Setup教程：

1、JDK8以上，下载页面；

2、SonarQube 6.0，下载页面；

3、SonarQube Scanner ，下载页面；

4、数据库，不是必需品，可以不装，下载页面；

二、Sonar安装和配置：

1、解压缩SonarQube和Scanner，直接运行SonarQube目录下面的bin文件夹下对应自己的系统运行StartSonar.bat就可以了，例如我的路径是E:\sonar\sonarqube-6.0\bin\windows-x86-64\StartSonar.bat，运行后打开浏览器http://localhost:9000/ ，进去网址就可以打开Sonar页面了。

2、打开conf文件夹下的sonar.properties文件，设置：

sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

3、使用帐号密码admin登录，然后点击Administration--System下拉--Update Center--点击Available，等页面刷新出插件后，搜索Chinese Pack然后install；把StartSonar.bat关掉再打卡重启sonar服务，再重新打开http://localhost:9000/  页面就可以看到默认语言变为中文了，只不过中文化不太彻底；

4、操作第二步登录后，再次进到Administration--System--Update Center--Available，搜索Android，安装。或者选择离线下载包，放到sonarqube-6.0\extensions\plugins目录下面；

5、点击“质量配置”--找到下面刚才安装的“Android Lint”点击进去，看着bug那一栏Active为0，点击0进入；

在“质量配置”里面，把Android Lint规则切换到inactive，然后点击右上角的“批量修改”，活动Android Lint，最后再弹出的对话框中“应用”

6、进入刚才解压缩的Scanner目录，为里面的bin路径在环境变量的系统变量的path配置路径；

然后，打开conf文件夹下的sonar-scanner.properties文件，设置：

配置好，在运行cmd命令行，输入sonar-runner -version，看到sonar的版本信息就说明配置成功了；

如果出现下面类似错误：请检查JDK的环境变量path路径，是否设置正确，最好放在系统变量而不是放在用户变量里面；

三、项目配置以及运行sonar分析：

1、进入需要sonar分析项目的根目录，新建sonar-project.properties文件，然后配置下面信息，保存文件的编码需要是utf-8的：

sonar.projectKey=SDKDemo
sonar.projectName=SDKDemo
sonar.projectVersion=1.0
sonar.sources=app/src/main/java
sonar.binaries=app/build/intermediates/classes/  
sonar.language=java
sonar.sourceEncoding=UTF-8
sonar.profile=Android Lint

其中，sonar.projectKey和sonar.projectName随便填不与其他项目重复的就好，一般是项目名；sonar.sources指向Java代码目录；sonar.binaries指向build后产生classes目录，一般AS和eclipse不同；sonar.profile为代码检查规则，就是我们刚刚安装的那个；

2、在cmd进入项目所在的根目录，输入命令：sonar-runner，分析成功后会出现下图：

如果失败，可以用命令sonar-runner -e或者-X查看具体错误进行修正；注意runner过程中，之前的StartSonar.bat不能关闭得一直开着；在过程中可能会遇到SVN的问题，可以在配置文件里面关闭sonar.scm.disabled=true，详情见此。

3、之后就可以在浏览器打开http://localhost:9000，点击项目，就可以查看具体问题了。

四、在Android Studio中配置Sonar插件：

1、官网介绍，在AS中打开setting--Plugins--Browse repositories，然后输入sonar搜索，点击SonarLint进行安装；

2、然后在Other Settings下面配置Server信息，默认是token不过我试了一下不成功，选择password，帐密都是admin，跟浏览器登录一致，可以Test connection试一下，点击OK后，再“Update binding”：

3、然后在Other Settings下面的SonarLint Project Settings，勾上enable选项，选择刚才新建的那个Server，选择SonarQube project（这个project应该是之前在第二步Sonar-runner 分析过的，server里面有记录的）。

4、最后我们就可以在AS的左下角，选择SonarLint进行相应信息的查看和修改，右边是相关信息提示和修改指引。

五、MySQL数据库配置（非必须）：

1、安装好数据库后，打开数据库命令客户端（MYSQL Commend Line Client），创建sonar数据库和表，需要指定utf-8：

mysql> 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、在Sonarqube配置数据库信息，打开第二步解压的Sonarqube目录，打开conf文件夹下的sonar.properties文件，取消MySQL相关信息的注释，修改为：

sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin

3、修改sonar-runner的配置文件，打开Sonar-scanner目录，打开conf文件夹下的sonar-scanner.properties文件，设置jdbc和MySQL的配置信息修改如下：

之后重启一下StartSonar.bat就可以了，重新打开http://localhost:9000，就没有下面的提示了；