SpringBoot configuration metadata

SpringBoot官方发布jar包的META-INF中会包含 spring-configuration-metadata.json 文件. 该文件是所在jar包所支持所有参数的详细集合. 主要提供给IDE的开发者, 当用户在编辑application.properties时可以提供上下文和自动补全的支持.

该文件是在jar包生成时通过扫描@ConfigurationProperties注解的类自动生成的, 也可以通过添加META-INF/additional-spring-configuration-metadata.json文件定义额外的参数

格式

1
2
3
4
5
{
"properties": [],
"groups": [],
"hints": []
}

properties (最主要 ) 中定义了具体的属性列表
groups 是更高级别的额外描述, 例如logging.level, logging.x.x均是logging
hints 额外的提供了一些可选的值, 例如logging.level.values, 可选值: trace,debug,info,warn,error,fatal,off

Property 的参数

name 参数的全名
type 参数java类型
description 描述
sourceType 所来的的Configuration类, 该类被@ConfigurationProperties标注
defaultValue 默认值
deprecation 是否是弃用参数

0%