如何在调试/运行 Spring Boot 项目的 IntelliJ“out”目录中生成 build-info.properties？

Question

在我的 build.gradle 中，我添加了 spring 构建信息：

springBoot {
    mainClass = "${springBootMainClass}"

    buildInfo() {
        additionalProperties = [
                name: "${appName}",
                version: "${version}-${buildNumber}",
                time: buildTime()
        ]
    }
}

def buildTime() {
    final dateFormat = new java.text.SimpleDateFormat("yyyy-MM-dd HH:mm:ssZ")
    dateFormat.timeZone = TimeZone.getTimeZone('GMT')
    dateFormat.format(new Date())
}

当我从命令行运行时，这会正确地将 /META-INF/build-info.properties 文件添加到 /build/resources/main 中，以便 "/info" 端点以 JSON 格式显示构建信息。

当我从 IntelliJ 的运行/调试按钮运行时，IntelliJ 确实不使用/build 目录，而是使用/out 目录并且也不运行该 gradle 任务，所以 @987654327 @endpoint 的 JSON 为空。

如何让它生成该文件并将其放在/out 目录中？

Answer 1

启用将IDE构建/运行操作委托给Gradle选项在设置（首选项）|构建、执行、部署 |构建工具 |摇篮 | Runner 标签。

在最新的 IDE 版本中，为设置设置 Gradle（macOS 上的首选项）|构建、执行、部署 |构建工具 | Gradle | 使用选项构建和运行。

Answer 2

对于在 IntelliJ IDEA 社区版中遇到此问题的任何其他人（@Andrey 所说的选项不存在），您只需在启动前添加Run Maven Goal。这将在构建和运行之前执行插件的目标：spring-boot:build-info

Answer 3

我有完全相同的需求，出于不同（好的）原因，我不想使用“将 IDE 构建/运行操作委托给 Gradle”。

在我的情况下，我不需要该文件 /META-INF/build-info.properties 在开发阶段在 IDEA 中是最新的，我只需要该文件在“运行”类路径中可用（在 /out/... 下），否则，当从 IDEA 运行/调试工具启动我的应用程序时，Spring 将无法创建和注入 BuildProperties bean。

如果你也是我的情况，这是一个简单的解决方案：

1. 在主资源目录 (src/main/resources/META-INF/build-info.properties) 中创建 build-info.properties 的虚拟“开发”（或“快照”）版本

   #DO NOT EDIT（将被 Spring Boot 插件覆盖） build.time=2019-05-07T11:32:31.581Z build.artifact=myapp build.group=org.mycompany build.name=myapp build.version=dev

从 IDEA 构建项目时，此开发版本将自动复制到 IDEA /out/production/resources 目录中

1. 在bootBuildInfo 任务和processResources 任务之间创建一个任务依赖关系，以确保Spring boot 插件在构建应用程序jar 时将使用最新版本覆盖“dev”版本：

   bootBuildInfo.mustRunAfter processResources

这样，SpringBoot gradle 插件将覆盖 processResources 任务从源复制的文件，并使用其自动生成的最新文件。

编辑 2020-10

正如 Dmitry 在下面的评论中警告的那样，此解决方案将破坏 Gradle 增量构建，因为 processResources 和 bootBuildInfo 任务共享相同的输出文件 build-info.properties。为避免这种情况，当我们检测到任务图中包含bootBuildInfo 任务时，我们可以在processResources 中添加排除以过滤掉该文件

project.gradle.taskGraph.whenReady {
    if (it.allTasks.any {it.name == "bootBuildInfo"}) {
        processResources {
            exclude("META-INF/build-info.properties")
        }
    }
}