Quarkus Config Mapping：优雅配置 Map 变量

使用 Quarkus Config Mapping 优雅配置 Map 变量

问题陈述

在 Quarkus 中使用 MicroProfile 配置 API 时，如果你想读写 java.util.Map 类型的配置值，可能会遇到 "No config value of type [java.util.Map] exists for:" 错误。这是因为 MicroProfile 不支持直接读取 Map 类型的配置值。

变通方法

过去，解决此问题的传统变通方法是使用 Quarkus 扩展。然而，这是一种繁琐且过时的做法。现在，有一个更优雅的解决方案，即利用 Quarkus 的 "config mapping" 功能。

Config Mapping

"config mapping" 允许你将配置值映射到自定义配置类中。通过这种方法，你可以轻松访问和操作 Map 类型的配置值。

实现步骤

1. 创建配置类

创建配置类，将 Map 类型属性映射到对应的配置键。

@ConfigMapping(prefix = "app")
public interface AppConfiguration {

    @ConfigProperty(name = "myMap")
    Map<String, String> getMyMap();
}

2. 注入配置类

在需要使用配置值的类中，注入配置类。

@Inject
AppConfiguration appConfiguration;

3. 访问 Map 值

现在，你可以使用注入的配置类轻松访问和操作 Map 值。

Map<String, String> myMap = appConfiguration.getMyMap();
String value1 = myMap.get("key1");

示例

下面是一个完整的示例，演示如何使用 "config mapping" 读取 Map 配置值：

// application.yaml
app:
  myMap:
    key1: value1
    key2: value2
    key3: value3

// AppConfiguration.java
@ConfigMapping(prefix = "app")
public interface AppConfiguration {

    @ConfigProperty(name = "myMap")
    Map<String, String> getMyMap();
}

// Main.java
public class Main {

    @Inject
    AppConfiguration appConfiguration;

    public static void main(String[] args) {
        Map<String, String> myMap = appConfiguration.getMyMap();
        String value1 = myMap.get("key1");
        System.out.println(value1);  // Prints: value1
    }
}

结论

通过使用 Quarkus 的 "config mapping" 功能，你可以优雅地读取和操作 Map 类型配置值，从而避免使用过时的变通方法。这使你的代码更易于维护和可读。

常见问题解答

1. 为什么 MicroProfile 不支持直接读取 Map 类型的配置值？

   MicroProfile 规范没有定义如何处理 Map 类型的配置值，因此框架不提供此功能。

2. "config mapping" 除了用于 Map 类型的配置值外，还有哪些其他用途？

   "config mapping" 还可以用于配置具有复杂结构的其他自定义配置对象。

3. 除了 "config mapping" 之外，还有哪些其他方法可以配置 Map 变量？

   其他方法包括使用 Quarkus 扩展或编写自定义配置转换器。然而，"config mapping" 被认为是更简单和更优雅的方法。

4. "config mapping" 是否适用于所有 Quarkus 版本？

   "config mapping" 功能从 Quarkus 1.8.0 版开始可用。

5. 我应该在何时使用 "config mapping"？

   建议在需要配置具有复杂结构的自定义配置对象或 Map 类型的配置值时使用 "config mapping"。