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

发表于:2020-9-22 10:08

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:潦草白纸    来源:博客园

  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。
  以下为配置脚本:
   <project name="analyze_asm_util" default="findbugs">

     <!-- findbugs task definition -->
     <property name="findbugs.home" value="/Users/ben/Documents/workspace/findbugs/findbugs" />
     <property name="jvmargs" value="-server -Xss1m -Xmx800m -Duser.language=en -Duser.region=EN -Dfindbugs.home=${findbugs.home}" />

      <path id="findbugs.lib">
        <fileset dir="${findbugs.home}/lib">
           <include name="findbugs-ant.jar"/>
        </fileset>
     </path>

     <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask">
        <classpath refid="findbugs.lib" />
     </taskdef>

     <taskdef name="computeBugHistory" classname="edu.umd.cs.findbugs.anttask.ComputeBugHistoryTask">
        <classpath refid="findbugs.lib" />
     </taskdef>

     <taskdef name="setBugDatabaseInfo" classname="edu.umd.cs.findbugs.anttask.SetBugDatabaseInfoTask">
        <classpath refid="findbugs.lib" />
     </taskdef>

     <taskdef name="mineBugHistory" classname="edu.umd.cs.findbugs.anttask.MineBugHistoryTask">
        <classpath refid="findbugs.lib" />
     </taskdef>

     <!-- findbugs task definition -->
     <target name="findbugs">
        <antcall target="analyze" />
        <antcall target="mine" />
     </target>

     <!-- analyze task -->
     <target name="analyze">
        <!-- run findbugs against asm-util -->
        <findbugs home="${findbugs.home}"
                  output="xml:withMessages"
                  timeout="90000000"
                  reportLevel="experimental"
                  workHard="true"
                  effort="max"
                  adjustExperimental="true"
                  jvmargs="${jvmargs}"
                  failOnError="true"
                  outputFile="out.xml"
                  projectName="Findbugs"
                  debug="false">
           <class location="asm-util-3.0.jar" />
        </findbugs>
     </target>

     <target name="mine">

        <!-- Set info to the latest analysis -->
        <setBugDatabaseInfo home="${findbugs.home}"
                              withMessages="true"
                              name="asm-util-3.0.jar"
                              input="out.xml"
                              output="out-rel.xml"/>

        <!-- Checking if history file already exists (out-hist.xml) -->
        <condition property="mining.historyfile.available">
           <available file="out-hist.xml"/>
        </condition>
        <condition property="mining.historyfile.notavailable">
           <not>
              <available file="out-hist.xml"/>
           </not>
        </condition>

        <!-- this target is executed if the history file do not exist (first run) -->
        <antcall target="history-init">
          <param name="data.file" value="out-rel.xml" />
          <param name="hist.file" value="out-hist.xml" />
        </antcall>
        <!-- else this one is executed -->
        <antcall target="history">
          <param name="data.file"         value="out-rel.xml" />
          <param name="hist.file"         value="out-hist.xml" />
          <param name="hist.summary.file" value="out-hist.txt" />
        </antcall>
     </target>

     <!-- Initializing history file -->
     <target name="history-init" if="mining.historyfile.notavailable">
        <copy file="${data.file}" tofile="${hist.file}" />
     </target>

     <!-- Computing bug history -->
     <target name="history" if="mining.historyfile.available">
        <!-- Merging ${data.file} into ${hist.file} -->
        <computeBugHistory home="${findbugs.home}"
                             withMessages="true"
                             output="${hist.file}">
              <dataFile name="${hist.file}"/>
              <dataFile name="${data.file}"/>
        </computeBugHistory>

        <!-- Compute history into ${hist.summary.file} -->
        <mineBugHistory home="${findbugs.home}"
                          formatDates="true"
                        noTabs="true"
                          input="${hist.file}"
                          output="${hist.summary.file}"/>
     </target>

  </project>

      本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号