初试Sonar

前阵子玩了玩持续集成,从CruiseControl换到了Hudson,写了篇关于Hudson的入门,最近看到同事在用Sonar,又正好在InfoQ上看到了介绍Sonar的设计架构度量功能的文章,于是也尝试了下对自己的项目代码进行扫描(可惜扫描的结果有点杯具:-()。

Sonar is an open platform to manage code quality. As such, it covers the 7 axes of code quality: Architecture & Design, Duplications, Unit tests, Complexity, Potential bugs, Coding rules, Comments.
 

下面简单讲讲如何配置一个可用的Sonar环境,快速开展代码度量。

1、准备环境

JDK 1.5+,这个就不说了。

Maven 2.0.9+,Sonar通过Maven Plugin来检查代码,这个建议装最新的,因为低版本的Maven中有些Bug会影响Sonar的使用,例如MNG-4001,会报找不到Plugin。

MySQL 5.x+,Sonar需要一个数据库来存储结果,Sonar自带了Derby,但在实际使用时还是用MySQL、PostgreSQL这样的数据库比较靠谱,Sonar还支持Oracle和MS SQLServer。

2、准备数据库

这里我使用了MySQL来存储分析结果,所以执行以下脚本:

CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
grant all privileges on sonar.* to 'sonar'@'localhost' identified by '你的密码';
flush privileges;

3、配置Sonar

下载最新的Sonar发行版,解压到一个目录里,修改conf/sonar.properties文件,根据你的数据库配置进行调整:

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

sonar.jdbc.driver:com.mysql.jdbc.Driver

sonar.jdbc.validationQuery:select1

sonar.jdbc.user:sonar

sonar.jdbc.password:你的密码

4、部署到Tomcat

Sonar有两种运行模式,一个使用自带的服务器启动,选择bin目录下相应的系统脚本就可以启动了,然后访问http://localhost:9000

第二种就是部署到独立的AppServer里,例如Tomcat。

  • 根据步骤3,修改conf/sonar.properties中的数据库配置
  • 执行war目录里的build-war脚本生成war文件
  • 将war文件部署到应用服务器中

Sonar对内存要求比较高,一般的默认配置满足不了需求,所以需要定制一下Tomcat里的相应参数:

-Xms1024m -Xmx1024m -XX:MaxPermSize=256m
 

启动服务器后,访问http://localhost:8080/sonar就能看到界面了。

5、快速执行代码度量

根据Sonar的文档,需要配置settings.xml才能使用mvn sonar:sonar命令,这太麻烦了,可以直接使用下面的命令:

mvn install -Dmaven.test.skip=truemvn test org.codehaus.sonar:sonar-maven-plugin:1.8:sonar -Dmaven.test.failure.ignore=true -Dsonar.jdbc.driver=com.mysql.jdbc.Driver "-Dsonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8" -Dsonar.jdbc.username=sonar -Dsonar.jdbc.password=<你的密码> -Dsonar.host.url=http://localhost:8080/sonar

如果需要远程操作,需要对MySQL的权限进行一些配置,如果有防火墙,记得打开3306端口:

grant all on sonar.* to 'sonar'@'%' identified by '<你的密码>';
flush privileges;

同样,由于Sonar对内存要求较高,在执行Maven前,最好配置下MAVEN_OPTS,加大内存:

-Xmx512m -XX:MaxPermSize=256m

如果在运行mvn命令时发生JAVA无法打开新进程的情况,很有可能是Windows下命令行超过最大字数限制了(要引用很多jar文件,默认的repo路径比较长),这时可以考虑修改Maven的settings.xml文件,自定义一个Repository存放路径,例如:D:/mvn_repo。

这时,假设远程服务器地址为192.168.1.2,Sonar的地址为http://192.168.1.2:8080/sonar,则执行的命令为:

mvn install -Dmaven.test.skip=truemvn test org.codehaus.sonar:sonar-maven-plugin:1.8:sonar -Dmaven.test.failure.ignore=true -Dsonar.jdbc.driver=com.mysql.jdbc.Driver "-Dsonar.jdbc.url=jdbc:mysql://192.168.1.2:3306/sonar?useUnicode=true&characterEncoding=utf8" -Dsonar.jdbc.username=sonar -Dsonar.jdbc.password=<你的密码> -Dsonar.host.url=http://192.168.1.2:8080/sonar

6、Hudson集成

Sonar还可以通过插件与Hudson进行集成,在每次构建结束后触发Sonar。

首先,应该在Hudson的插件管理中添加Hudson Sonar Plugin;然后,在系统设置里,增加一个Sonar的Installation;最后,在项目的Post-build actions里,勾选Sonar,在项目构建完成后,会自动执行Sonar的任务。

不过Hudson集成中运行Sonar任务,可能需要参考Sonar的文档对Maven配置进行相应修改。

参考文档:

  1. Sonar: Install Sonar (http://docs.codehaus.org/display/SONAR/Install+Sonar)
  2. Sonar:Collectdata(http://docs.codehaus.org/display/SONAR/Collect+data)
  3. Hudson:SonarPlugin(http://wiki.hudson-ci.org/display/HUDSON/Sonar+Plugin)

相关推荐