SpotBugs（是FindBugs的继任者）安装、使用

news2024/11/22 17:39:21

SpotBugs介绍

SpotBugs和FindBugs的关系

SpotBugs是FindBugs的继任者，从SpotBugs停止的地方继续。
备注：FindBugs项目已经停止了，从2015年发布3.0.1版本以后再没有新的版本。

SpotBugs通过静态分析寻找java代码中的bug，通过发现bug模式来发现疑似问题。
它是一款免费软件，是FindBugs的一个分支。

SpotBugs参考资源

文档资源

https://spotbugs.readthedocs.io/en/latest/index.html
在这里插入图片描述

https://spotbugs.github.io/
在这里插入图片描述

代码库

https://github.com/spotbugs/spotbugs

在这里插入图片描述

SpotBugs对JRE (或 JDK) 版本的要求

SpotBugs是用JDK8版本构建的，所以运行需要JRE (或 JDK) 1.8.0及以后的版本。
SpotBugs可以扫描JDK8及更新的版本编译生成的字节码（即class文件）。

SpotBugs报告的标准bug模式

SpotBugs 可以检查400多种bug模式，分了10个大的类别：
https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html

在这里插入图片描述

SpotBugs检测器（Detectors）

https://spotbugs.readthedocs.io/en/latest/detectors.html#

Standard detectors默认是打开的，而Disabled detectors默认是关闭的。
在这里插入图片描述

安装SpotBugs Eclipse插件、用SpotBugs Eclipse插件运行SpotBugs

安装SpotBugs Eclipse插件

要在Eclipse中安装SpotBugs Plugin，需要 Eclipse Neon (4.6) 及以后版本。
我们用Eclipse Marketplace来安装，下面是安装步骤：
在这里插入图片描述

点击Restart Now，重新进入Eclipse。

从菜单Window->Preferences进入，在Java下面出现SpotBugs项，说明安装成功了：
在这里插入图片描述

SpotBugs配置

从菜单Window->Preferences进入，在Java下面找到SpotBugs项：
在这里插入图片描述

Reporter Configuraton

选择报告的类别

在Reporter Configuraton页面，可以选择报告的bug类别：
在这里插入图片描述

选择analysis effort

https://spotbugs.readthedocs.io/en/latest/effort.html
effort的值是调节了SpotBugs的内部flag，通过降低预测来降低计算成本。

在这里插入图片描述

Filter files

在Filter files页面可以配置包含filter文件、不包含filter文件。其中filter文件的介绍请参见：
https://spotbugs.readthedocs.io/en/latest/filter.html
在这里插入图片描述

Detector configuration

在Detector configuration页面，可以勾选或者不勾选某个/某些检测器：
在这里插入图片描述

在上面选中某一个检测器，下面会显示该检测器的详细信息：
在这里插入图片描述

检测器的信息跟SpotBugs官网中的detector对应：
在这里插入图片描述

启用项目特有的SpotBugs配置

在项目上右击，在弹出菜单中选择Properties：
在这里插入图片描述

找到SpotBugs：
在这里插入图片描述

如果要启用项目特有的配置，就在Enable project specific settings复选框打钩：
在这里插入图片描述

在java项目上设置自动运行SpotBugs

在项目上右击，在弹出菜单中选择Properties。在属性设置界面选中左侧的SpotBugs。
如果要自动运行，就在Run automatically复选框打钩，这样每次修改了项目中的类，SpotBug就会自动运行：
在这里插入图片描述

在java项目上立即运行SpotBugs

右击java项目，在弹出菜单中选择SpotBugs->Find Bugs，就会立即扫描：
在这里插入图片描述

在下面的Problems页出现扫描结果：
在这里插入图片描述

双击击某个违反项，就会跳到代码处：
在这里插入图片描述

将SpotBugs扫描结果保存为XML文件

右击java项目，在弹出菜单中选择SpotBugs->Save XML:
在这里插入图片描述

选择要导出的路径、输入文件名：
在这里插入图片描述

文件导出成功：
在这里插入图片描述

打开该文件看看内容片段（文件内容远比在Eclipse Problems窗口中显示的信息丰富）：
在这里插入图片描述

安装SpotBugs Maven插件、用SpotBugs Maven插件运行SpotBugs

安装SpotBugs Maven插件

https://spotbugs.readthedocs.io/en/latest/maven.html

在maven工程的pom.xml文件中build小节、reporting小节增加关于SpotBugs Maven插件的配置信息：

  <build>
    <pluginManagement>
        <plugin>
          <groupId>com.github.spotbugs</groupId>
          <artifactId>spotbugs-maven-plugin</artifactId>
          <version>4.7.3.5</version>
        </plugin>
      </plugins>
    </pluginManagement>
    <plugins>
        <plugin>
          <groupId>com.github.spotbugs</groupId>
          <artifactId>spotbugs-maven-plugin</artifactId>
          <configuration>
              <htmlOutput>true</htmlOutput>
          </configuration>
        </plugin>
     </plugins>
  </build>
  <reporting>
    <plugins>
      <plugin>
        <groupId>com.github.spotbugs</groupId>
        <artifactId>spotbugs-maven-plugin</artifactId>
        <configuration>
          <htmlOutput>true</htmlOutput>
        </configuration>
      </plugin>
    </plugins>
  </reporting>

等待一会儿，插件及其依赖的SpotBugs版本下载到maven本地仓库了：
在这里插入图片描述