|
对于最新的稳定版本，请使用 Spring Boot 3.4.0！ |
提供手动提示
为了改善用户体验并进一步帮助用户配置给定属性，您可以提供其他元数据，以便：
-
描述属性的可能值列表。
-
关联提供程序，以将定义完善的语义附加到属性，以便工具可以根据项目的上下文发现潜在值的列表。
值提示
这name属性引用name的财产。
在前面显示的初始示例中，我们为spring.jpa.hibernate.ddl-auto财产：none,validate,update,create和create-drop.
每个值也可能具有说明。
如果您的属性为Map中，你可以为 key 和 values 提供提示（但不能为 map 本身提供提示）。
特别的.keys和.valuessuffixes 必须分别引用 keys 和 values。
假设my.contexts地图魔术Stringvalues 设置为 integer，如以下示例所示：
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 供应商必须跟上它的工作原理。 采用时间自然会有所不同。 |
下表总结了支持的提供程序列表：
| 名字 | 描述 |
|---|---|
|
允许提供任何其他值。 |
|
自动完成项目中可用的类。
通常由 |
|
处理属性，就好像它是由 mandatory 定义的类型定义的一样 |
|
自动完成有效的 Logger 名称和 Logger 组。 通常，当前项目中可用的包名和类名可以自动完成，也可以定义组。 |
|
自动完成当前项目中的可用 Bean 名称。
通常由 |
|
自动完成项目中可用的 Spring 配置文件名称。 |
| 对于给定属性，只能有一个提供程序处于活动状态，但如果它们都可以以某种方式管理该属性，则可以指定多个提供程序。 确保将最强大的提供程序放在最前面，因为 IDE 必须使用 JSON 部分中它可以处理的第一个提供程序。 如果不支持给定属性的提供程序，则也不会提供特殊内容帮助。 |
任何
特殊的 any provider 值允许提供任何其他值。 如果支持，则应应用基于属性类型的常规值验证。
如果您有值列表，并且任何额外的值仍应被视为有效，则通常使用此提供程序。
以下示例提供on和off作为system.state:
{"hints": [
{
"name": "system.state",
"values": [
{
"value": "on"
},
{
"value": "off"
}
],
"providers": [
{
"name": "any"
}
]
}
]}请注意，在前面的示例中，还允许任何其他值。
类引用
类引用提供程序会自动完成项目中可用的类。 此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
应分配给所选值的类的完全限定名称。 通常用于筛选出非候选类。 请注意，此信息可以由类型本身通过公开具有适当上限的类来提供。 |
|
|
真 |
指定是否仅将具体类视为有效候选项。 |
以下元数据代码片段对应于标准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 提供程序允许您将属性的类型替换为更高级的类型。
当属性具有Stringtype，因为您不希望 configuration 类依赖于可能不在 Classpath 上的类。
此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
要为属性考虑的类型的完全限定名称。 此参数为必填项。 |
可以使用以下类型：
如果可以提供多个值，请使用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 名称和 Logger 组。 通常，当前项目中可用的包和类名称可以自动完成。 如果启用了组（默认），并且在配置中标识了自定义 logger 组，则应为其提供自动完成。 特定框架可能具有额外的 magic logger 名称，也可以支持这些名称。
此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
|
指定是否应考虑已知组。 |
由于 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。 此提供程序支持以下参数：
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
应分配给候选对象的 Bean 类的完全限定名称。 通常用于过滤掉非候选 bean。 |
以下元数据代码片段对应于标准spring.jmx.server定义MBeanServer要使用的 bean：
{"hints": [
{
"name": "spring.jmx.server",
"providers": [
{
"name": "spring-bean-reference",
"parameters": {
"target": "javax.management.MBeanServer"
}
}
]
}
]}Binder 不知道元数据。
如果你提供了该提示，你仍然需要将 Bean 名称转换为实际的 Bean 引用，使用ApplicationContext. |