对于最新的稳定版本，请使用 Spring Boot 3.4.0！spring-doc.cn

元数据格式

配置元数据文件位于 jar 内的 下。 它们使用 JSON 格式，其中项分类在“groups”或“properties”下，其他值提示分类在“hints”下，如以下示例所示：META-INF/spring-configuration-metadata.jsonspring-doc.cn

{"groups": [
	{
		"name": "server",
		"type": "org.springframework.boot.autoconfigure.web.ServerProperties",
		"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
	},
	{
		"name": "spring.jpa.hibernate",
		"type": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate",
		"sourceType": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties",
		"sourceMethod": "getHibernate()"
	}
	...
],"properties": [
	{
		"name": "server.port",
		"type": "java.lang.Integer",
		"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
	},
	{
		"name": "server.address",
		"type": "java.net.InetAddress",
		"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
	},
	{
		  "name": "spring.jpa.hibernate.ddl-auto",
		  "type": "java.lang.String",
		  "description": "DDL mode. This is actually a shortcut for the \"hibernate.hbm2ddl.auto\" property.",
		  "sourceType": "org.springframework.boot.autoconfigure.orm.jpa.JpaProperties$Hibernate"
	}
	...
],"hints": [
	{
		"name": "spring.jpa.hibernate.ddl-auto",
		"values": [
			{
				"value": "none",
				"description": "Disable DDL handling."
			},
			{
				"value": "validate",
				"description": "Validate the schema, make no changes to the database."
			},
			{
				"value": "update",
				"description": "Update the schema if necessary."
			},
			{
				"value": "create",
				"description": "Create the schema and destroy previous data."
			},
			{
				"value": "create-drop",
				"description": "Create and then destroy the schema at the end of the session."
			}
		]
	}
]}

每个 “property” 都是用户使用给定值指定的配置项。 例如，可以在 / 中指定，如下所示：server.portserver.addressapplication.propertiesapplication.yamlspring-doc.cn

server.port=9090
server.address=127.0.0.1
server:
  port: 9090
  address: 127.0.0.1

“组”是更高级别的项目，它们本身不指定值，而是为属性提供上下文分组。 例如，和 属性是组的一部分。server.portserver.addressserverspring-doc.cn

不要求每个 “property” 都有一个 “group”。 某些属性可能本身就存在。

最后，“提示”是用于帮助用户配置给定属性的附加信息。 例如，当开发人员配置属性时，工具可以使用提示为 、 、 、 和 值提供一些自动完成帮助。spring.jpa.hibernate.ddl-autononevalidateupdatecreatecreate-dropspring-doc.cn

组属性

数组中包含的 JSON 对象可以包含下表中所示的属性：groupsspring-doc.cn

名字 类型 目的

namespring-doc.cn

字符串spring-doc.cn

组的全名。 此属性是必需的。spring-doc.cn

typespring-doc.cn

字符串spring-doc.cn

组数据类型的类名。 例如，如果该组基于一个用 @ConfigurationProperties 注释的类，则该属性将包含该类的完全限定名称。 如果它基于 @Bean 方法，则它将是该方法的返回类型。 如果类型未知，则可以省略该属性。spring-doc.cn

descriptionspring-doc.cn

字符串spring-doc.cn

可向用户显示的组的简短描述。 如果没有可用的描述，则可以省略它。 建议描述为简短的段落，第一行提供简明的摘要。 描述中的最后一行应以句点 （） 结尾。.spring-doc.cn

sourceTypespring-doc.cn

字符串spring-doc.cn

提供此组的源的类名。 例如，如果该组基于@Bean 方法，并且@ConfigurationProperties注释，则此属性将包含包含该方法的 @Configuration 类的完全限定名称。 如果源类型未知，则可以省略该属性。spring-doc.cn

sourceMethodspring-doc.cn

字符串spring-doc.cn

提供此组的方法的全名（包括括号和参数类型）（例如，@ConfigurationProperties带注释的 @Bean 方法的名称）。 如果源方法未知，则可以省略它。spring-doc.cn

属性属性

数组中包含的 JSON 对象可以包含下表中描述的属性：propertiesspring-doc.cn

名字 类型 目的

namespring-doc.cn

字符串spring-doc.cn

属性的全名。 名称采用小写句点分隔形式（例如 ）。 此属性是必需的。server.addressspring-doc.cn

typespring-doc.cn

字符串spring-doc.cn

属性数据类型的完整签名（例如 String），但也是一个完整的泛型类型（例如 ）。 您可以使用此属性来指导用户了解他们可以输入的值类型。 为了保持一致性，使用其包装器对应项 （例如，变为 Boolean） 来指定基元的类型。 请注意，此类可能是一个复杂类型，在绑定值时从 String 转换而来。 如果类型未知，则可以省略。java.util.Map<java.lang.String,com.example.MyEnum>booleanspring-doc.cn

descriptionspring-doc.cn

字符串spring-doc.cn

可向用户显示的属性的简短说明。 如果没有可用的描述，则可以省略它。 建议描述为简短的段落，第一行提供简明的摘要。 描述中的最后一行应以句点 （） 结尾。.spring-doc.cn

sourceTypespring-doc.cn

字符串spring-doc.cn

