sonar工具

本文章来自于https://www.cnblogs.com/topplay/p/3945013.html
Sonar是一个用于代码质量管理的开源平台,用于管理Java源代码的质量。通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具,比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理,通过量化的方式度量代码质量的变化,从而可以方便地对不同规模和种类的工程进行代码质量管理。同时 Sonar 还对大量的持续集成工具提供了接口支持,可以很方便地在持续集成中使用 Sonar。此外,Sonar 的插件还可以对 Java 以外的其他编程语言提供支持,对国际化以及报告文档化也有良好的支持。

SONAR安装&运行

下载地址:http://www.sonarqube.org/downloads/

运行:解压后,根据平台运行bin下不同目录下的启动脚本。对于linux x86_64,运行bin/linux-x86-64/sonar.sh。

可用命令:

./sonar.sh { console | start | stop | restart | status | dump }

安装插件:

SONAR中文包:http://docs.codehaus.org/display/SONAR/Chinese+Pack

将插件放置在${SONARHOME}/extensions/plugins下,重启sonar后生效。注意版本号要匹配。本例中,SonarQube版本为4.4,所以选择插件版本为1.8的。

image

SONAR + Maven分析代码质量

1)设置sonar使用的数据库信息。

本例设置sonar使用mysql数据库存储分析数据。保存设置后,执行restart使其生效。

${SONARHOME}/conf/sonar.properties:

<pre class="prettyprint linenums prettyprinted" style="margin: 0px; padding: 0px; white-space: pre-wrap; word-wrap: break-word;">

  1. # Permissions to create tables, indices and triggers must be granted to JDBC user.

  2. # The schema must be created first.

  3. sonar.jdbc.username=root

  4. sonar.jdbc.password=root

  5. # Comment the following line to deactivate the default embedded database.

  6. #sonar.jdbc.url=jdbc:h2:tcp://localhost:9092/sonar

  7. #----- MySQL 5.x

  8. # Comment the embedded database and uncomment the following line to use MySQL

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

</pre>

2)需要在Maven的settings.xml设置sonar信息。

其中<sonar.host.url>http://localhost:9000</sonar.host.url>指明了sonar服务器的地址。所以在执行maven命令的时候,<sonar.host.url>指明的服务器必须已运行起来。

${MAVEN_HOME}/conf/settings.xml:

<pre class="prettyprint linenums prettyprinted" style="margin: 0px; padding: 0px; white-space: pre-wrap; word-wrap: break-word;">

  1. <profiles>
  2. <profile>
  3. <id>sonar</id>
  4. <properties>
  5. <sonar.jdbc.url>jdbc:mysql://192.168.198.128:3306/sonar</sonar.jdbc.url>
  6. <sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
  7. <sonar.jdbc.username>root</sonar.jdbc.username>
  8. <sonar.jdbc.password>root</sonar.jdbc.password>
  9. <sonar.host.url>http://localhost:9000</sonar.host.url>
  10. </properties>
  11. </profile>
  12. </profiles>
  13. <activeProfiles> <activeProfile>sonar</activeProfile>
  14. </activeProfiles>

</pre>

3)执行mvn sonar:sonar命令进行代码分析。

我们可以在Eclipse中,对一个标准maven工程执行sonar。说明:由于maven对sonar有很好的支持,会自动执行相应的脚本,所以无需在pom中添加sonar说明。

在执行maven进行sonar分析之前,必须确保sonar服务器已经处于运行状态。本例中sonar服务器运行在localhost:9000上。

首先,执行sonar:sonar命令,最后得到输出如下输出。如果输出”BUILD SUCCESS“说明已经构建成功。

image

然后,我们可以在浏览器查看分析结果。

查看分析结果

对于使用sonar自带服务器来说,在浏览器访问:http://sonar_ip:9000,打开sonar结果页面。可使用admin/admin账号登录进入。

1)home页

下面是home页,右边PROJECTS页面列出了所有的工程。点击红色框内的链接,可以查看详细情况。

image

2)工程总面板视图

Dashboard包含了很多信息,比如程序统计信息、问题统计信息、技术债务、代码复杂度、单元测试覆盖度等。

image

3)Hotspots热点区

在热点区,可以查看比较主要(hot)的信息。

image

4)问题视图

点击左侧导航树的“问题”,打开问题视图页。通过点击问题数,如下红框所示,可以查看具体问题。

image

点击问题数后,进入具体问题页。SonarQube允许管理员对问题进行重新确认,比如可以认为一个打开的问题是误判的。

image

下面是认为一个问题是误判后的情况。

image

在问题页面,可以通过“状态”搜索问题。下面是搜索“误判”问题的结果。

image

5)技术债务

这里列出了修复问题所需要的时间,所谓技术债务。出来混总要还的,遗留的问题越多,技术债务越大。

image

6)问题明细

这里列出问题明细,包括问题严重级别,对应的问题数量,问题的描述。

image

结合Jenkins

可以将SONAR服务器放置在任意master或者slave节点上,在进行sonar分析时,必须在maven的conf/settings.xml中配置sonar服务器信息。然后就可以在jenkins中进行sonar分析了。

有两种方法使jenkins与sonar结合:一种就是上面介绍的通过maven(jenkins -maven - sonar),另外一种是直接在jenkins中调用sonar。

参考:

SONAR+MAVEN项目质量管理:http://www.linxiaosheng.com/post/2013-12-06/40060353952

Jenkins + sonar持续代码审查:http://www.cnblogs.com/gao241/p/3190701.html

SONAR介绍: http://www.cnblogs.com/gao241/p/3190701.html

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容