Sonar及其eclipse插件的安装

本文档用于帮助您安装Sonar和 Eclipse 的Sonar插件,并利用Sonar分析您的项目，动态地清理代码中的问题，提高代码质量。

目录

1. Sonar安装
2. Sonar下载
3. 解压和安装
4. 运行Sonar
5. Sonar控制台
6. 访问您的Sonar
7. 生成Sonar报告
8. POM中增加Sonar配置
9. 例子
10. Sonar中访问您的项目
11. Eclipse集成Sonar
12. Eclipse的Sonar插件安装
13. 通过Eclipse Market Place安装
14. 通过Eclipse Software Update安装
15. 在Eclipse中配置Sonar
16. 第一次链接你的项目
17. 分析和清理代码
18. 本地运行Sonar分析

Sonar安装

下载Sonar

点击下面网址下载Sonar: http://dist.sonar.codehaus.org/sonar-3.5.1.zip ,下载后解压

解压后安装

解压后你将要看到如下图所示的目录结构：

图 1 Sonar目录结构

运行Sonar

不同的操作系统需要执行不同的可执行文件，例如64位linux-x86系统需要执行start.sh

图 2 运行Sonar

Sonar控制台

启动Sonar后您将看到如下信息：

图 3 Sonar控制台

访问Sonar

现在你可以通过http://localhost:9000访问你的Sonar

生成Sonar报告

POM中增加Sonar配置

Sonar安装完成后，为了可以生成maven项目的报告，我们需要在项目的pom.xml文件中添加下图所示的行（在properties section中增加Sonar主机地址）

图 4 POM XML中添加Sonar配置

例子

• 让我们看一个普通项目的例子;执行下列操作步骤
  • 从库中检出最新的代码到您的工作中
  • 执行mvn clean install
  • 修改pom.xml文件，在properties section中添加如下内容：

    1	<sonar.host.url> http://localhost:9000/ </sonar.host.url>

  • 保存文件
  • 在命令行中执行mvn sonar:sonar

你将看到如下信息

图 5 生成Sonar报告-1

注意：需要等待几分钟（等待时间取决于sonar报告的模块大小，可能需要更长的时间）

图 6 生成Sonar报告-2

最后看到如下信息时，表明sonar报告已经完成。

图 7 Sonar报告生成成功

Sonar中访问您的项目

现在登陆 http://localhost:9000 ，你将看到生成的项目报告

图8 本地生成的Sonar报告

Eclipse中集成Sonar

安装Eclipse的Sonar插件

通过Eclipse Market Place安装

图 9 Sonar的Eclipse插件安装（Market Place）1 图 10 Sonar的Eclipse插件安装（Market Place）2

通过Eclipse Software Update安装

点击Help -> Install New Software,将弹出Install对话框。 复制地址http://dist.sonar-ide.codehaus.org/eclipse/ 到Work with栏并回车，将显示可用的插件和组件列表，如下图

图 11 Sonar的Eclipse插件安装（通过安装新软件菜单）

选择Sonar Java, 按照步骤安装插件

注意：请确保你要关联Sonar的项目已经被Sonar安装版分析过

配置Eclipse中的Sonar

配置eclispe的本地/远程Sonar服务器

点击Window->Preferences->Sonar->Servers Sonar Eclipse预置的访问本地Sonar服务器的地址为http://localhost:9000/ ，你可以修改、删除或者新增一个地址

图 12 Eclipse中配置Sonar服务器

第一次链接你的项目

Sonar服务器配置完成后，下一步是将你的Eclipse项目链接到Sonar服务器，并利用Sonar服务器进行分析

首先，在Project Explorer中右键单击项目，然后点击Configure-> Associate with Sonar.

图 13配置/关联您的Eclipse项目到Sonar

在Sonar project文本位置输入项目的名称，并在列表框中选择

图 14关联您的Eclipse项目到Sonar 2

点击Finsh。您的项目现在关联到您的Sonar服务器上进行分析

分析和清理代码

执行本地分析，清理代码

图 15 配置模块 图 16 在Eclipse中配置Sonar模块

注意：请确保你的本地Sonar服务器已经启动（在运行Sonar一节描述），否则您无法看到您打算配置的Sonar项目

本地运行Sonar分析

图 17.a 设置Sonar分析为本地模式 图 17.b 本地运行Sonar分析 图 18 Sonar问题分析控制台 图 19 Sonar问题分析控制台2 图 20 Sonar问题标记