Spring应用自定义配置项如何在properties编辑时自动提示？

原创

已于 2022-05-29 09:25:37 修改 · 1.1k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#spring #spring boot

于 2021-12-19 16:21:11 首次发布

本文介绍了如何在Spring Boot应用中实现自定义配置项的自动提示。通过添加依赖，编写配置类，并在IDEA中进行相应设置，可以使得在.properties或非.properties文件中输入配置时获得提示。此外，文章提供了相关参考资料以便进一步了解。

Spring Boot应用中配置项过多时，无疑会增加维护成本，对于自定义的配置项，若是缺少必要的文档说明，则更是令人不快，如果可以提示呢，不就轻松多了吗？

添加依赖和编写配置类

为模块添加spring-boot-configuration-processor依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <!-- 通常无需指定版本，会根据所使用SpringBoot版本自动匹配，亦可根据情况调整 -->
    <!-- <version>1.5.16.RELEASE</version> -->
</dependency>