使用Sonar管理代码质量(一)–简述与安装

原文地址：http://www.cnblogs.com/ericsun/archive/2011/09/19/2180827.html一、简述前言 Sonar是一个开源平台，用于管理Java源代码的质量。从 Sonar 1.6 版本开始，Sonar从一个质量数据报告工具，转变成为现在的代码质量管理平台。主要特点1)代码覆盖：通过单元测试，将会显示

一枫

1087人浏览 · 2012-04-05 12:44:07

一枫 · 2012-04-05 12:44:07 发布

原文地址：http://www.cnblogs.com/ericsun/archive/2011/09/19/2180827.html

一、简述

前言
Sonar是一个开源平台，用于管理Java源代码的质量。从 Sonar 1.6 版本开始，Sonar从一个质量数据报告工具，转变成为现在的代码质量管理平台。

主要特点

1)代码覆盖：通过单元测试，将会显示哪行代码被选中

2)改善编码规则

3)搜寻编码规则：按照名字，插件，激活级别和类别进行查询。

4)项目搜寻：按照项目的名字进行查询。

5)对比数据：比较同一张表中的任何测量的趋势。

本教程采用最新版Sonar2.3,新版改进如下。

1)可多次激活编码规则、备份和恢复质量profile。

2)可通过搜索一次激活所有的规则。

3)新的规则API。

4)插件可增加静态资源。

5)通过元模型来支持 ISO9126 等质量模型。

6)增加一些新的API和新的Findbugs规则。

前提条件

系统支持

Sonar必须运行在支持Java和Maven的系统中，这是安装前必须的前提条件：

Java Development Kit v1.5 或更高

Maven 2.0.9+

数据库支持

Sonar除了支持默认的Derby数据库之外，还支持如下数据库:

MySQL 5.x+

Oracle 10g+

PostgreSQL 8.3+

MS SQLServer 2005

浏览器支持

Firefox 2.x , 3.x

Internet Explorer 6.x, 7.x ,8.x

Safari (最新版)

Opera (最新版)

Chrome (最新版)

技术架构

该系统按如下顺序来发挥作用：

1、通过mvn sonar:sonar把代码注入到Sonar进行分析，并把分析结果以XML数据方式插入到数据库。

2、通过访问网站http://sonar获取显示结果。

3、持续运行Maven构建的话，会迭代显示分析结果并传送到数据库。

4、Sonar还提供了Eclipse和IDEA的插件支持以显示分析结果。

二、一分钟安装教程

下载并解压。
在Windows执行安装:
       binwindows-x86-32StartSonar.bat
其它平台:
       bin/[OS]/sonar.sh console
在Maven2工程执行下列命令：
       mvn clean install sonar:sonar
打开浏览器，输入http://localhost:9000

后台进入默认用户名和密码 admin/admin.

三、5步完整安装教程

Step 1-创建数据库

Apache Derby 是Sonar默认安装的数据库，并且不需要你安装。它能很好的用于Sonar的演示，但是在实际运用中我推荐你使用性能更好更强大的数据库。Sonar对如下数据库提供支持：MySQL 5.x, Oracle 10g XE, Postgresql 和MS SqlServer 2005。

第一件事就是为Sonar创建一个数据库。表和索引会在Sonar激活后自动创建。同时要给Sonar用户能够在数据库表中创建、禁止和更新对象的权限。

Step 2-安装服务器

这一步参考“一分钟教程”。

Step 3-配置数据库

如果你不是使用默认的数据库，那么你可以编辑conf/sonar.properties配置数据库访问权限。注释derby的配置并复制一份自定义来修改，下面是Sonar的数据库配置模板：

sonar.jdbc.url : 数据库URL
sonar.jdbc.driver : 驱动类
sonar.jdbc.user : 用户名默认sonar
sonar.jdbc.password : 密码默认sonar

Mysql示例：

#sonar.jdbc.url: jdbc:derby://localhost:1527/sonar;create=true
#sonar.jdbc.driver: org.apache.derby.jdbc.ClientDriver
#sonar.jdbc.defaultTransactionIsolation: 1
#sonar.jdbc.validationQuery: values(1)
sonar.jdbc.url: jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
sonar.jdbc.driver: com.mysql.jdbc.Driver
sonar.jdbc.validationQuery: select 1

如果是Oracle，你必须手动复制JDBC驱动类到/extensions/jdbc-driver/oracle/目录下。其它支持的数据库都已提供了驱动。

Step 4-启动服务器

方式一-单独启动

Sonar默认的端口是“9000”，默认的上下文路径是“/”，默认的网络接口是：“0.0.0.0”。一旦激活，Sonar服务器就可以使用http://localhost:9000。这些参数都可以在conf/sonar.properties修改。下面提供一个http://localhost:80/sonar的示例：

sonar.web.host : 192.0.0.1
sonar.web.port: 80
sonar.web.context: /sonar

可以通过如下脚本启动Sonar服务器：

linux/mac : bin/[YOUR PLATEFORM]/sonar.sh start
windows : bin/windows-x86-32/StartSonar.bat

同样你可以启动bin/windows-x86-32/InstallNTService.bat把它注册为一个Window服务，然后再启动bin/windows-x86-32/StartSonar.bat。

现在你就能通过http://localhost:9000 访问。

方式二-部署到Tomcat

Sonar能够打包成一个WAR部署到其它JEE应用服务器。现在它仅支持Tomcat 5.x, 6.x and 7.x。

打包步骤如下：

编辑conf/sonar.properties还原成标准格式(就是不修改端口之类)。确保部署到应用服务器时conf/wrapper.conf未被使用过。
在war/目录下执行build-war.sh脚本(Windows下执行build-war.bat)。
部署war/sonar.war到应用服务器。
通过http://loaclhost:8080/sonar 访问，继续安装步骤。

为了避免内存溢出，增加内存堆栈的大小。在Tomcat启动前设置CATALINA_OPTS环境变量：

CATALINA_OPTS=”-Xms1024m -Xmx1024m -Dorg.apache.jasper.runtime.BodyContentImpl.LIMIT_BUFFER=true -XX:MaxPermSize=256m”

更多资料请查阅这里。

Step 5- 配置到Maven2

因为Sonar是通过Maven2 插件来分析源代码并把结果注入到数据库的。这就是为什么我们必须在Maven的配置里设置数据库的属性。编辑位于$MAVEN_HOME/conf或者 ~/.m2下的settings.xml文件，然后在添加step 3中的参数。

如果数据库和服务器不在同一台主机，你还必须通过’sonar.host.url’指定服务器地址。

示例：

<settings>
    <profiles>
        <profile>
            <id>sonar</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <!– mysql –>
                <sonar.jdbc.url>
                  jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
                </sonar.jdbc.url>
                <sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
                <sonar.jdbc.username>sonar</sonar.jdbc.username>
                <sonar.jdbc.password>sonar</sonar.jdbc.password>
                 <!– remote host –>
                <sonar.host.url>http://myserver:1234</sonar.host.url>
        </properties>
        </profile>
     </profiles>
</settings>