白盒自动化测试工具：FindBugs的使用指南

lsekfe

　1、FindBugs介绍
　　FindBugs是一款Java静态代码分析工具，与其他静态分析工具（如Checkstyle和PMD）不同，FindBugs不注重样式或者格式，它专注于寻找真正的缺陷或者潜在的性能问题,它可以帮助java工程师提高代码质量以及排除隐含的缺陷。有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。
　　FindBugs运用ApacheBCEL库分析类文件（class文件）而不是源代码，将字节码与一组缺陷模式进行对比以发现可能的问题。FindBugs的检测器已增至300多条，被分为不同的类型，常见的类型如下：
　　正确性（Correctness）：这种归类下的问题在某种情况下会导致bug，比如错误的强制类型转换等。
　　最佳实践反例（Badpractice）：这种类别下的代码违反了公认的最佳实践标准，比如某个类实现了equals方法但未实现hashCode方法等。
　　多线程正确性（Multithreadedcorrectness）：关注于同步和多线程问题。
　　性能（Performance）：潜在的性能问题。
　　安全（Security）：安全相关。
　　高危（Dodgy）：FindBugs团队认为该类型下的问题代码导致bug的可能性很高。
　　2、在Eclipse中安装FindBugs插件
　　以下为我的安装步骤，可能大家用的是MyEclipse步骤不仅相同。
　　Step1：

Step2:

Step3:

　3、在Eclipse中使用FindBugs操作步骤
　　3.1打开FindBugs视图
　　step1：

　step2：

　step3：

3.2执行FindBugs任务
　　右键单击你要检测的工程、包或文件-->FindBugs-->FindBugs。

　check完成后将在BugExplorer视图中看到问题列表，该列表以问题类型组织。


展开列表，双击列表中具体的问题就可以定位的具体的代码行。


4、配置FindBugs
　　在这里可以对FindBugs规则等进行详细设置。选择你的项目，右键-->Properties-->FindBugs-->

4.1 RunAutomatically开关
　　当此项选中后，FindBugs将会在你修改Java类时自动运行，如你设置了Eclipse自动编译开关后，当你修改完Java文件保存，FindBugs就会运行，并将相应的信息实时显示。
　　当此项没有选中，你只能每次在需要的时候自己去运行FindBugs来检查你的代码。
　　4.2 DetectorConfiguration选择项
　　在这里你可以选择所要进行检查的相关的BugPattern条目,你可以根据需要选择或去掉相应的检查条件。

4.3 Minimumprioritytoreport选择项
　　这个选择项是让你选择哪个级别的信息进行显示，有Low、Medium、High三个选择项可以选择，很类似于Log4J的级别设置啦。比如：
　　High选择项：只有是High级别的提示信息才会被显示；
　　Medium选择项：只有是Medium和High级别的提示信息才会被显示；
　　Low选择项：所有级别的提示信息都会被显示。
　　4.4 Reportbugcategories选择项
　　在这里是一些显示Bug分类的选择：
　　Maliciouscodevulnerability关于恶意破坏代码相关方面的
　　Correctness关于代码正确性相关方面的
　　Internationalization关于代码国际化相关方面的
　　Performance关于代码性能相关方面的
　　Multithreadedcorrectness关于代码多线程正确性相关方面的
　　5、Ant使用简介
　　有了Ant这样的自动化机制，就可以以多种方法监视软件质量。有许多种扫描源代码和二进制文件的工具，但是其中最流行的两种是PMD和FindBugs。PMD扫描源代码文件，并根据一系列规则检查其中的代码。如果代码有问题，它就会报告一个违规。FindBugs的作用与PMD相似，但是它扫描二进制文件（即类文件）并报告bug。
　　以下为配置脚本：

1. project name="analyze_asm_util" default="findbugs">
   
2. 
   
3. 　　   <!-- findbugs task definition -->
   
4. 　　   <property name="findbugs.home" value="/Users/ben/Documents/workspace/findbugs/findbugs" />
   
5. 　　   <property name="jvmargs" value="-server -Xss1m -Xmx800m -Duser.language=en -Duser.region=EN -Dfindbugs.home=${findbugs.home}" />
   
6. 
   
7. 　　    <path id="findbugs.lib">
   
8. 　　      <fileset dir="${findbugs.home}/lib">
   
9. 　　         <include name="findbugs-ant.jar"/>
   
10. 　　      </fileset>
    
11. 　　   </path>
    
12. 
    
13. 　　   <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
    
