常用JAVA代码质量静态检查工具.ppt
常用JAVA代码质量静态检查工具,开发一部-胡伟军2009年6月,目录,软件开发经历反省我们代码中常见几类问题Quality Metrics Tools CheckStylePMDFindBugsJSLink,我们代码中常见几类问题,使用了不规范的变量和方法名EsbResultModel validRule(HashMap orderInfo,ArrayList orderItems,String Role);String role要小写类、public 方法和常量javadoc的缺失javadoc中的声明跟实际的方法不一致，例如方法实际只有1个参数，而javadoc里param定义了多个（估计是方法签名的时候没有同步的修改javadoc）,我们代码中常见几类问题,错误的使用/*/和/*/很多public方法和常量使用了/*/来注释，导致注释内容不能被写入javadoc。而另一方面是错误使用/*/导致错误的内容被写入javadoc存在未被使用的方法和变量 这些不被使用方法和变量名会增加日后bug修改、代码维护的成本方法超长一个方法超过150行，是不是太长太复杂了。,我们代码中常见几类问题,代码中有不少magic-number和magic-string 刘谦的魔术很好看，可是如果你维护的代码跟刘谦的一样，估计你会抓狂的！String s=“0000”+Integer.toString(ch,16);0000是什么，16是啥东东，就算是作者3个礼拜也不记得当初写这段代码的用意了。Import了一些不需要的类提交代码以前请务必Organize Imports。,我们代码中常见几类问题,有些代码的写法不容易理解不一致的代码风格 例如，String oneitems vs String oneitems 前者是C/C+的编码风格；咱们写的是java，就统一用String oneitems吧。,NO EXCUTABLE,Why using Quality Metrics Tools,一个软件的生命周期中，80%的花费在于维护 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码,CheckStyle,CheckStyle用来检查代码格式、规范、风格检查并强制执行统一的代码风格检查Javadoc检查类、变量、方法的命名检查类和方法的大小检查编码错误，例如magic number,Checkstyle-安装,Eclipse插件地址,Checkstyle-启用,Checkstyle配置规范,Checkstyle使用效果,黄色的区域就是checkstyle检查出有问题的地方（红色表示错误，黄色表示警告）。,Checkstyle-编写javadoc注意点,/*inheritDoc*/public int checkReturnTag(final int aTagIndex,JavadocTag aTags,int aLineNo),PMD,PMD提供了一些开发过程中的最佳实践。Possible bugs-empty try/catch/finally/switch statements Dead code-unused local variables,parameters and private methods Suboptimal code-wasteful String/StringBuffer usage Overcomplicated expressions-unnecessary if statements,for loops that could be while loops Duplicate code-copied/pasted code means copied/pasted bugs,PMD-Exception 规则,AvoidCatchingThrowableSignatureDeclareThrowsExceptionExceptionAsFlowControlAvoidThrowingRawExceptionTypesAvoidThrowingNullPointerExceptionAvoidRethrowingExceptionDoNotExtendJavaLangErrorDoNotThrowExceptionInFinallyAvoidThrowingNewInstanceOfSameExceptionhttp:/,PMD,PMD中的很多规则会比较有争议，或者跟大家现有的技术框架、代码结构有冲突。大家可以通过自定义的这些规则的级别（Error，Warning）来把握对这些规则的使用程度。,FindBugs,FindBugs是一个java代码的静态代码分析工具，用来发现那些潜在的、常见的、很难被发现的bug.,其他的工具,Jslint-The JavaScript Code Quality Tool,Why using Quality Metrics Tools,提升代码质量降低维护成本提高开发效率,相关资料,Java Power Tools,THE END谢谢！,
