Andoid

代码检查工具SonarQube Android项目配置记录

2018-06-25  本文已影响0人  Haraway

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

一、SonarQube的工作流程

  1. 用户本地使用IDE的插件进行代码分析
  2. 用户上传到源代码版本控制服务器
  3. 持续集成,使用Sonar Scanner进行扫描
  4. 将扫描结果上传到SonarQube服务器
  5. SonarQube server将结果写入db
  6. 用户通过web ui查看扫描结果
  7. SonarQube导出结果到其他需要的服务

SonarQube的工作流程

二、SonarQube的架构

  Database
  SonarQube Server
  SonarQube Scanner
  Project
  Nginx (如果不需要通过nginx转发则不需要Nginx模块)

SonarQube的架构

三、Sonar安装和配置:

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

  JDK8以上,下载页面
  SonarQube ,下载页面
  SonarQube Scanner ,下载页面
  数据库,非必需,可以不装,下载页面

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

  2、打开conf文件夹下的sonar.properties文件,设置:

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

  3、进入刚才解压缩的Scanner目录,为里面的bin路径在环境变量的系统变量的path配置路径;
然后,打开conf文件夹下的sonar-scanner.properties文件,设置:

sonar.sorceEncoding=UTF-8
sonar.login=admin
sonar.password=admin
sonar.scm.disablied=true
sonar-scanner.properties

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

sonar-scanner -version

4、使用帐号密码admin登录,再次进到Administration--Marketplace,搜索Android ,点击install,安装Android Plugins。

Android

四、项目配置以及运行sonar分析:

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

sonar.projectKey=xxx
sonar.projectName=xxx
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-project.properties

其中,sonar.projectKey和sonar.projectName一般是项目名;sonar.sources指向Java代码目录;sonar.binaries指向build后产生classes目录。

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


sonar-scanner

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

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

http://localhost:9000

五、在Android Studio中配置Sonar插件:

  1、[官网介绍]http://www.sonarlint.org/intellij/),在AS中打开setting--Plugins--Browse repositories,然后输入sonar搜索,点击SonarLint进行安装。

SonarLint

  2、然后在Other Settings下面配置Server信息,再点击“Update binding”。


SonarLint General Settings

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


SonarLint Project Settings

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

SonarLint

参考文档:
1,SonarQube的Android环境配置

2,SonarQube 分享 (一):介绍与安装

上一篇下一篇

猜你喜欢

热点阅读