14. 　　      <classpath refid="findbugs.lib" />
    
15. 　　   </taskdef>
    
16. 
    
17. 　　   <taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
    
18. 　　      <classpath refid="findbugs.lib" />
    
19. 　　   </taskdef>
    
20. 
    
21. 　　   <taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
    
22. 　　      <classpath refid="findbugs.lib" />
    
23. 　　   </taskdef>
    
24. 
    
25. 　　   <taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
    
26. 　　      <classpath refid="findbugs.lib" />
    
27. 　　   </taskdef>
    
28. 
    
29. 　　   <!-- findbugs task definition -->
    
30. 　　   <target name="findbugs">
    
31. 　　      <antcall target="analyze" />
    
32. 　　      <antcall target="mine" />
    
33. 　　   </target>
    
34. 
    
35. 　　   <!-- analyze task -->
    
36. 　　   <target name="analyze">
    
37. 　　      <!-- run findbugs against asm-util -->
    
38. 　　      <findbugs home="${findbugs.home}"
    
39. 　　                output="xml:withMessages"
    
40. 　　                timeout="90000000"
    
41. 　　                reportLevel="experimental"
    
42. 　　                workHard="true"
    
43. 　　                effort="max"
    
44. 　　                adjustExperimental="true"
    
45. 　　                jvmargs="${jvmargs}"
    
46. 　　                failOnError="true"
    
47. 　　                outputFile="out.xml"
    
48. 　　                projectName="Findbugs"
    
49. 　　                debug="false">
    
50. 　　         <class location="asm-util-3.0.jar" />
    
51. 　　      </findbugs>
    
52. 　　   </target>
    
53. 
    
54. 　　   <target name="mine">
    
55. 
    
56. 　　      <!-- Set info to the latest analysis -->
    
57. 　　      <setBugDatabaseInfo home="${findbugs.home}"
    
58. 　　                            withMessages="true"
    
59. 　　                            name="asm-util-3.0.jar"
    
60. 　　                            input="out.xml"
    
61. 　　                            output="out-rel.xml"/>
    
62. 
    
63. 　　      <!-- Checking if history file already exists (out-hist.xml) -->
    
64. 　　      <condition property="mining.historyfile.available">
    
65. 　　         <available file="out-hist.xml"/>
    
66. 　　      </condition>
    
67. 　　      <condition property="mining.historyfile.notavailable">
    
68. 　　         <not>
    
69. 　　            <available file="out-hist.xml"/>
    
70. 　　         </not>
    
71. 　　      </condition>
    
72. 
    
73. 　　      <!-- this target is executed if the history file do not exist (first run) -->
    
74. 　　      <antcall target="history-init">
    
75. 　　        <param name="data.file" value="out-rel.xml" />
    
76. 　　        <param name="hist.file" value="out-hist.xml" />
    
77. 　　      </antcall>
    
78. 　　      <!-- else this one is executed -->
    
79. 　　      <antcall target="history">
    
80. 　　        <param name="data.file"         value="out-rel.xml" />
    
81. 　　        <param name="hist.file"         value="out-hist.xml" />
    
82. 　　        <param name="hist.summary.file" value="out-hist.txt" />
    
83. 　　      </antcall>
    
84. 　　   </target>
    
85. 
    
86. 　　   <!-- Initializing history file -->
    
87. 　　   <target name="history-init" if="mining.historyfile.notavailable">
    
88. 　　      <copy file="${data.file}" tofile="${hist.file}" />
    
89. 　　   </target>
    
90. 
    
91. 　　   <!-- Computing bug history -->
    
92. 　　   <target name="history" if="mining.historyfile.available">
    
93. 　　      <!-- Merging ${data.file} into ${hist.file} -->
    
94. 　　      <computeBugHistory home="${findbugs.home}"
    
95. 　　                           withMessages="true"
    
96. 　　                           output="${hist.file}">
    
97. 　　            <dataFile name="${hist.file}"/>
    
98. 　　            <dataFile name="${data.file}"/>
    
99. 　　      </computeBugHistory>
    
100. 
     
101. 　　      <!-- Compute history into ${hist.summary.file} -->
     
102. 　　      <mineBugHistory home="${findbugs.home}"
     
103. 　　                        formatDates="true"
     
104. 　　                      noTabs="true"
     
105. 　　                        input="${hist.file}"
     
106. 　　                        output="${hist.summary.file}"/>
     
107. 　　   </target>
     
108. 
     
109. 　　</project>

复制代码

ljc24787

太厉害了