提供手动提示
为了提升用户体验并进一步帮助用户配置特定属性，您可以提供额外的元数据，这些元数据可以：
-
描述某个属性的潜在取值列表。
-
关联一个提供者，为属性附加明确的语义，以便工具可以根据项目的上下文发现潜在值的列表。
值提示
每个提示的name属性指的是某个属性的name。
在前面展示的初始示例中，我们为spring.jpa.hibernate.ddl-auto属性提供了五个值：none、validate、update、create和create-drop。
每个值也可以包含描述信息。
如果您的属性类型为 Map，您可以为键和值提供提示（但不能为映射本身提供提示）。
特殊的 .keys 和 .values 后缀必须分别引用键和值。
假设一个 my.contexts 将魔法 String 值映射为整数，如下例所示：
-
Java
-
Kotlin
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;
}
}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）是一种为属性附加语义的强大方式。 在本节中，我们定义了您可以用于自己提示的官方提供者。 然而，您喜爱的 IDE 可能会实现其中一部分、全部，或者都不实现。 此外，它最终也可能提供自己的提供者。
| 由于这是一个新特性，IDE 厂商需要跟进其工作方式。 采用时间自然会有所不同。 |
下表汇总了支持的提供者列表：
| 姓名 | <description> </description> |
|---|---|
|
允许提供任何额外的值。 |
|
自动补全项目中可用的类。
通常受由 |
|
将该属性视为由必需的 |
|
自动补全有效的日志记录器名称和日志记录器组。 通常，当前项目中可用的包名和类名以及已定义的组都可以自动补全。 |
|
自动补全当前项目中可用的 Bean 名称。
通常会受到由 |
|
自动补全项目中可用的 Spring 配置文件名称。 |
| 对于某个给定的属性，只能有一个提供者处于激活状态，但如果你能确保所有提供者都以某种方式管理该属性，则可以指定多个提供者。 请务必将功能最强大的提供者放在首位，因为 IDE 必须使用 JSON 部分中它能够处理的第一个提供者。 如果某个属性没有任何受支持的提供者，那么也不会提供任何特殊的内容辅助功能。 |
任何
特殊的 any 提供者值允许提供任何额外的值。 如果支持，应基于属性类型进行常规的值验证。
如果您的值列表中包含一组值，并且任何额外的值仍应被视为有效，则通常使用此提供程序。
以下示例为 on 提供 off 和 system.state 作为自动补全值：
{"hints": [
{
"name": "system.state",
"values": [
{
"value": "on"
},
{
"value": "off"
}
],
"providers": [
{
"name": "any"
}
]
}
]}请注意，在前面的示例中，也允许使用任何其他值。
类参考
class-reference 提供程序可自动补全项目中可用的类。 该提供程序支持以下参数：
| 参数 | 类型 | 默认值 | <description> </description> |
|---|---|---|---|
|
|
无 |
应可赋值给所选值的类的全限定名。 通常用于过滤掉非候选类。 请注意，此信息也可以由类型本身提供，方法是公开一个具有适当上界的类。 |
|
|
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 提供者允许您将属性的类型替换为更高级别的类型。
这通常发生在属性具有 String 类型时，因为您不希望配置类依赖于可能不在类路径上的类。
此提供者支持以下参数：
| 参数 | 类型 | 默认值 | <description> </description> |
|---|---|---|---|
|
|
无 |
用于该属性的类型的完全限定名称。 此参数为必填项。 |
可使用以下类型：
如果可以提供的值有多个，请使用 Collection 或 Array 类型来告知 IDE。 |
以下元数据片段对应于标准 spring.liquibase.change-log 属性，该属性定义了要使用的变更日志的路径。
它实际上在内部作为 Resource 使用，但无法以此形式暴露，因为我们需要保留原始字符串值以便传递给 Liquibase API。
{"hints": [
{
"name": "spring.liquibase.change-log",
"providers": [
{
"name": "handle-as",
"parameters": {
"target": "org.springframework.core.io.Resource"
}
}
]
}
]}日志名称
logger-name 提供程序可自动补全有效的日志记录器名称和日志记录器组。 通常，当前项目中可用的包名和类名均可自动补全。 如果启用了日志记录器组（默认启用），并且在配置中识别出自定义的日志记录器组，则应为其提供自动补全功能。 某些特定框架可能还支持额外的特殊日志记录器名称。
此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | <description> </description> |
|---|---|---|---|
|
|
|
指定是否应考虑已知的组。 |
由于日志记录器的名称可以是任意名称，因此该提供程序应允许任何值，但可以高亮显示那些在项目类路径中不存在的有效包名和类名。
以下元数据片段对应于标准的 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。 该提供程序支持以下参数：
| 参数 | 类型 | 默认值 | <description> </description> |
|---|---|---|---|
|
|
无 |
应可赋值给候选 Bean 的 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 引用。 |