提供手动提示

为了改善用户体验并进一步帮助用户配置给定属性，您可以提供额外的元数据，

  • 描述属性的潜在值列表。

  • 将提供者与属性关联，以附加明确的语义，以便工具可以根据项目的上下文发现潜在值的列表。

值提示

每个提示的name属性引用属性的name。在前面显示的初始示例中，我们为spring.jpa.hibernate.ddl-auto属性提供了五个值：none、validate、update、create和create-drop。每个值也可以有描述。

如果您的属性类型为Map，则可以为键和值提供提示（但不能为映射本身提供提示）。特殊的.keys和.values后缀必须分别引用键和值。

假设一个my.contexts将神奇的String值映射到整数，如下例所示

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;
	}

}

神奇的值（在本例中）是sample1和sample2。为了为键提供额外的内容帮助，您可以将以下 JSON 添加到模块的手动元数据

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

值提供者

提供者是将语义附加到属性的强大方法。在本节中，我们定义了您可以用于自己的提示的官方提供者。但是，您喜欢的 IDE 可能实现其中一些或全部都不实现。此外，它最终可能会提供自己的提供者。

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

下表总结了支持的提供者列表

名称 描述

any

允许提供任何其他值。

class-reference

自动完成项目中可用的类。通常受target参数指定的基类约束。

handle-as

将属性处理为由必需的target参数定义的类型定义。

logger-name

自动完成有效的日志记录器名称和日志记录器组。通常，当前项目中可用的包和类名称以及定义的组都可以自动完成。

spring-bean-reference

自动完成当前项目中可用的 bean 名称。通常受target参数指定的基类约束。

spring-profile-name

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

任何

特殊的 **any** 提供者值允许提供任何其他值。如果支持，应根据属性类型应用常规值验证。

此提供者通常用于您有一个值列表，并且任何额外值都应被视为有效。

以下示例为 system.state 提供 on 和 off 作为自动完成值

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

请注意，在前面的示例中，任何其他值也允许。

类引用

**class-reference** 提供者自动完成项目中可用的类。此提供者支持以下参数

参数 类型 默认值 描述

目标

String (Class)

无

应分配给所选值的类的完全限定名称。通常用于过滤掉非候选类。请注意，此信息可以通过类型本身提供，方法是公开具有适当上限的类。

具体

布尔值

真

指定是否仅将具体类视为有效候选者。

以下元数据片段对应于标准 server.servlet.jsp.class-name 属性，该属性定义要使用的 JspServlet 类名

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

处理为

**handle-as** 提供者允许您将属性的类型替换为更高级别的类型。这通常发生在属性具有 java.lang.String 类型时，因为您不希望您的配置类依赖于可能不在类路径上的类。此提供者支持以下参数

参数 类型 默认值 描述

目标

String (Class)

无

要为属性考虑的类型的完全限定名称。此参数是必需的。

可以使用以下类型

  • 任何 java.lang.Enum：列出属性的可能值。（我们建议使用 Enum 类型定义属性，因为 IDE 不需要进一步的提示来自动完成值）

  • java.nio.charset.Charset: 支持字符集/编码值的自动完成（例如 UTF-8）

  • java.util.Locale: 自动完成语言环境（例如 en_US）

  • org.springframework.util.MimeType: 支持内容类型值的自动完成（例如 text/plain）

  • org.springframework.core.io.Resource: 支持 Spring 的 Resource 抽象的自动完成，用于引用文件系统或类路径上的文件（例如 classpath:/sample.properties）

如果可以提供多个值，请使用 Collection 或数组类型来告知 IDE。

以下元数据片段对应于标准 spring.liquibase.change-log 属性，该属性定义要使用的变更日志的路径。它实际上是在内部用作 org.springframework.core.io.Resource，但不能以这种方式公开，因为我们需要保留原始字符串值以将其传递给 Liquibase API。

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

日志记录器名称

日志记录器名称提供程序自动完成有效的日志记录器名称和日志记录器组。通常，当前项目中可用的包和类名可以自动完成。如果启用了组（默认情况下）并且在配置中标识了自定义日志记录器组，则应为其提供自动完成。特定框架可能还具有可以支持的额外神奇日志记录器名称。

此提供程序支持以下参数

参数 类型 默认值 描述

组

布尔值

真

指定是否应考虑已知组。

由于日志记录器名称可以是任何任意名称，因此此提供程序应允许任何值，但可以突出显示项目类路径中不可用的有效包和类名。

以下元数据片段对应于标准 logging.level 属性。键是日志记录器名称，值对应于标准日志级别或任何自定义级别。由于 Spring Boot 在开箱即用时定义了一些日志记录器组，因此已为这些组添加了专用的值提示。

{"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。此提供程序支持以下参数

参数 类型 默认值 描述

目标

String (Class)

无

应可分配给候选者的 Bean 类的完全限定名称。通常用于过滤掉非候选 Bean。

以下元数据片段对应于标准 spring.jmx.server 属性，该属性定义要使用的 MBeanServer Bean 的名称

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

Spring 配置文件名称

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

以下元数据片段对应于标准 spring.profiles.active 属性，该属性定义要启用的 Spring 配置文件名称。

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