Spring Boot 2.x基础教程：配置元数据的应用

在使用Spring Boot开发应用的时候，你是否有发现这样的状况：自定义属性是有高量背景的，鼠标放上去，有一个Cannot resolve configuration property的配置警告。

若是不对于这个警告以为烦，想要去掉，那么能够经过设置来去除：

可是，个人建议是不要去掉，由于这个警告正好能够经过高亮来区分你的自定义配置以及框架配置，可让你快速的分辨哪些是自定义的。

若是你实在想去掉，那么也不建议用上面说的方法，而是建议经过完善配置元数据的方式来完成。因此，今天就来具体说说配置元数据的应用！

啥是配置元数据？

咱们不妨打开一个已经建立好的Spring Boot项目，查看一下它的Spring Boot依赖包，能够找到以下图的一个json文件：

这里报错的就是配置的元数据信息。有没有发现这些name的值都很熟悉？其中description是否是也很熟悉？对，这些就是咱们经常使用的Spring Boot原生配置的元数据信息。

这下知道配置元数据能够用来作啥了吧？它能够帮助IDE来完成配置联想和配置提示的展现。

而咱们自定义配置之因此会报警告，同时也没有提示信息，就是由于没有这个元数据的配置文件！

配置元数据的自动生成

既然知道了原理，那么接下来咱们尝试用一下配置元数据试试！

第一步：建立一个配置类，定义一个自定义配置

@Data
@Configuration
@ConfigurationProperties(prefix = "com.didispace")
public class DidiProperties {
    
    /**
     * 这是一个测试配置
     */
    private String from;

}

第二步：在pom.xml中添加自动生成配置元数据的依赖

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

第三步：mvn install下这个项目。

此时咱们能够在工程target目录下找到元数据文件：

同时，咱们在配置文件中尝试编写这个自定义的配置项时，能够看到编译器给出了联想和提示：

而且，编写完配置以后，也没有高亮警告了！

代码示例

本文的相关例子能够查看下面仓库中的chapter1-4目录：

• Github：https://github.com/dyc87112/SpringBoot-Learning/
• Gitee：https://gitee.com/didispace/SpringBoot-Learning/

若是您以为本文不错，欢迎Star支持，您的关注是我坚持的动力！

欢迎关注个人公众号：程序猿DD，得到独家整理的免费学习资源助力你的Java学习之路！另每周赠书不停哦～