sonarqube定义代码质量

sonarqube可以集成findbug,pwd,lint等静态代码检查工具,提供统一的检查平台.

sonar代码检测的标准:

1、Reliability可靠性:低于A

可靠性比率的计算方法:

A = 0 Bug 最高等级A,表示代码无bug

B = at least 1 Minor Bug 代码只要有一个次要bug,等级就为B

C = at least 1 Major Bug 只要包含一个重要bug,等级将为C

D = at least 1 Critical Bug 只要有一个严重bug,等级评估为D

E = at least 1 Blocker Bug 只要有一个最高等级的阻断级别的bug,可靠性评估为E,最低级别。

2、Security安全性:低于A

安全度指标计算方法:

A = 0 Vulnerability 没有漏洞时,项目评估为最高级别A

B = at least 1 Minor Vulnerability 只要包含一个次要漏洞,项目评估为级别B

C = at least 1 Major Vulnerability 只要包含一个重要漏洞,项目评估为级别C

D = at least 1 Critical Vulnerability 只要包含一个严重漏洞,评估为D

E = at least 1 Blocker Vulnerability 只要包含一个阻断漏洞,项目评估为最低级别E

3、Maintainability可维护性:低于A

可维护性等级范围从A(非常好)到E(非常差)。 评级由技术债务比率的值决定,技术债务比率是将项目的技术债务与从零开始重写代码所需的成本进行比较。 A到D的默认值为0.05,0.1,0.2,0.5。任何超过0.5评级就为E。

4、Coverage覆盖率:新增覆盖率低于60%

Coverage

行覆盖和条件覆盖的混合。单元测试覆盖多少源代码。Coverage = (CT + CF + LC)/(2*B + EL)

其中 :

CT = conditions that have been evaluated to ‘true’ at least once至少有一次被判断为true的条件数

CF = conditions that have been evaluated to ‘false’ at least once 至少一次被判断为false的条件数

LC = covered lines = lines_to_cover uncovered_lines 已覆盖的行数

B = total number of conditions 条件总数

EL = total number of executable lines (lines_to_cover) 所有可执行的代码总行数

5、Duplicated Lines:新增代码重复行高于3%

其中 :重复率=重复行数/总行数*100

6、Complexity复杂度:高于10

以下关键词增加复杂性:if, for, while, case, catch, throw, return (不是方法的最后一个语句), &&, ||, ?

else, default,  finally不增加复杂度

代码复杂度过高将难以理解、难以维护。

计算公式1:V(G)=E-N+2P。其中,E表示控制流图中边的数量,N表示控制流图中节点的数量,P图的连接组件数目(图的组件数是相连节点的最大集合)。因为控制流图都是连通的,所以P为1.

圈复杂度 代码状况    可测性 维护成本

1-10     清晰、结构化  高       低

11-20   复杂                中        中

21-30  非常复杂         低        高

>30     不可读        不可测     非常高

常遇到的问题:

坏味道,漏洞,bug,代码规范。

Bugs:

1.A "NullPointerException" could be thrown; "issue" is nullable here.

空指针异常.

2.Cast one of the operands of this addition operation to a "float".

不同类型的值做运算,需要统一成一种类型.

3.Use an "instanceof" comparison instead.

例如:RuntimeException.class.getName().equals(className);改成instanceof.

4.Use "BigDecimal.valueOf" instead.

new BigDecimal(teraBytes)改成valueOf.

Vulnerability:

1.Make tag a static final constant or non-public and provide accessors if needed.

public String tag;把tag变量变成静态常量或非公共常量,并在需要时提供访问器。

2.Use a logger to log this exception.

e.printStackTrace();改成logger.

3.Do something with the "boolean" value returned by "createNewFile".

public static File compressImage(){}返回值类型不对,改成boolean.

Code Smell:

1.Remove this unused "TAG" private field.

移除无用的自定义变量.

2.Rename this package name to match the regular expression '^[a-z]+(\.[a-z][a-z0-9]*)*$'.

包名书写要符合正则规范.

3.Add a nested comment explaining why this method is empty, throw an UnsupportedOperationException or complete the implementation.

无用的空方法,没有添加注释,说明用处.

4.Introduce a new variable instead of reusing the parameter "percent".

变量名重复使用.

5.Catch Exception instead of Throwable.

捕获异常而非直接抛出.

6.Add a private constructor to hide the implicit public one.

缺少私有构造函数.

7.This block of commented-out lines of code should be removed.

注释掉的代码块应该删除.

8.Change this "try" to a try-with-resources.

传统的try-catch-finally,当需要关闭的资源很多时,代码finally会很多,导致代码冗余.换成try-with的模式会使得代码简洁.

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

推荐阅读更多精彩内容