关于SegmentFault:Spring-Boot-2x基础教程配置元数据的应用

5次阅读

共计 1170 个字符,预计需要花费 3 分钟才能阅读完成。

在应用 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 学习之路!另每周赠书不停哦~

正文完
 0