此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Boot 3.4.0！spring-doc.cn

提供手动提示

为了改善用户体验并进一步帮助用户配置给定属性，您可以提供其他元数据，以便：spring-doc.cn

  • 描述属性的可能值列表。spring-doc.cn

  • 关联提供程序，以将定义完善的语义附加到属性，以便工具可以根据项目的上下文发现潜在值的列表。spring-doc.cn

值提示

每个 hint 的 attribute 都引用 property 的 。 在前面显示的初始示例中，我们为属性提供了五个值： 、 、 、 和 。 每个值也可能具有说明。namenamespring.jpa.hibernate.ddl-autononevalidateupdatecreatecreate-dropspring-doc.cn

如果您的属性是 Map 类型，则可以为键和值提供提示（但不能为 map 本身提供提示）。 special 和 suffixes 必须分别引用 keys 和 values。.keys.valuesspring-doc.cn

假设将 magic String 值映射到整数，如以下示例所示：my.contextsspring-doc.cn

import java.util.Map;

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

@ConfigurationProperties("my")
public class MyProperties {

	private Map<String, Integer> contexts;

	// getters/setters ...

	public Map<String, Integer> getContexts() {
		return this.contexts;
	}

	public void setContexts(Map<String, Integer> contexts) {
		this.contexts = contexts;
	}

}

魔术值是（在此示例中）是 和 。 为了为键提供额外的内容帮助，您可以将以下 JSON 添加到模块的手动元数据中：sample1sample2spring-doc.cn

{"hints": [
	{
		"name": "my.contexts.keys",
		"values": [
			{
				"value": "sample1"
			},
			{
				"value": "sample2"
			}
		]
	}
]}
我们建议您对这两个值改用 Enum。 如果您的 IDE 支持它，这是迄今为止最有效的自动完成方法。

价值提供商

提供程序是将语义附加到属性的有效方法。 在本节中，我们定义了可用于您自己的提示的官方提供程序。 但是，您最喜欢的 IDE 可能会实现其中的一些，或者没有实现。 此外，它最终可能会提供自己的服务。spring-doc.cn

由于这是一项新功能，IDE 供应商必须跟上它的工作原理。 采用时间自然会有所不同。

下表总结了支持的提供程序列表：spring-doc.cn

名字 描述

anyspring-doc.cn

允许提供任何其他值。spring-doc.cn

class-referencespring-doc.cn

自动完成项目中可用的类。 通常由参数指定的基类约束。targetspring-doc.cn

handle-asspring-doc.cn

处理属性，就好像它是由 mandatory 参数定义的类型定义的一样。targetspring-doc.cn

logger-namespring-doc.cn

自动完成有效的 Logger 名称和 Logger 组。 通常，当前项目中可用的包名和类名可以自动完成，也可以定义组。spring-doc.cn

spring-bean-referencespring-doc.cn

自动完成当前项目中的可用 Bean 名称。 通常由参数指定的基类约束。targetspring-doc.cn

spring-profile-namespring-doc.cn

自动完成项目中可用的 Spring 配置文件名称。spring-doc.cn
对于给定属性，只能有一个提供程序处于活动状态，但如果它们都可以以某种方式管理该属性，则可以指定多个提供程序。 确保将最强大的提供程序放在最前面，因为 IDE 必须使用 JSON 部分中它可以处理的第一个提供程序。 如果不支持给定属性的提供程序，则也不会提供特殊内容帮助。

任何

特殊的 any provider 值允许提供任何其他值。 如果支持，则应应用基于属性类型的常规值验证。spring-doc.cn

如果您有值列表，并且任何额外的值仍应被视为有效，则通常使用此提供程序。spring-doc.cn

以下示例提供 和 作为 auto-completion 值：onoffsystem.statespring-doc.cn

{"hints": [
	{
		"name": "system.state",
		"values": [
			{
				"value": "on"
			},
			{
				"value": "off"
			}
		],
		"providers": [
			{
				"name": "any"
			}
		]
	}
]}

请注意，在前面的示例中，还允许任何其他值。spring-doc.cn

类引用

类引用提供程序会自动完成项目中可用的类。 此提供程序支持以下参数：spring-doc.cn

参数 类型 默认值 描述

targetspring-doc.cn

String (Class)spring-doc.cn

没有spring-doc.cn

应分配给所选值的类的完全限定名称。 通常用于筛选出非候选类。 请注意，此信息可以由类型本身通过公开具有适当上限的类来提供。spring-doc.cn

concretespring-doc.cn

booleanspring-doc.cn

真spring-doc.cn

指定是否仅将具体类视为有效候选项。spring-doc.cn

以下元数据代码段对应于定义要使用的类名的标准属性必须是 HttpServlet：server.servlet.jsp.class-namespring-doc.cn

{"hints": [
	{
		"name": "server.servlet.jsp.class-name",
		"providers": [
			{
				"name": "class-reference",
				"parameters": {
					"target": "jakarta.servlet.http.HttpServlet"
				}
			}
		]
	}
]}

