Gradle构建中SpotBugs任务报退出码1错误，求排查与解决建议

环境与配置信息 #

SpotBugs Gradle配置 #

plugins{
  id "com.github.spotbugs" version "6.0.3"
}
// Spotbugs Plugin Configuration
spotbugs {
    toolVersion = "4.8.3"
    ignoreFailures = true
    excludeFilter = file("${projectDir}/static-code-analysis/spotbugs/exclude.xml")
    spotbugsTest.enabled = false
}

spotbugsMain {
    reports.create("html") {
            required = true
            outputLocation = file("$buildDir/reports/spotbugs/main/spotbugs.html")
            stylesheet = 'fancy-hist.xsl'
    }
}

工具版本 #

Spring 3.1.8
Java 17 (eclipse temurin) 
Gradle 7.6.1

错误日志 #

2024-01-25T17:25:59.282-0600 [LIFECYCLE] [class org.gradle.internal.buildevents.TaskExecutionLogger] > Task :spotbugsMain
2024-01-25T17:26:21.179-0600 [DEBUG] [org.gradle.process.internal.DefaultExecHandle] Changing state to: FAILED
2024-01-25T17:26:21.179-0600 [DEBUG] [org.gradle.process.internal.DefaultExecHandle] Process 'command 'C:\Program Files\Eclipse Adoptium\jdk-17.0.7.7-hotspot\bin\java.exe'' finished with exit value 1 (state: FAILED)
2024-01-25T17:26:21.179-0600 [WARN] [com.github.spotbugs.snom.internal.SpotBugsRunnerForHybrid$SpotBugsExecutor$Inject] SpotBugs ended with exit code 1

问题原因分析 #

• 检测到代码缺陷：Exit Code 1是SpotBugs的标准返回码，代表扫描时发现了符合规则的bug，不是扫描过程报错。你配置了ignoreFailures = true，Gradle会忽略任务失败状态继续构建，所以最终构建能完成，但SpotBugs任务本身确实检测到了问题。
• 排除规则可能失效：如果预期没有bug，大概率是exclude.xml的规则配置有误——比如bug类型拼写错、类路径匹配不对，导致该排除的缺陷没被过滤掉。
• 版本适配小问题：虽然当前版本组合理论上兼容，但部分旧规则在Java17下可能出现误报，或者插件与工具版本的适配存在细节问题。

解决建议 #

1. 查看SpotBugs报告：打开配置里指定的$buildDir/reports/spotbugs/main/spotbugs.html，里面会列出所有检测到的bug，明确具体是哪些代码问题导致的返回码1。
2. 校验exclude.xml规则：对照报告里的bug信息，检查排除文件的规则是否准确匹配。比如bug的type、类的全路径是否正确，避免拼写或路径错误。示例排除规则格式：

   <?xml version="1.0" encoding="UTF-8"?>
   <FindBugsFilter>
       <Match>
           <Class name="com.example.MyClass"/>
           <Bug pattern="DMI_RANDOM_USED_ONLY_ONCE"/>
       </Match>
   </FindBugsFilter>
   

3. 调整ignoreFailures配置（可选）：如果希望构建在SpotBugs发现bug时直接失败，把ignoreFailures改成false；如果只是不想看到警告日志，可以保持当前配置，但建议定期清理代码里的bug。
4. 升级版本排查兼容性：尝试把SpotBugs插件和工具版本升级到最新兼容版，比如插件升到7.x系列，工具版本对应升到4.8.6+，看看能不能解决潜在的适配问题。
5. 检查Java17相关误报：SpotBugs对Java17的新特性（比如密封类、虚拟线程）可能存在规则适配不足，可在报告里确认是否是这类新特性的误报，然后添加对应的排除规则或等待官方更新规则。

内容的提问来源于stack exchange，提问作者Jammer