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

最新推荐文章于 2024-05-17 10:01:41 发布
最新推荐文章于 2024-05-17 10:01:41 发布
阅读量1.4k 收藏 2
点赞数
文章标签： java SpotBugs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/panghuangang/article/details/132720670
版权

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本地仓库了：
在这里插入图片描述
在这里插入图片描述

goals

spotbugs:spotbugs

https://spotbugs.github.io/spotbugs-maven-plugin/spotbugs-mojo.html

用SpotBugs分析目标工程，其中很多参数可以调节、控制分析。
备注：该goal本身没有将java文件编译为class文件的动作。

示例：
先调用mvn compile进行编译，然后调用mvn spotbugs:spotbugs进行分析：

在这里插入图片描述
在这里插入图片描述

到maven工程的target目录下查看输出内容：
在这里插入图片描述
打开spotbugs.html查看输出结果：
在这里插入图片描述
在这里插入图片描述

spotbugs:check

https://spotbugs.github.io/spotbugs-maven-plugin/check-mojo.html

用SpotBugs分析目标工程，如果发现问题，就停止构建。

示例：
先调用mvn compile进行编译，然后调用mvn spotbugs:check：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

到maven工程的target目录下查看输出内容：
在这里插入图片描述

spotbugs:gui

https://spotbugs.github.io/spotbugs-maven-plugin/gui-mojo.html

调用 SpotBugs GUI（图形用户界面）显示分析结果。
备注：要先用其它的goal生成分析结果，再调用此goal显示分析结果。

示例：
先调用mvn compile进行编译，然后调用mvn spotbugs:spotbugs进行扫描分析、最后调用mvn spotbugs:gui拉起SpotBugs的图形用户界面显示分析结果：
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

在图形用户界面选中某一个bug，会显示详细信息：
在这里插入图片描述

spotbugs:help

显示帮助信息。

示例：
执行spotbugs:help：
在这里插入图片描述
在这里插入图片描述