Handle As

handle-as 提供程序允许您将属性的类型替换为更高级的类型。 当属性具有 String 类型时，通常会发生这种情况，因为您不希望 configuration 类依赖于可能不在 Classpath 上的类。 此提供程序支持以下参数：spring-doc.cn

参数 类型 默认值 描述

targetspring-doc.cn

String (Class)spring-doc.cn

没有spring-doc.cn

要为属性考虑的类型的完全限定名称。 此参数为必填项。spring-doc.cn

可以使用以下类型：spring-doc.cn

  • Any Enum：列出属性的可能值。 （我们建议使用 Enum 类型定义属性，因为 IDE 不需要进一步的提示即可自动完成值）spring-doc.cn

  • Charset：支持自动补全 charset/encoding 值（例如UTF-8)spring-doc.cn

  • Locale：自动完成 locale（例如en_US)spring-doc.cn

  • MimeType：支持自动完成内容类型值（例如text/plain)spring-doc.cn

  • Resource：支持自动完成 Spring 的 Resource 抽象，以引用文件系统或 Classpath 上的文件（例如classpath:/sample.properties)spring-doc.cn

如果可以提供多个值，请使用 Collection 或 Array 类型向 IDE 提供相关信息。

以下元数据代码片段对应于定义要使用的更改日志路径的标准属性。 它实际上在内部用作 Resource，但不能公开，因为我们需要保留原始 String 值以将其传递给 Liquibase API。spring.liquibase.change-logspring-doc.cn

{"hints": [
	{
		"name": "spring.liquibase.change-log",
		"providers": [
			{
				"name": "handle-as",
				"parameters": {
					"target": "org.springframework.core.io.Resource"
				}
			}
		]
	}
]}

记录器名称

logger-name 提供程序会自动完成有效的 Logger 名称和 Logger 组。 通常，当前项目中可用的包和类名称可以自动完成。 如果启用了组（默认），并且在配置中标识了自定义 logger 组，则应为其提供自动完成。 特定框架可能具有额外的 magic logger 名称，也可以支持这些名称。spring-doc.cn

此提供程序支持以下参数：spring-doc.cn

参数 类型 默认值 描述

groupspring-doc.cn

booleanspring-doc.cn

truespring-doc.cn

指定是否应考虑已知组。spring-doc.cn

由于 Logger 名称可以是任意名称，因此此提供程序应允许任何值，但可以突出显示项目 Classpath 中不可用的有效包和类名称。spring-doc.cn

以下元数据代码片段对应于 standard 属性。 键是 Logger 名称，值对应于标准日志级别或任何自定义级别。 由于 Spring Boot 定义了一些开箱即用的 Logger 组，因此为这些组添加了专用的值提示。logging.levelspring-doc.cn

{"hints": [
	{
		"name": "logging.level.keys",
		"values": [
			{
				"value": "root",
				"description": "Root logger used to assign the default logging level."
			},
			{
				"value": "sql",
				"description": "SQL logging group including Hibernate SQL logger."
			},
			{
				"value": "web",
				"description": "Web logging group including codecs."
			}
		],
		"providers": [
			{
				"name": "logger-name"
			}
		]
	},
	{
		"name": "logging.level.values",
		"values": [
			{
				"value": "trace"
			},
			{
				"value": "debug"
			},
			{
				"value": "info"
			},
			{
				"value": "warn"
			},
			{
				"value": "error"
			},
			{
				"value": "fatal"
			},
			{
				"value": "off"
			}

		],
		"providers": [
			{
				"name": "any"
			}
		]
	}
]}

Spring Bean 参考

spring-bean-reference 提供程序自动完成在当前项目的配置中定义的 bean。 此提供程序支持以下参数：spring-doc.cn

参数 类型 默认值 描述

targetspring-doc.cn

String (Class)spring-doc.cn

没有spring-doc.cn

应分配给候选项的 Bean 类的完全限定名称。 通常用于过滤掉非候选 bean。spring-doc.cn

以下元数据代码片段对应于定义要使用的 MBeanServer bean 名称的标准属性：spring.jmx.serverspring-doc.cn

{"hints": [
	{
		"name": "spring.jmx.server",
		"providers": [
			{
				"name": "spring-bean-reference",
				"parameters": {
					"target": "javax.management.MBeanServer"
				}
			}
		]
	}
]}
Binder 不知道元数据。 如果你提供了该提示，你仍然需要将 Bean 名称转换为ApplicationContext使用的实际 Bean 引用。

Spring 配置文件名称

spring-profile-name 提供程序自动完成在当前项目的配置中定义的 Spring 配置文件。spring-doc.cn

以下元数据代码片段对应于定义要启用的 Spring 配置文件名称的标准属性：spring.profiles.activespring-doc.cn

{"hints": [
	{
		"name": "spring.profiles.active",
		"providers": [
			{
				"name": "spring-profile-name"
			}
		]
	}
]}