提供此属性的源的类名。 例如，如果属性来自用 @ConfigurationProperties 注释的类，则此属性将包含该类的完全限定名称。 如果源类型未知，则可以省略它。spring-doc.cn

defaultValuespring-doc.cn

对象spring-doc.cn

默认值，如果未指定属性，则使用该值。 如果属性的类型是数组，它可以是值的数组。 如果默认值未知，则可以省略它。spring-doc.cn

deprecationspring-doc.cn

折旧spring-doc.cn

指定是否弃用该属性。 如果该字段未弃用或该信息未知，则可以省略该字段。 下表提供了有关该属性的更多详细信息。deprecationspring-doc.cn

每个元素的属性中包含的 JSON 对象可以包含以下属性：deprecationpropertiesspring-doc.cn

名字 类型 目的

levelspring-doc.cn

字符串spring-doc.cn

弃用级别，可以是 （默认） 或 。 当属性具有弃用级别时，它仍应在环境中绑定。 但是，当它具有弃用级别时，该属性将不再被管理，也不会被绑定。warningerrorwarningerrorspring-doc.cn

reasonspring-doc.cn

字符串spring-doc.cn

弃用属性的原因的简短描述。 如果没有可用的原因，则可以省略。 建议描述为简短的段落，第一行提供简明的摘要。 描述中的最后一行应以句点 （） 结尾。.spring-doc.cn

replacementspring-doc.cn

字符串spring-doc.cn

替换此已弃用属性的属性的全名。 如果此属性没有替代项，则可以省略它。spring-doc.cn

sincespring-doc.cn

字符串spring-doc.cn

属性已弃用的版本。 可以省略。spring-doc.cn
在 Spring Boot 1.3 之前，可以使用单个 boolean 属性来代替元素。 这仍然以已弃用的方式受支持，不应再使用。 如果没有可用的 reason 和 replacement，则应设置一个空对象。deprecateddeprecationdeprecation

还可以通过将 @DeprecatedConfigurationProperty 注解添加到公开已弃用属性的 getter 中，在代码中以声明方式指定弃用。 例如，假设该属性令人困惑，并已重命名为 . 以下示例显示如何处理这种情况：my.app.targetmy.app.namespring-doc.cn

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;

@ConfigurationProperties("my.app")
public class MyProperties {

	private String name;

	public String getName() {
		return this.name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Deprecated
	@DeprecatedConfigurationProperty(replacement = "my.app.name")
	public String getTarget() {
		return this.name;
	}

	@Deprecated
	public void setTarget(String target) {
		this.name = target;
	}

}
无法设置 . 始终假定，因为代码仍在处理该属性。levelwarning

前面的代码确保已弃用的属性仍然有效（委托给幕后的属性）。 一旦可以从公共 API 中删除 and 方法，元数据中的自动弃用提示也会消失。 如果要保留提示，请添加具有弃用级别的手动元数据，以确保用户仍能了解该属性。 当提供 a 时，这样做特别有用。namegetTargetsetTargeterrorreplacementspring-doc.cn

Hint 属性

数组中包含的 JSON 对象可以包含下表中所示的属性：hintsspring-doc.cn

名字 类型 目的

namespring-doc.cn

字符串spring-doc.cn

此提示所引用的属性的全名。 名称采用小写句点分隔形式（如 ）。 如果属性引用 map （例如 ），则提示适用于 map （） 的键或 map 的值 （） 。 此属性是必需的。spring.mvc.servlet.pathsystem.contextssystem.contexts.keyssystem.contexts.valuesspring-doc.cn

valuesspring-doc.cn

ValueHint[]spring-doc.cn

对象定义的有效值列表（如下表所述）。 每个条目都定义值，并且可能具有说明。ValueHintspring-doc.cn

providersspring-doc.cn

ValueProvider[]spring-doc.cn

由对象定义的提供程序列表（本文档稍后将介绍）。 每个条目都定义提供程序的名称及其参数（如果有）。ValueProviderspring-doc.cn

每个元素的属性中包含的 JSON 对象可以包含下表中描述的属性：valueshintspring-doc.cn

名字 类型 目的

valuespring-doc.cn

对象spring-doc.cn

提示引用的元素的有效值。 如果属性的类型是数组，则它也可以是值的数组。 此属性是必需的。spring-doc.cn

descriptionspring-doc.cn

字符串spring-doc.cn

可向用户显示的值的简短描述。 如果没有可用的描述，则可以省略它。 建议描述为简短的段落，第一行提供简明的摘要。 描述中的最后一行应以句点 （） 结尾。.spring-doc.cn

每个元素的属性中包含的 JSON 对象可以包含下表中描述的属性：providershintspring-doc.cn

名字 类型 目的

namespring-doc.cn

字符串spring-doc.cn

用于为提示引用的元素提供其他内容帮助的提供程序的名称。spring-doc.cn

parametersspring-doc.cn

JSON 对象spring-doc.cn

提供程序支持的任何其他参数（有关更多详细信息，请查看提供程序的文档）。spring-doc.cn

重复的元数据项

具有相同“属性”和“组”名称的对象可以在元数据文件中多次出现。 例如，可以将两个单独的类绑定到同一前缀，每个类都具有可能重叠的属性名称。 虽然元数据中多次出现的相同名称应该不常见，但元数据的使用者应注意确保他们支持它。spring-doc.cn