-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Sonar
springside edited this page May 9, 2012
·
41 revisions
##Overview Sonar -- an open platform to manage code quality. 是SCM, CI, Issue Tracker和Wiki外,另一个必不可少的项目管理软件.
什么maven site, 什么Jenkins插件,和它比都弱爆了。
每次升级Sonar版本,总要做的几样配置,Sonar backup只能备份所有profile的rule和alert,以及Global Settings。
- DashBoard: 在首页点击edit filter, 删除Versions,Links,BuildDates,加入Critical/Major/Minor violations,Coverage。其他如Skip UnitTest,Duplication可以根据需要添加。
另外,对于Multi-Module的项目,可以新建一个Share的Filter, 选择显示subproject。 - Widgets: 在任一项目页点击Configure widgets, 删除LCOM4, Complexity和Descritpion。再把Events移到右边。再添加TimeLine(加入如Coverage,Rules compliance的Metrics)
- 调整分值: 直接加大2倍:在General Settings->General中,INFO=0;MINOR=3;MAJOR=9;CRITICAL=15;BLOCKER=30
- 在UpdateCenter安装SCM插件, 并依照Guides设置,能方便看出是谁造成的violations。
- 在UpdateCenter安装TagList插件, 统计代码中遗留的//TODO等标签。
SpringSide的Profile在Soanr 3.0 的Sonar way with Findbugs规则上进行修改。 规则已导出到support/sonar目录里。
###Checkstyle changes
- Enable "JavaNCSS", classMaximum from 1500 to 500, fileMaximum from 2000 to 600-- 排除注释后的每个方法/类的最大代码行数。methodMaximum保持50的默认值。
- Enable "Nested For Depth", max from 1 to 3 -- if/else/for/while等嵌套代码的层数。
- Enalbe "Parameter Number", max from 7 to 5 -- 长长的函数参数列表从来都最让人烦,从默认的7个进一步降到5个。
- Change "Magic Number" from Minor to Info --本意很好,但无奈太多各种可允许的例外情况,降到Info,有空可以看看。
可选修改:
- Enable "Declaration Order", from Info to Minor -- 按Java编程规范,变量定义先public再protected再private变量再构造函数再普通函数是个挺好的实践,所以提升到Minor级别。
- Enalbe "One Statement Per Line" -- 只有恐怖的C++才允许一行里面写两句话,如 x = 1; y = 2;
- Change "Redundant Throws" allow uncheked=true -- 在throws里把可能抛出来的unchecked exception也列出来绝对是个很Nice的行为,不应该被惩罚。
- Disable "Hide Utility Class Constructor" -- 本意很好,只提供静态方法的工具类不应该能实例化。但无论是把类设为abstract还是添加private的构造函数都不够优雅,都是静态函数的也不一定是工具类。还是相信现在的程序员不会new一个变量来调用static方法算了。
- Disable "Visibility Modifier" -- 成员变量只能是private/protected,这条规则的唯一作用是提醒那些忘记写private,变成了package share level的变量,但其实也无关痛痒。但个人更喜欢在POJO里直接public field,取消掉getter/setter。
- Disable "Final Class" -- "class which has only private constructors is declared as final", 作用不大干脆不要了。
###PMD changes
- Disable "Avoid Throwing Raw Exception Types"
- Disable "Signature Declare Throws Exception"
可选修改:
- Enable "Add Empty String"
- Enalbe "Assignment In Operand"
- Enable "Avoid Multiple Unary Operators"
- Enable "Boolean Get Method Name"
- Enable "Misplaced Null Check"
- Enalbe "Package case"
- Enable "Use Proper Class Loader"
###FindBugs changes
- Disable "Bad practice - Method invoked that should be only be invoked inside a doPrivileged block"
- Disable "Correctness - Field not initialized in constructor"
可选修改:
- Disable "Malicious code vulnerability - May expose internal representation by incorporating reference to mutable object"
- Disable "Malicious code vulnerability - May expose internal representation by returning reference to mutable object"
###Sonar Rules changes
- Enable "Avoid commented-out lines of code", change from Major to Minor
- Enable "Avoid use of deprecated method"
###告警阀值
- Rules compliance : 95% warning, 90% error
- Coverage : 70% warning, 50% error