|
此版本仍在开发中，尚未被视为稳定版本。如需最新稳定版本，请使用 Spring Boot 4.0.4! |
提供手动提示
为提升用户体验，并进一步协助用户配置特定属性，您可以提供以下附加元数据：
-
描述属性的可能取值列表。
-
将提供程序关联起来，为属性赋予明确定义的语义，从而使工具能够基于项目的上下文发现潜在值的列表。
值提示
每个提示的 name 属性对应于某个属性的 name。
在前面展示的初始示例中，我们为 spring.jpa.hibernate.ddl-auto 属性提供了五个值：none、validate、update、create 和 create-drop。
每个值还可以附带一段描述。
如果您的属性类型为 Map，则可以分别为键（key）和值（value）提供类型提示（但不能为映射（map）本身提供提示）。
特殊的后缀 .keys 和 .values 必须分别对应键（key）和值（value）。
假设一个 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）是一种为属性附加语义的强大方式。 在本节中，我们将定义您可在自身提示（hints）中使用的官方提供程序。 然而，您所偏好的 IDE 可能会实现其中部分提供程序，也可能一个都不实现。 此外，它最终还可能提供自己专属的提供程序。
| 由于这是一个新功能，IDE 提供商需要时间来适配其工作方式。 采用时间自然各不相同。 |
下表汇总了受支持的提供程序列表：
| 名称 | 描述 |
|---|---|
|
允许提供任何其他值。 |
|
自动补全项目中可用的类。
通常受 |
|
将该属性视为由必需的 |
|
自动补全有效的记录器名称和记录器组。 通常，当前项目中可用的包名和类名，以及已定义的组，均可进行自动补全。 |
|
自动补全当前项目中可用的 Bean 名称。
通常受 |
|
自动补全项目中可用的 Spring 配置文件名称。 |
| 对于给定属性，只能有一个提供程序处于激活状态；但如果您指定的多个提供程序均能以某种方式管理该属性，则可以同时指定多个提供程序。 请确保将功能最强大的提供程序置于首位，因为 IDE 必须使用 JSON 配置节中它能够处理的第一个提供程序。 如果没有任何提供程序支持某个给定属性，则不会为此属性提供任何特殊的内容辅助功能。 |
任意
特殊的 any 提供程序值允许提供任意其他值。 如果支持，应基于属性类型执行常规值验证。
如果拥有一组值列表，且任何额外的值也应被视为有效，则通常使用此提供程序。
以下示例为 system.state 提供了自动完成值 on 和 off：
{"hints": [
{
"name": "system.state",
"values": [
{
"value": "on"
},
{
"value": "off"
}
],
"providers": [
{
"name": "any"
}
]
}
]}注意，在前面的示例中，允许使用任何其他值。
类参考
类引用 提供程序可自动完成项目中可用的类。 该提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
无 |
应与所选值兼容的类的全限定名。 通常用于过滤掉非候选类。 请注意，此信息可通过类型自身提供，即通过暴露具有适当上界的类来实现。 |
|
|
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 时，因为您不希望配置类依赖于可能不在类路径中的类。
该提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
无 |
该属性所考虑类型的完全限定名称。 此参数为必填项。 |
以下类型可以使用：
如果可提供多个值，请使用 Collection 或 数组 类型，以便向 IDE 表明这一点。 |
以下元数据片段对应于定义所用变更日志（changelog）路径的标准 spring.liquibase.change-log 属性。
该属性实际上在内部被用作 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。 该提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
无 |
应可分配给候选对象的 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 引用。 |