|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Boot 3.5.5！ |
提供手动提示
为了改善用户体验并进一步帮助用户配置给定属性，您可以提供其他元数据，这些元数据：
-
描述属性的潜在值列表。
-
关联提供程序，将定义明确的语义附加到属性，以便工具可以根据项目的上下文发现潜在值的列表。
价值提示
这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 支持它，这是迄今为止最有效的自动完成方法。 |
价值提供者
提供程序是将语义附加到属性的强大方法。 在本节中，我们将定义可用于自己的提示的官方提供程序。 但是，您最喜欢的 IDE 可能会实现其中的一些，或者没有实现其中的一部分。 此外，它最终可以提供自己的。
| 由于这是一项新功能，IDE 提供商必须赶上它的工作原理。 采用时间自然会有所不同。 |
下表汇总了受支持的提供程序列表：
| 名称 | 描述 |
|---|---|
|
允许提供任何附加值。 |
|
自动完成项目中可用的类。
通常受 |
|
处理属性，就像它是由必需的 |
|
自动完成有效的记录器名称和记录器组。 通常，当前项目中可用的包和类名称可以自动完成，也可以自动完成定义的组。 |
|
自动完成当前项目中可用的 bean 名称。
通常受 |
|
自动完成项目中可用的 Spring 配置文件名称。 |
| 对于给定属性，只能有一个提供程序处于活动状态，但如果多个提供程序都可以以某种方式管理该属性，则可以指定它们。 确保将功能最强大的提供程序放在第一位，因为 IDE 必须使用 JSON 部分中它可以处理的第一个提供程序。 如果不支持给定属性的提供程序，则也不会提供特殊的内容帮助。 |
任何
特殊的 any provider 值允许提供任何其他值。 如果支持，则应应用基于属性类型的常规值验证。
如果您有值列表，并且任何额外的值仍应被视为有效，则通常使用此提供程序。
以下示例提供on和off作为自动完成值system.state:
{"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 传授它。 |
以下元数据片段对应于标准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 提供程序会自动完成有效的记录器名称和记录器组。 通常，当前项目中可用的包和类名称可以自动完成。 如果启用了组（默认），并且在配置中标识了自定义记录器组，则应为其提供自动完成功能。 特定框架可能也有额外的魔术记录器名称，也可以支持。
此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
|
指定是否应考虑已知组。 |
由于记录器名称可以是任何任意名称，因此此提供程序应允许任何值，但可以突出显示项目类路径中不可用的有效包和类名称。
以下元数据片段对应于标准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. |