提供手动提示

QWen Max 中英对照 Providing Manual Hints

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

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

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

值提示

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

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

假设 my.contexts 将魔法 String 值映射到一个整数，如下例所示：

Java

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

}

Kotlin

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

@ConfigurationProperties("my")
class MyProperties(val contexts: Map<String, Int>)

这些魔法值（在此示例中）是 sample1 和 sample2。为了为键提供额外的内容辅助，您可以将以下 JSON 添加到模块的手动元数据中：

{"hints": [
	{
		"name": "my.contexts.keys",
		"values": [
			{
				"value": "sample1"
			},
			{
				"value": "sample2"
			}
		]
	}
]}

备注

提示也可以为外部类型添加，并在每次使用该类型时应用。

提示

我们建议您改用 Enum 来表示这两个值。如果您的 IDE 支持，这无疑是实现自动补全最有效的方法。

值提供者

Providers 是一种为属性附加语义的强大方式。在本节中，我们定义了你可以用于自己提示的官方 providers。然而，你喜爱的 IDE 可能实现其中一些、全部或都不实现。此外，它最终也可能提供自己的 providers。

备注

由于这是一个新功能，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 提供者可自动补全项目中可用的类。该提供者支持以下参数：

参数	类型	默认值	描述
target	String (Class)	无	应该可赋值给所选值的类的全限定名。通常用于过滤掉非候选类。注意，此信息可以通过类型本身提供，即暴露一个具有适当上界的类。
concrete	boolean	true	指定是否仅将具体类视为有效候选者。

以下元数据片段对应于标准的 server.servlet.jsp.class-name 属性，该属性定义了必须使用的类名，且该类必须是 HttpServlet：

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

Handle As

handle-as 提供者允许你将属性的类型替换为更高级别的类型。这通常发生在属性类型为 String 时，因为你不想让你的配置类依赖于可能不在 classpath 上的类。该提供者支持以下参数：

参数	类型	默认值	描述
target	String (Class)	无	用于属性考虑的类型的全限定名。此参数为必填项。

以下类型可以使用：

• 任何 Enum：列出该属性的可能取值。（我们建议将属性定义为 Enum 类型，这样 IDE 无需额外提示即可自动补全这些值）

• Charset：支持字符集/编码值的自动补全（例如 UTF-8）

• Locale：支持区域设置的自动补全（例如 en_US）

• MimeType：支持内容类型值的自动补全（例如 text/plain）

• Resource：支持 Spring 的 Resource 抽象的自动补全，用于引用文件系统或类路径上的文件（例如 classpath:/sample.properties）

提示

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

以下元数据片段对应于标准的 spring.liquibase.change-log 属性，该属性定义了要使用的变更日志路径。它实际上在内部被用作 Resource，但不能直接暴露为这种类型，因为我们需保留原始的 String 值以将其传递给 Liquibase API。

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

Logger Name

logger-name 提供者会自动补全有效的日志记录器名称和日志组。通常，当前项目中可用的包名和类名可以被自动补全。如果启用了日志组（默认启用），并且在配置中识别到自定义的日志组，则应为其提供自动补全功能。特定框架可能还支持一些额外的“魔法”日志记录器名称。

该提供者支持以下参数：

参数	类型	默认值	描述
group	boolean	true	指定是否应考虑已知的组。

由于 logger 名称可以是任意名称，此提供者应允许任何值，但可以高亮显示项目 classpath 中不存在的有效包名和类名。

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

{"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。该提供者支持以下参数：

参数	类型	默认值	描述
target	String (Class)	无	应该可分配给候选 Bean 的 Bean 类的全限定名。通常用于过滤掉非候选 Bean。

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

{"hints": [
	{
		"name": "spring.jmx.server",
		"providers": [
			{
				"name": "spring-bean-reference",
				"parameters": {
					"target": "javax.management.MBeanServer"
				}
			}
		]
	}
]}

备注

binder 并不知道元数据。如果你提供了该提示，你仍然需要使用 ApplicationContext 将 bean 名称转换为实际的 Bean 引用。

Spring Profile 名称

spring-profile-name 提供者会自动补全当前项目配置中定义的 Spring profiles。

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

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