Spring Boot自定义starter配置提示

在使用Spring Boot官方提供的starter时候发现,每一个配置项都有提示信息,使用起来很方便,但是自定义的starter却没有提示,其实这里可以引入一个依赖来处理提示问题。

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

spring提供了spring-boot-configuration-processor来加载配置信息,引入依赖后重新build一下项目,会发现在META-INF中出现spring-configuration-metadata.json文件,这就是存储的项目配置的元数据信息,再次写自定义配置项就会有提示了。

Spring Boot默认的场景启动器信息都存放在spring-boot-autoconfigure-2.6.0.jar中如下位置。
Spring Boot自定义starter配置提示

加载配置信息的依赖仅在开发阶段有用,在打包部署的时候,可以在打包插件中剔除这个依赖,减小应用包的体积。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-configuration-processor</artifactId>
                    </exclude>
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>
上一篇:Spring源码学习小记(5)


下一篇:vue项目如何关闭Eslint