[Tech] SonarQube 使用介绍

SonarQube特性

多语言的平台

支持超过20种编程语言,包括Java, Python, C#, C/C++, JavaScript等常用语言。通常采用添加插件的方式增加某种语言。

持续集成

通过对某项目的持续扫描,可以对该项目的代码质量做长期的把控,并且预防新增代码中的不严谨和冗余。

关注新代码

有一个词叫"fixing the water leak",不知道用中文该如何翻译,大概就是从水源处控制漏水。而SonarQube正是一款专注于新代码漏洞的工具,可以修复及改善新代码,从源头把控整体代码质量。

质量门

在扫描代码后可以通过对“质量门”的比对判定此次“构建”的结果是否通过,质量门可以由用户定义,由多维度判定是否通过。

自定义规则

用户可根据不同项目自定义Quality Profile以及Quality Gates。

丰富的插件

SonarQube拥有丰富的插件,从而拥有强大的可扩展性。

SonarQube使用

SonarQube入口
  • 将Jenkins与SonarQube“绑定”后,便可通过Jenkins进入SonarQube的相应项目页面。具体方法如下: 进入项目 -> SonarQube (此时下方展示的SonarQube Quality Gate显示的是最近一次SonarQube扫描结果)
SonarQube Entrance.jpeg
  • 当然也可以直接通过输入SonarQube Server URL进入哦
代码质量评判维度

如何评判项目代码的优劣呢?代码语法是否合规、重复率、是否安全并易于后续的维护与修改等等因素都在其考量范围内。而SonarQube则主要提供了以下评判代码优劣的维度,用户也可以根据以下维度的通过标准来定义项目的Quality Gate。

  • 可靠性
    所谓可靠性,就是指代码中的语法是否合规,是否有语法逻辑错误或是一些不推荐使用的方法,主要用Bugs来衡量。
    例如,break和continue是否在循环体内,分支语句的判断条件是否不同,数组是否越界,是否使用了print函数,当然也包括单元测试是否全部通过等等。还有很多不同语言所特有的编码规范,SonarQube都会通过相应语言的Quality Profile检测出来。
py bug.png
  • 安全性
    安全性也是考量一个项目代码质量的重要维度,这里的安全性主要指的是项目代码是否有潜在的“可被攻击”的漏洞,SonarQube主要用Vulnerability来衡量。
    例如,代码中是否有写死的IP地址,写死的或是空的数据库密码。
py vulnerability.png
  • 可维护性
    可靠性和安全性可以说是评判代码质量最重要的两个因素,也被SonarQube列在最顶端。所以Bugs和Vulnerabilities是建议用户立即修改并且日后避免的。而任何项目都需要维护,所以可维护性也是考量代码质量的重要标准,当然,优先级稍逊于可靠性与安全性。
    这里,SonarQube使用Code Smell来衡量。例如,循环或分支太深(眼睛都要看花了),java中的main方法最好不要"throw"异常等等。
py code smell.png
  • 代码重复率
    SonarQube使用Duplications来评判代码的重复率,开发人员也可以以此标准来衡量自己的代码是否精简,从而将一些通用的类或方法进行封装哦。

  • 单元测试覆盖率
    完善的单元测试可以使代码更加可靠,也可以减少很多后续的风险呢。SonarQube用Coverage来考量单元测试覆盖率。

结果查看

当您打开SonarQube时,建议您按以下步骤查看您代码的扫描结果并做出适当的修改哦。

  • Step1. Quality Gate
    一般来说,当项目紧急时,如果Quality Gate为Pass完全就可以不用进入SonarQube查看代码质量分析结果了,因为当其Pass时说明您的代码质量已经没有太大问题了,只需要改一些不影响代码结果的小地方就可以了。当然,前提是您设置了一个比较合适的Quality Gate哦。
Quality Gate
  • Step2. Bugs & Vulnerabilities
    这两个的数量便对应着上文"可靠性"以及"安全性"这两个维度的质量标准哦,这两个指标可以说在很大程度上反映了代码的质量水平,所以建议开发者尽量将这两个数量降为0哦。
Bug and Vulnerability
  • Step3. Leak Period
    都说新提交的代码容易出问题,如果之前的代码都已使用SonarQube的扫描结果做了相应的修改的话,我建议可以主要关注"Leak Period"的衡量指标,它主要反映了新提交的代码的质量水平。开发者可以及时修改新提交代码中的问题以绝后患。
    不过第一次扫描的时候是没有"Lead Period"的哦,所以建议第一次跑代码的时候还是将所有维度的质量问题都检查一遍以免后续漏改。
Leak Period
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容