听海边涛声
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
maven~生成spotbug文档
m0_66876551的博客
04-25 1637
对于maven的一些插件来说，它们也都有着自己的依赖关系，建议把依赖的包和插件也写到pom里，如果你不写，在mvn时，它会自己去下载,如图： 如果你希望生成spotbug文档，你可以添加下面的几个插件，注意它们的版本号，需要对应清楚 <plugins> <!-- 代码检查 --> <plugin> <groupId>org.apache.maven.plugins</gr
软件构造：关于SpotBugs的安装及使用
m0_53533796的博客
06-14 1018
软件构造：关于SpotBugs的安装及使用
SpotBugs(一):使用简介
weixin_42717117的博客
03-18 3916
文章目录前言一、SpotBugs是什么？二、使用步骤1.引入SpotBugs插件2.使用Maven Helper插件3.不使用使用Maven Helper插件结果 前言 此文件将介绍在IDEA中使用SpotBugs的配置 一、SpotBugs是什么？ 官方:https://spotbugs.github.io/ 主要用途就是用来查找Java代码中的错误的程序,让我们的编码更加规范. 二、使用步骤 1.引入SpotBugs插件 代码如下（示例）： <build> <plugin>
SpotBugs使用
javajingling的专栏
02-26 1252
spotbugs命令行参数解析
探索代码质量的新境界：SpotBugs - 前身为FindBugs
最新发布
gitblog_00024的博客
05-17 393
探索代码质量的新境界：SpotBugs - 前身为FindBugs 项目地址:https://gitcode.com/findbugsproject/findbugs 项目介绍 在软件开发的世界里，错误往往是难以避免的，但我们可以采取预防措施来减少它们的发生。SpotBugs，原名为FindBugs，是一个强大的静态代码分析工具，致力于帮助开发者发现并修复Java代码中的潜在问题。这个开源项目现在...
spotbug扫描java代码问题
wdd668的专栏
03-03 1323
spotbug检查提示 Random object created and used only once 代码： for (int i = 0; i < 1; i++) { sb.append(numberArr[r.nextInt(numberArr.length)]); } Random object created and used only once This code creates a java.util.Random object, uses it t.
使用SpotBugs/FindBugs进行代码检查
weixin_30920513的博客
01-25 380
原po:https://blog.csdn.net/zhangb00/article/details/8407070 SpotBugs 介绍　　SpotBugs是Findbugs的继任者（Findbugs已经于2016年后不再维护，see https://mailman.cs.umd.edu/pipermail/findbugs-discuss/2016-November/004321.h...
spotbugs：SpotBugs是FindBugs的继任者。 静态分析工具，用于查找Java代码中的错误
02-03
是的精神继任者，从它在社区的支持下停止发展。 SpotBugs是根据。 更多信息请访问。 在仍然可以找到很多东西。 建立 SpotBugs是使用构建的。 推荐的获取方法是简单地运行gradlew （或gradlew.bat ）包装器，该包装...
SpotBugs是FindBugs的继任者静态分析的工具用来寻找Java代码中bug
08-06
1. **安装与集成**：SpotBugs可以作为独立的命令行工具使用，也可以集成到各种IDE（如Eclipse、IntelliJ IDEA）和构建工具（如Maven、Gradle）中。在IDE中集成SpotBugs，可以方便地在编写代码时实时获取反馈。 2. *...
sonar-findbugs:SonarQube的SpotBugs插件
05-04
SonarQube Spotbugs插件说明/功能该插件需要，并使用 ， 和提供编码规则。用法在质量配置文件中，从Spotbugs，fb-contrib或Find Security Bugs规则存储库中激活一些规则，然后对项目进行分析。配置可以使用声纳Web...
findbugs在eclipse中安装及使用
10-31
FindBugs 在 Eclipse 中的安装及使用 FindBugs 是一个静态分析工具，检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。FindBugs 可以在不实际运行程序的情况对软件进行分析，检测出一些隐藏...
spotbugs,spotbug是findbugs的继承者。一种静态分析工具，用于查找Java代码中的错误。.zip
10-13
SpotBugs is the spiritual successor of FindBugs, carrying on from the point where it left off with support of its community. SpotBugs is licensed under the GNU LESSER GENERAL PUBLIC LICENSE. More information at the official website. A lot of things can still be found at the old FindBugs website. Bui
IntelliJ IDEA FindBugs-IDEA 扫描bug插件
09-07
无需解压，直接在idea---->file---->settings---->plugins---->Install plugin from disk 选中压缩包，点击apply---->ok，重启idea即可。
spotbugs-benchmark：Ansible剧本，可运行SpotBugs和FindBugs的基准测试
02-10
除非遵守许可，否则不得使用此文件。 您可以在以下位置获得许可的副本： 除非适用法律要求或以书面形式同意，否则根据“许可”分发的软件将按“原样”分发，而没有任何明示或暗示的保证或条件。 有关许可下特定的...
FindBugs 的代替者 SpotBugs
「程序员飞飞」的博客
07-05 5508
我们都知道 FindBugs 是一款优秀的 IDEA 的代码静态分析的工具插件，现在 FindBugs 已经废弃了，转而成为了 SpotBugs。 https://github.com/spotbugs/spotbugs 个人体验了下，使用起来也比较简单和好用。 官方的集成文档也很详细，目前提供了不用构建方式的集成文档，具体集成步骤请戳上面的链接查看，我这里就不赘述了。 集成完后，在 Term...
编写自定义类加载器_编写自定义检测器
cusi77914的博客
07-02 517
在本系列的第一篇文章中，我向您展示了如何设置和执行FindBugs。 现在我们来看看FindBugs最强大的功能-自定义错误检测器。 首先，我将提供理由说明为何自定义错误检测器很有用，然后再为您提供详细的示例。 编写自定义错误检测器 您为什么要编写自定义错误检测器？ 当我被要求检查一个团队的绩效问题时，我遇到了这个问题。 很明显，该团队的本地日志记录框架（如所有日志记录框架）已经随着时...
软件构造-SpotBugs的安装及使用
cs_stu_dy的博客
06-05 1749
SpotBugs的安装及使用安装使用 安装 首先我们需要打开Eclipse自带的Marketplace，与软件市场进行连接，截图如下： 出现之后直接点击Install进行安装，由于我已经进行过安装，这里显示的是Installed。 为了验证我们的安装是成功的，我们可以右键观察是否出现spotbugs选项，截图如下： 使用 spotbugs的使用较为简单，能够进行简单的判断 ...
关于软件构造实验中一些工具的安装和使用以及命令行参数
hitgengzhicheng的博客
06-17 336
整个软件构造实验流程中，不仅仅有java编程还有java一些工具的使用，还有命令行参数的使用。总结一下，各个工具的安装和简单的使用。findbugs：一个静态分析工具，它检查类或者JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。安装：1.在eclipse的官网上或者百度搜索findbugs得到插件的下载链接2.在eclipse中点击help-&gt;software installe...
spotbugs常见问题代码及修改
04-27
以下是一些常见的SpotBugs报告的问题以及如何修改它们的代码示例： 1. "Dead store to local variable"（局部变量无用赋值） ```java int x = 5; x = 6; // SpotBugs会报告此处为Dead store ``` 修改方法： ```java int x = 6; ``` 2. "Condition has no effect"（条件没有效果） ```java int x = 5; if (x < 5) { // SpotBugs会报告此处的条件没有效果 // do something } ``` 修改方法： ```java int x = 5; if (x <= 5) { // do something } ``` 3. "Boxed value is unboxed and then immediately reboxed"（装箱值被拆箱然后立即重新装箱） ```java Integer x = 5; Integer y = new Integer(x.intValue()); // SpotBugs会报告此处的装箱和拆箱操作是多余的 ``` 修改方法： ```java Integer x = 5; Integer y = new Integer(x); // 直接使用装箱操作 ``` 4. "Method ignores exceptional return value"（方法忽略异常返回值） ```java File file = new File("file.txt"); file.delete(); // SpotBugs会报告此处需要处理返回的boolean值 ``` 修改方法： ```java File file = new File("file.txt"); if (!file.delete()) { // 处理返回值 // 处理删除失败情况 } ``` 5. "Inefficient use of keySet iterator instead of entrySet iterator"（使用keySet迭代器不如使用entrySet迭代器） ```java Map<String, String> map = new HashMap<>(); // 假设此处有一些代码往map中添加了一些键值对 for (String key : map.keySet()) { // SpotBugs会报告此处使用keySet迭代器不是最高效的方法 String value = map.get(key); // do something with key and value } ``` 修改方法： ```java Map<String, String> map = new HashMap<>(); // 假设此处有一些代码往map中添加了一些键值对 for (Map.Entry<String, String> entry : map.entrySet()) { // 使用entrySet迭代器 String key = entry.getKey(); String value = entry.getValue(); // do something with key and value } ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值