使用 Gradle Ext 属性注入 Quarkus 配置_技术教程

本文介绍如何通过 Gradle Ext 属性将构建时间和项目版本等信息注入到 Quarkus 项目中，解决配置注入失败的问题，并提供有效的解决方案和代码示例，帮助开发者更好地管理和配置 Quarkus 应用。

在 Quarkus 项目中，我们经常需要将构建时的信息，例如项目版本和构建时间，注入到应用程序中。这可以通过 Gradle 的 Ext 属性来实现。然而，在实践中，可能会遇到配置注入失败的问题。本文将介绍如何正确地将 Gradle Ext 属性注入到 Quarkus 配置中，并提供一个有效的解决方案。

问题描述

假设我们想要将项目版本和构建时间注入到 Quarkus 项目中。在 build.gradle 文件中，我们定义了以下 Ext 属性：

version '0.0.0-SNAPSHOT'

ext {
   buildTime = new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ").format(new Date())
}

然后在 Java 源代码中，我们尝试使用 @ConfigProperty 注解注入这些属性：

import org.eclipse.microprofile.config.inject.ConfigProperty;

import javax.inject.Inject;

public class MyService {

   @Inject
   @ConfigProperty(name = "version")
   String version;

   @Inject
   @ConfigProperty(name="buildTime")
   String buildTime;

   public String getVersion() {
       return version;
   }

   public String getBuildTime() {
       return buildTime;
   }
}

虽然 version 属性可以成功注入，但 buildTime 属性却失败，并抛出 ConfigurationException 异常。

解决方案

问题的关键在于，Quarkus 在启动时可能无法立即获取到 Gradle Ext 属性的值。为了解决这个问题，我们可以为 @ConfigProperty 注

解提供一个默认值。

修改后的 Java 源代码如下：

import org.eclipse.microprofile.config.inject.ConfigProperty;

import javax.inject.Inject;

public class MyService {

   @Inject
   @ConfigProperty(name = "version")
   String version;

   @Inject
   @ConfigProperty(name = "buildTime", defaultValue="defaultValue")
   String buildTime;

   public String getVersion() {
       return version;
   }

   public String getBuildTime() {
       return buildTime;
   }
}

通过为 buildTime 属性设置一个默认值，即使 Quarkus 在启动时无法立即获取到 Gradle Ext 属性的值，也能正常启动应用程序。

进一步优化

虽然上述解决方案可以解决配置注入失败的问题，但我们仍然需要确保最终注入的是 Gradle Ext 属性的值，而不是默认值。为了实现这一点，我们需要在构建过程中将 Gradle Ext 属性的值传递给 Quarkus。

在 build.gradle 中生成配置文件：

我们可以使用 Gradle Task 在构建过程中生成一个 application.properties 文件，并将 Gradle Ext 属性的值写入该文件。
```
task generateConfig {
    doLast {
        file("src/main/resources/application.properties").write("buildTime=${ext.buildTime}\nversion=${version}")
    }
}

quarkusBuild.dependsOn generateConfig
```
这个 Task 会在 src/main/resources 目录下生成一个 application.properties 文件，其中包含 buildTime 和 version 属性的值。
确保 Task 在构建之前执行：

通过 quarkusBuild.dependsOn generateConfig，我们确保 generateConfig Task 在 quarkusBuild Task 之前执行，从而保证配置文件在构建之前生成。

移除 defaultValue：

现在，我们可以从 Java 源代码中移除 defaultValue 属性，因为配置文件已经提供了 buildTime 属性的值。

import org.eclipse.microprofile.config.inject.ConfigProperty;

import javax.inject.Inject;

public class MyService {

   @Inject
   @ConfigProperty(name = "version")
   String version;

   @Inject
   @ConfigProperty(name="buildTime")
   String buildTime;

   public String getVersion() {
       return version;
   }

   public String getBuildTime() {
       return buildTime;
   }
}

总结

通过以上步骤，我们可以成功地将 Gradle Ext 属性注入到 Quarkus 配置中。首先，我们通过为 @ConfigProperty 注解提供默认值来解决配置注入失败的问题。然后，我们通过在构建过程中生成配置文件，并将 Gradle Ext 属性的值写入该文件，确保最终注入的是 Gradle Ext 属性的值。

注意事项：