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