Configuration Metadata

QWen Max 中英对照 Configuration Metadata

Spring Boot 的 JAR 包包含元数据文件，这些文件提供了所有受支持的配置属性的详细信息。这些文件旨在让 IDE 开发者能够在用户编辑 application.properties 或 application.yaml 文件时，提供上下文帮助和“代码补全”功能。

大部分元数据文件在编译时通过处理所有带有 @ConfigurationProperties 注解的项自动生成。对于一些特殊情况或更高级的用例，可以为外部类型提供元数据源，或者手动编写部分元数据。

章节总结

📄️ 元数据格式

配置元数据文件位于 jar 包内的 META-INF/spring-configuration-metadata.json 中。它们使用 JSON 格式，其中的条目被归类为 “groups” 或 “properties”，附加的值提示归类在 “hints” 下，而被忽略的条目则放在 “ignored” 下，如下例所示：

📄️ 提供手动提示

为了提升用户体验并进一步帮助用户配置给定属性，您可以提供额外的元数据，这些元数据可以：

📄️ 使用注解处理器生成你自己的元数据

你可以通过使用 spring-boot-configuration-processor jar 轻松地从带有 @ConfigurationProperties 注解的项生成你自己的配置元数据文件。该 jar 包含一个 Java 注解处理器，会在你的项目编译时被调用。