配置元数据
Spring Boot 的 jar 包包含元数据文件,这些文件提供了所有支持的配置属性的详细信息。这些文件旨在让 IDE 开发者在用户使用 application.properties
或 application.yaml
文件时,提供上下文帮助和“代码补全”功能。
大部分的元数据文件是在编译时通过处理所有带有 @ConfigurationProperties 注解的项自动生成的。然而,在某些特殊场景或更高级的用例中,可以手动编写部分元数据。
章节摘要
📄️ 元数据格式
配置文件元数据文件位于 META-INF/spring-configuration-metadata.json 路径下的 jar 包中。它们使用 JSON 格式,其中项目分为“groups”或“properties”类别,额外的值提示则归类在“hints”下,如下例所示:
📄️ 提供手动提示
为了提升用户体验并进一步帮助用户配置某个属性,您可以提供以下附加元数据:
📄️ 使用注解处理器生成您自己的元数据
通过使用 spring-boot-configuration-processor jar 包,您可以轻松地从带有 @ConfigurationProperties 注解的项目中生成自己的配置元数据文件。该 jar 包包含一个 Java 注解处理器,它会在项目编译时被调用。