Gradle集成Spotbugs如何同时打开main与test报告的GUI界面

问题根因 #

你的代码无法正常运行的核心问题是将dependsOn依赖声明放在了doLast块中：Gradle的任务依赖关系需要在配置阶段完成解析，而doLast是任务执行阶段才会运行的逻辑，此时声明的依赖不会被Gradle识别，对应的子任务自然不会被触发执行。
除此之外你的实现还有几个可优化点：

• 硬编码Spotbugs版本号，后续升级插件时需要同步修改代码，容易出现版本不兼容问题
• 手动编写解压Spotbugs压缩包的逻辑，其实可以直接复用Spotbugs依赖配置，不需要额外处理
• 多层finalizedBy嵌套导致任务逻辑不清晰，可读性差

修复后可直接运行的实现 #

方案1：分别打开两个GUI展示两份报告

// 确保已正确引入基础插件，版本可替换为你正在使用的版本
plugins {
    id 'java'
    id 'com.github.spotbugs' version '5.0.14'
}

repositories {
    mavenCentral()
}

// 统一管理Spotbugs版本，避免硬编码
dependencies {
    spotbugs 'com.github.spotbugs:spotbugs:4.4.0'
}

// 配置Spotbugs默认输出XML报告，确保GUI可以加载到文件
spotbugs {
    reportsDir = file("${buildDir}/reports/spotbugs")
}
tasks.withType(com.github.spotbugs.snom.SpotBugsTask) {
    reports {
        xml.required = true
    }
}

// 注册对应main、test目录的GUI启动任务
def reportSets = ['main', 'test']
reportSets.each { set ->
    tasks.register("spotbugsView${set.capitalize()}", Exec) {
        // 自动依赖对应扫描任务，确保每次打开GUI前报告都是最新的
        dependsOn "spotbugs${set.capitalize()}"
        // 直接从依赖中获取Spotbugs jar包，不需要手动解压
        def spotbugsJar = project.configurations.spotbugs.find { it.name.startsWith('spotbugs-') }
        commandLine 'java', '-jar', spotbugsJar.absolutePath
        args '-loadBugs', "${spotbugs.reportsDir}/${set}.xml"
    }
}

// 统一入口任务，执行即可触发全流程
task spotbugsViewAll {
    dependsOn reportSets.collect { "spotbugsView${it.capitalize()}" }
    group = 'verification'
    description = '同时打开main、test目录的Spotbugs扫描报告GUI'
}

使用时直接执行./gradlew spotbugsViewAll即可。

方案2：合并报告后单GUI统一展示（和Maven使用体验一致）

如果不想同时打开两个GUI，可以新增报告合并逻辑，把两份扫描结果合并为单份报告加载：

import groovy.xml.XmlSlurper
import groovy.xml.XmlNodePrinter

// 新增报告合并任务
task spotbugsMergeReports {
    dependsOn 'spotbugsMain', 'spotbugsTest'
    def mergedReport = file("${spotbugs.reportsDir}/merged.xml")
    outputs.file mergedReport

    doLast {
        def slurper = new XmlSlurper(false, false)
        def mainReport = slurper.parse(file("${spotbugs.reportsDir}/main.xml"))
        def testReport = slurper.parse(file("${spotbugs.reportsDir}/test.xml"))
        
        // 合并test目录的扫描结果到main报告中
        testReport.BugInstance.each { bug ->
            mainReport.appendNode(bug)
        }
        
        // 输出合并后的报告
        mergedReport.parentFile.mkdirs()
        def printer = new XmlNodePrinter(new PrintWriter(mergedReport))
        printer.preserveWhitespace = true
        printer.print(mainReport)
    }
}

// 注册合并报告的GUI启动任务
tasks.register("spotbugsViewMerged", Exec) {
    dependsOn spotbugsMergeReports
    def spotbugsJar = project.configurations.spotbugs.find { it.name.startsWith('spotbugs-') }
    commandLine 'java', '-jar', spotbugsJar.absolutePath
    args '-loadBugs', spotbugsMergeReports.outputs.files.singleFile.absolutePath
    group = 'verification'
    description = '打开合并了main、test扫描结果的Spotbugs GUI'
}

使用时直接执行./gradlew spotbugsViewMerged即可在同一个GUI中查看所有扫描结果。

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