自定义配置文件的属性信息

作用

在application.yml或者application.properties内配置自定义属性,将显示补全信息和提示:

实现

1)引入依赖
pom.xml文件

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

2)创建metadata文件
在resources目录下,创建META-INF目录,在目录下创建文件spring-configuration-metadata.json或者additional-spring-configuration-metadata.json,添加内容:

{
  "properties": [
    {
      "name": "app.name",
      "type": "java.lang.String",
      "description": "应用的名称."
    }
  ]
}

3) 使用
在yml或者properties文件里配置属性时,就会有提示了。在程序里通过@Value等方式读取属性。

相关链接:
Metadata Format
additional-spring-configuration-metadata.json自定义提示

posted @ 2023-08-08 15:14  OraCat  阅读(7)  评论(0编辑  收藏  举报