提供手动提示
为了提升用户体验并进一步协助用户配置特定属性,您可以提供额外的元数据,包括:
-
描述某一房产可能价值的列表。
-
关联提供者,将明确定义的语义附加到属性上,使工具能够根据项目上下文发现潜在值列表。
价值提示
这名称每个提示的属性指代名称一处房产的。
在前面展示的初始示例中,我们给出了五个spring.jpa.hibernate.ddl-auto财产:没有,驗證,更新,创造和创作-丢弃.
每个值也可能带有描述。
如果你的财产属于类型地图你可以为键和数值提供提示(但不能为映射本身提供提示)。
特别节目。钥匙和。值后缀必须分别指代键和值。
假设我的.contexts地图魔法字符串将值映射到整数,如下例所示:
-
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>)
魔法值(在本例中)为样本1和样本2.
为了为密钥提供额外的内容辅助,你可以在模块的手动元数据中添加以下 JSON:
{"hints": [
{
"name": "my.contexts.keys",
"values": [
{
"value": "sample1"
},
{
"value": "sample2"
}
]
}
]}
| 也可以为外部类型添加提示,并在使用该类型时应用。 |
我们建议您使用枚举而是针对这两个数值。
如果你的IDE支持,这无疑是最有效的自动补全方法。 |
价值提供者
服务提供者是赋予属性语义的强大方式。 在本节中,我们将定义你可以用来获取提示的官方服务。 不过,你喜欢的IDE可能会实现其中一些,也可能一个都不实现。 此外,它最终也可能提供自己的产品。
| 由于这是一个新功能,IDE厂商必须跟上其工作原理。 收养时间自然不同。 |
下表总结了支持的提供者列表:
| 名称 | 描述 |
|---|---|
|
允许提供任何额外价值。 |
|
自动完成项目中可用的课程。
通常由 |
|
处理该属性的过程就像由强制性定义的类型一样 |
|
自动补全有效的日志器名称和日志组。 通常,当前项目中可用的包和类名称可以自动完成,也可以自定义组。 |
|
自动补全当前项目中可用的Beans名称。
通常由 |
|
自动补全项目中可用的 Spring 配置文件名称。 |
| 同一物业只能有一个提供商活跃,但如果他们都能以某种方式管理该物业,你可以指定多个提供者。 确保将最强大的提供者放在最前面,因为IDE必须使用它能处理的JSON部分中第一个提供者。 如果某一房产没有提供任何服务提供者,也不会提供特别的内容协助。 |
任何
特别的“任意提供者”值允许提供任何额外值。 如果支持,应基于属性类型进行定期的价值验证。
通常用于你有数值列表且多余值仍应被视为有效。
以下示例提供了上和不对劲作为 的自动补全值system.state:
{"hints": [
{
"name": "system.state",
"values": [
{
"value": "on"
},
{
"value": "off"
}
],
"providers": [
{
"name": "any"
}
]
}
]}
注意,在上述例子中,任何其他值也被允许。
类别参考
类引用提供者自动补全项目中可用的类。该提供者支持以下参数:
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
应分配给所选值的完全限定类名称。通常用于过滤非候选类。注意,这些信息可由类型本身提供,通过暴露具有适当上界的类。 |
|
|
true |
明确是否仅将具体类视为有效候选。 |
以下元数据片段对应标准server.servlet.jsp.类名定义所用类名的属性必须是HttpServlet:
{"hints": [
{
"name": "server.servlet.jsp.class-name",
"providers": [
{
"name": "class-reference",
"parameters": {
"target": "jakarta.servlet.http.HttpServlet"
}
}
]
}
]}
Handle As
Handle-as提供者允许您将属性类型替换为更高级的类型。这通常发生在属性具有字符串类型,因为你不希望配置类依赖可能不在类路径上的类。该提供者支持以下参数:
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
为该属性考虑的类型名称。该参数是必填的。 |
可以使用以下类型:
如果能提供多个值,可以使用收集或者数组类型来教IDE相关信息。 |
以下元数据片段对应标准spring.liquibase.change-log定义了使用到变更日志路径的属性。它实际上在内部被用作资源但不能以 Strit 的身份暴露,因为我们需要保留原始的 String 值才能传递给 Liquibase API。
{"hints": [
{
"name": "spring.liquibase.change-log",
"providers": [
{
"name": "handle-as",
"parameters": {
"target": "org.springframework.core.io.Resource"
}
}
]
}
]}
Logging机名称
日志器名称提供者自动补全有效的日志器名称和日志组。通常,当前项目中可用的包名和类名称可以实现自动补全。如果组已启用(默认),并且配置中识别了自定义日志组,应为其提供自动补全功能。特定框架可能还支持额外的神奇日志器名称。
该提供者支持以下参数:
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
|
明确是否应考虑已知的群组。 |
由于日志器名称可以是任意名称,该提供者应允许任意值,但可以突出显示项目类路径中不存在的有效包和类名称。
以下元数据片段对应标准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-reference 提供者自动补全当前项目配置中定义的 beans。该提供者支持以下参数:
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
|
|
没有 |
应分配给候选Beans的完全限定名称。通常用于过滤非候选Beans。 |
以下元数据片段对应标准spring.jmx.server定义了MBeanServer使用豆子:
{"hints": [
{
"name": "spring.jmx.server",
"providers": [
{
"name": "spring-bean-reference",
"parameters": {
"target": "javax.management.MBeanServer"
}
}
]
}
]}
装订器并不知道元数据。如果你提供了这个提示,你仍然需要将豆子名称转换成实际的豆子引用,使用应用上下文. |