繁体   English   中英

Spring Boot Starter批注元数据

[英]Spring boot starter annotation metadata

在Spring Boot文档的“编写我们自己的spring boot启动程序”一章中写道:

确保触发元数据生成,以便IDE协助也可用于您的密钥。

好的,我可以通过以下方式生成它:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

但为什么 ? 这样的元数据的目的是什么,我在哪里可以找到它们,更重要的是它们与我的IDE有什么关系(我正在使用spring工具套件)? 我只想在应用程序属性中使用自己的属性,例如kulatamicuda.superitem。

有人可以向我解释吗? 我有点困惑。 谢谢。

我的目的与为接口编写javadocs相同。

因此,如果您要创建此启动程序以供其他人使用,那么应该有一些文档。

在创建库时,您可能会理解,您应该至少记录其他开发人员可以在其应用程序中使用的接口。

在这里类似的事情,您的ide(至少是IDEA)将尝试在人工制品中找到META-INF/spring-configuration-metadata.json文件,并将为此属性提供自动完成和描述(您将在此文件中指定)。

这是一个示例: https : //docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html

但是,如果您不想描述这些属性,则可以按原样保留它,而无需创建带有元信息的任何文件,这不会影响您的应用程序。

这是在IDEA中的工作方式:

在此处输入图片说明

您可以看到在为此项目添加的springboot启动程序中定义的每个属性都有自动补全和说明。 它还了解属性的类型及其默认值。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM