将 sonarQube 和 gradle spring boot 项目集成

在联想的项目接触了一下 sonarQube 整体来说还是有很多可圈可点之处的,碰巧最近有一个相关产品的选择试用的调研,就尝试了一下下。

sonarQube 自己说自己用于做 continuous code quality, 从它所生成的默认的报告来看,主要包含了如下几个部分:

不过打开一看会发现其实 Bugs & VulnerabilitiesCode Smells 基本上就是 lint 所做的事情,比如代码风格不符合 java 的规约呀,在使用 Optional 之前判断其是否 isPresent 呀等等,不过人家本来就是做静态检查的也无可厚非。

Code Smells 这个名字实在是太唬人了,在 重构 里定义设计的好坏在于有没有代码的坏味道,如果 sonarqube 有能力甄别所有的代码坏味道的话,那还怕神马低质量代码呢。不过起码 sonarqube 有能力甄别一部分低级的代码坏味道,比如过长的方法参数:

Constructor has 9 parameters, which is greater than 7 authorized.

再比如重复的代码呀

1 duplicated blocks of code must be removed.

甚至是提醒我们哪个方法所在的位置不合适

Move this method into "Builder"

这么看来其功能还是可圈可点的,而且我所使用的还仅仅是最基本的配置,没有做任何的自定义。

集成

下面我介绍一下如何把 sonarqube 和 spring boot gradle 的项目做集成的。

安装 sonarqube

最好的安装办法自然是 docker

docker run -d --name sonarqube -p 9000:9000 -p 9092:9092 sonarqube

修改 gradle

按照 sonarqube 的文档 添加插件。

plugins {
  id "org.sonarqube" version "2.4"
}

然后 ./gradlew clean test sonar 执行命令。之后就可以在 http://localhost:9000 看到结果了。

不过这个时候你会发现并没有测试覆盖率的数据。

这是因为 sonarqube 自己不做测试覆盖的处理,它依赖于其他的测试覆盖工具。比如这里我们使用 jacoco

build.gradle 中添加 jacoco:

apply plugin 'jacoco'

然后 ./gradlew clean test jacoco sonar 再去 http://localhost:9000 查看就有相应的数据了。

和 ci 集成

刚才我们只是将我们的项目和一个本地的 sonarqube server 集成了,但是在实际项目中我们通常都是在 ci 中执行 sonar 命令并有一个共有的 sonar server 展现目前主分支代码的质量。那么,我们就需要在 ci 中指定外部的 sonar server 地址以及一些其他自定义的内容。

由于 sonarqube 支持以命令行的方式传入参数,这样的工作非常的简单:

./gradlew sonar -Dsonar.host.url=http://sonar.mycompany.com -Dsonar.verbose=true

最后附上测试项目地址

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

推荐阅读更多精彩内容