Sonar 集成Jenkins进行代码审查

时间：2022-09-24 13:01:09

一  Sonar介绍

 

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

此外，Sonar 的插件还可以对 Java 以外的其他编程语言提供支持，对国际化以及报告文档化也有良好的支持。

二  配置数据库

 

Apache Derby 是Sonar自带并且默认安装使用的数据库，此外Sonar对如下数据库提供支持：MySQL 5.x, Oracle 10g XE, Postgresql, MS SqlServer等，

本文以mysql为例介绍如何配置数据库：

1）创建数据库

在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';

2）编辑${SONAR_HOME}/conf/sonar.properties配置数据库:

sonar.jdbc.username:                       sonar
sonar.jdbc.password:                       sonar
sonar.jdbc.url:                             jdbc:mysql://${db_host}:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true # Optional properties  sonar.jdbc.driverClassName: com.mysql.jdbc.Driver

3）配置DB驱动包

如果使用Oracle数据库，必须手动复制驱动类到${SONAR_HOME}/extensions/jdbc-driver/oracle/目录下。其它支持的数据库默认提供了驱动，http://docs.codehaus.org/display/SONAR/Analysis+Parameters 列举了一些常用的配置及默认值.

三  安装、配置Sonar

 
目前的LTS为4.5.7，下载地址： https://sonarsource.bintray.com/Distribution/sonarqube/sonarqube-4.5.7.zip。
Sonar默认集成了jetty容器，可以直接启动提供服务，也可以通过脚本构建为war包，部署在tomcat容器中。本文直接用jetty部署运行，
默认端口号是9000。

1) 编辑，添加环境变量SONAR_HOME

$ vi $HOME/.bash_profile

修改成如下内容：

export SONAR_HOME=/data/sonar/sonarqube-4.5.7

使环境变量生效

Source ~/.bash_profile

2) 配置为随机启动

vi /etc/rc.local

# start sonar
/data/sonar/sonarqube-4.5.7/bin/linux-x86-64/sonar.sh start

3) 修改conf/sonar.properties

#----- MySQL 5.x
sonar.jdbc.url=jdbc:mysql://host:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
sonar.jdbc.driverClassName: com.mysql.jdbc.Driver

4）启动sonar

$ ${SONAR_HOME}/bin/linux-x86-64/sonar.sh start

 

四  安装插件

采用sonar的更新中心安装插件：以管理员用户登录Sonar，进入配置->系统，选择更新中心->可用插件。

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

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

五 集成Jenkins

在jenkins的插件管理中选择安装SonarQube Plugin，该插件可以使项目每次构建都调用sonar进行代码度量。

进入配置页面对sonar插件进行配置，如下图：

Sonar 集成Jenkins进行代码审查

配置构建项目，增加Post Build Action：

Sonar 集成Jenkins进行代码审查

Sonar 集成Jenkins进行代码审查

应用程序构建时就会自动触发Sonar对代码的检查。


TIPS

  1.  可以在sonar的web管理界面（通用设置->排除中），排除不需要扫描的文件或者不需要报告的问题。     
  2. 创建job时，jdk应该明确指定版本，而不是采用system version！！
标签：

相关文章