提供手動提示

為了改善使用者體驗並進一步幫助使用者配置給定屬性，您可以提供額外的元資料，這些元資料

  • 描述了屬性的潛在值列表。

  • 關聯一個提供者，以賦予屬性一個明確定義的語義，以便工具可以根據專案上下文發現潛在值列表。

值提示

每個提示的 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 供應商必須跟上其工作方式。採用時間自然會有所不同。

下表總結了支援的提供者列表

名稱 描述

任何

允許提供任何額外的值。

類引用

自動完成專案中可用的類。通常受 target 引數指定的基類限制。

處理為

將屬性視為由強制 target 引數定義的型別定義。

記錄器名稱

自動完成有效的記錄器名稱和記錄器組。通常，當前專案中可用的包和類名以及已定義的組都可以自動完成。

Spring Bean 引用

自動完成當前專案中可用的 Bean 名稱。通常受 target 引數指定的基類限制。

Spring Profile 名稱

自動完成專案中可用的 Spring Profile 名稱。
對於給定屬性，只能有一個提供者處於活動狀態，但如果所有提供者都能以某種方式管理該屬性，則可以指定多個提供者。請確保將最強大的提供者放在前面，因為 IDE 必須使用 JSON 部分中它可以處理的第一個提供者。如果不支援給定屬性的提供者，則也不會提供特殊的程式碼輔助。

任何

特殊的 any 提供者值允許提供任何額外的值。如果支援，應應用基於屬性型別的常規值驗證。

此提供者通常用於您有一個值列表，並且任何額外的值仍應被視為有效的情況。

以下示例為 system.state 提供了 on 和 off 作為自動完成值

{"hints": [
	{
		"name": "system.state",
		"values": [
			{
				"value": "on"
			},
			{
				"value": "off"
			}
		],
		"providers": [
			{
				"name": "any"
			}
		]
	}
]}

請注意，在前面的示例中，也允許任何其他值。

類引用

class-reference 提供者自動完成專案中可用的類。此提供者支援以下引數

引數 型別 預設值 描述

target

String (Class)

無

應可分配給所選值的類的完全限定名。通常用於過濾掉非候選類。請注意，此資訊可以透過型別本身暴露一個具有適當上限的類來提供。

具體

布林值

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 型別時，因為您不希望您的配置類依賴於可能不在類路徑中的類。此提供者支援以下引數

引數 型別 預設值 描述

target

String (Class)

無

要為屬性考慮的型別的完全限定名。此引數是強制性的。

可以使用以下型別

  • 任何 Enum：列出屬性的可能值。（我們建議使用 Enum 型別定義屬性，因為 IDE 自動完成這些值不需要進一步的提示）

  • Charset：支援字元集/編碼值（例如 UTF-8）的自動完成

  • Locale：區域設定的自動完成（例如 en_US）

  • MimeType：支援內容型別值（例如 text/plain）的自動完成

  • Resource：支援 Spring 的資源抽象的自動完成，以引用檔案系統或類路徑上的檔案（例如 classpath:/sample.properties）

如果可以提供多個值，請使用 Collection 或 Array 型別來告知 IDE。

以下元資料片段對應於標準 spring.liquibase.change-log 屬性，該屬性定義要使用的變更日誌的路徑。它實際上在內部用作 Resource，但不能這樣暴露，因為我們需要保留原始字串值以將其傳遞給 Liquibase API。

{"hints": [
	{
		"name": "spring.liquibase.change-log",
		"providers": [
			{
				"name": "handle-as",
				"parameters": {
					"target": "org.springframework.core.io.Resource"
				}
			}
		]
	}
]}

記錄器名稱

logger-name 提供者自動完成有效的記錄器名稱和記錄器組。通常，當前專案中可用的包和類名可以自動完成。如果啟用組（預設），並且在配置中識別出自定義記錄器組，則應為其提供自動完成。特定的框架可能也有額外的魔法記錄器名稱，也可以支援這些名稱。

此提供者支援以下引數

引數 型別 預設值 描述

group

布林值

true

指定是否應考慮已知組。

由於記錄器名稱可以是任何任意名稱，因此此提供者應允許任何值，但可以突出顯示專案中類路徑中不可用的有效包和類名。

以下元資料片段對應於標準 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。此提供者支援以下引數

引數 型別 預設值 描述

target

String (Class)

無

應可分配給候選的 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 引用。

Spring Profile 名稱

spring-profile-name 提供者自動完成當前專案配置中定義的 Spring Profile。

以下元資料片段對應於標準 spring.profiles.active 屬性，該屬性定義要啟用的 Spring Profile 的名稱

{"hints": [
	{
		"name": "spring.profiles.active",
		"providers": [
			{
				"name": "spring-profile-name"
			}
		]
	}
]}
© . This site is unofficial and not affiliated with VMware.