Quarkus中@ConfigMapping如何便捷实现toString()展示所有配置属性？

问题概述 #

使用@ConfigMapping定义配置接口时，因接口特性无法直接编写toString()方法，手动通过反射遍历多层级配置成本较高。根据SmallRye配置文档说明：

ToString#
If the config mapping contains a toString method declaration, the config mapping instance will include a proper implementation of the toString method.

但在接口中添加@Override String toString();后，Quarkus报错提示找不到属性to_string。

问题原因 #

添加@Override注解会被Quarkus的配置处理器误识别为需要绑定名为to_string的配置属性，而非触发框架自动生成toString实现的逻辑。相关修复逻辑已完成，但需注意正确的使用姿势。

正确解决方案 #

无需添加@Override注解，直接在@ConfigMapping接口中声明toString()方法即可：

@ConfigMapping(prefix = "app.config")
public interface AppConfig {
    String toString();

    // 配置属性方法
    String appName();
    DatabaseConfig database();

    interface DatabaseConfig {
        String url();
        String username();
    }
}

这样框架会自动生成包含所有层级配置属性的toString实现，无需手动处理反射逻辑。

额外说明 #

如果需要自定义toString格式，可编写工具类通过反射遍历配置接口的方法及返回值，构建符合需求的输出内容。当前SmallRye Config已支持自动生成toString的特性，Quarkus后续版本也同步了该功能修复。

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