如何为自定义属性文件使用Jakarta MicroProfile ConfigMapping？

因为你使用的是Quarkus（底层基于SmallRye Config），可以利用SmallRye Config的扩展API实现动态加载自定义属性文件并映射到@ConfigMapping接口，无需依赖注入或服务加载器的单一配置限制。

实现步骤与代码示例 #

完整实现代码 #

import io.smallrye.config.MapBasedConfigSource;
import io.smallrye.config.SmallRyeConfig;
import io.smallrye.config.SmallRyeConfigBuilder;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Properties;
import java.util.stream.Collectors;

public class TenantConfigLoader {

    public BananaConfig loadTenantConfig(String tenantConfigPath) throws IOException {
        try (var is = Files.newInputStream(Path.of(tenantConfigPath))) {
            // 加载属性文件到Properties对象
            Properties props = new Properties();
            props.load(is);

            // 转换为String键值对的Map，适配SmallRye配置源要求
            var propMap = props.entrySet().stream()
                    .collect(Collectors.toMap(
                            entry -> entry.getKey().toString(),
                            entry -> entry.getValue().toString()
                    ));

            // 创建自定义配置源，设置优先级（数值越高优先级越高，默认application.properties为400）
            var customSource = new MapBasedConfigSource("tenant-config", propMap, 500);

            // 构建独立的SmallRye Config实例
            SmallRyeConfig config = new SmallRyeConfigBuilder()
                    // 可选：保留默认配置源（如application.properties），不需要则移除该行
                    .addDefaultSources()
                    .withSources(customSource)
                    .build();

            // 将配置映射到BananaConfig类型安全接口
            return config.createConfigMapping(BananaConfig.class);
        }
    }
}

关键说明 #

• 配置优先级：MapBasedConfigSource的第三个参数是优先级，设置为500会覆盖默认的application.properties（优先级400）；如果仅需使用租户文件的配置，可移除.addDefaultSources()。
• 类型安全兼容：该方式完全复用Jakarta MicroProfile Config的转换器、验证机制，和注入的@ConfigMapping行为完全一致。
• 动态性支持：每次调用loadTenantConfig都可以加载不同的租户文件，满足动态租户的配置需求，无需启动时提前配置。

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