附录 B.2.2 值提供者
最后更新于
最后更新于
提供者是将语义附加到属性上的一种强大的方式。我们在下面的章节里定义了官方的提供者,你可以为你自己的提示使用它们。但是,必须记住:你最喜欢的IDE可能实现了其中的一部分,或者什么也没有实现。它也可以最后提供它自己。
注 由于这是一个新特性,IDE供应商必须跟上它的工作方式。采用时间自然会有所不同。
下面👇的表格总结了支持的提供者的列表:
注 对于一个给定的属性,只能有一个有效的提供者。但是,如果可以以某种方式共同管理属性,你也可以指定多个提供者。确保把最强大的提供者放在第一位,因为IDE必须使用它能够处理的JSON部分里的第一个。如果对于一个给定的属性,没有提供者提供支持,也不会有特殊的内容帮助被提供。
Any
特殊的any提供程序值允许提供任何附加值。如果支持,应该应用基于属性类型的常规值验证。
如果你有一个值列表,并且任何额外的值仍然被认为是有效的,则通常使用此提供程序。
下面的例子提供了on
和off
作为system.state
的自动完成值:
注意,在前面的示例中,还允许任何其他值。
Class Reference
class-reference提供程序自动完成项目中可用的类。该提供程序支持以下参数:
下面的元数据片段对应于标准的server.servlet.jsp.class-name
属性定义了要使用的JspServlet
类名:
Handle As
handle-as提供程序允许您将属性的类型替换为更高级的类型。当属性具有java.lang.String
类型时,通常会发生这种情况。因为你不希望配置类依赖于可能不在类路径上的类。该提供程序支持以下参数:
可以使用以下类型:
任何java.lang.Enum
:列出属性的可能值。(我们建议使用Enum
类型定义属性,因为IDE不需要进一步的提示就可以自动完成这些值。)
java.nio.charset.Charset
:支持自动完成字符集/编码值(如UTF-8
)
java.util.Locale
:自动完成区域设置(如en_US
)
org.springframework.util.MimeType
:支持自动完成内容类型值(例如text/plain
)
org.springframework.core.io.Resource
:支持自动完成Spring的资源抽象,以引用文件系统或类路径上的文件。(如classpath:/sample.properties
)
注 如果可以提供多个值,则使用集合
或数组类型来教导IDE。
下面的元数据片段对应于标准的spring.liquibase.change-log
属性,定义要使用的更改日志的路径。它实际上是作为一个org.springframework.core.io.Resource
在内部使用的。但是不能这样公开,因为我们需要保留原始的字符串值,以便将它传递给Liquibase API。
Logger Name
logger-name提供程序自动完成有效的日志程序名称。通常,当前项目中可用的包名和类名可以自动完成。特定的框架可能有额外的、也可以支持的神奇日志程序名称。
由于记录器名称可以是任意的名称,因此该提供程序应该允许任何值,但是可以突出显示项目的类路径中不可用的有效包和类名称。
下面的元数据片段对应于标准logging.level
属性。键是记录器名称,值对应于标准日志级别或任何自定义级别。
Spring Bean Reference
spring-bean-reference
提供程序自动完成当前项目配置中定义的bean。该提供程序支持以下参数:
下面的元数据片段对应于标准的spring.jmx.server
属性,定义要使用的MBeanServer
bean的名称:
注 绑定器不知道元数据。如果你提供了那个提示,你仍然需要将bean名称转换为ApplicationContext
使用的实际bean引用。
Spring Profile Name
spring-profile-name
提供程序自动完成在当前项目的配置中定义的Spring配置文件。
下面的元数据片段对应于标准的spring.profiles.active
属性,定义要启用的Spring配置文件的名称: