springboot之如何使用additional-spring-configuration-metadata.json自定義提示

這篇文章主要介紹springboot之如何使用additional-spring-configuration-metadata.json自定義提示，文中介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們一定要看完！

官方一篇文章很詳細講解了Configuration Metadata的作用。 有興趣的小伙伴可以查看下(配置元數據)。

Configuration Metadata

Appendix B. Configuration Metadata
Spring Boot jars include metadata files that provide details of all supported configuration properties. The files are designed to let IDE developers offer contextual help and “code completion” as users are working with application.properties or application.yml files.

The majority of the metadata file is generated automatically at compile time by processing all items annotated with @ConfigurationProperties. However, it is possible to write part of the metadata manually for corner cases or more advanced use cases.

簡介說明配置additional-spring-configuration-metadata.json文件后，在開發人員的IDE工具使用個人編寫的配置讀取很有效的在application.properties或application.yml文件下完成提示。

使用

1. 元數據格式

配置元數據文件位于jar下面。 META-INF/spring-configuration-metadata.json它們使用簡單的JSON格式，其中的項目分類在“groups”或“properties”下，其他值提示分類在“hints”下，如下例所示：

{"groups": [
	{
		"name": "server",
		"type": "org.springframework.boot.autoconfigure.web.ServerProperties",
		"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
	}
	...
],"properties": [
	{
		"name": "server.port",
		"type": "java.lang.Integer",
		"sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties"
	}
	...
],"hints": [
	{
		"name": "spring.jpa.hibernate.ddl-auto",
		"values": [
			{
				"value": "none",
				"description": "Disable DDL handling."
			},
			{
				"value": "validate",
				"description": "Validate the schema, make no changes to the database."
			}
		]
	}
]}

2.properties提示編寫

當然了我們需要編寫META-INF/additional-spring-configuration-metadata.json進行拓展。

下面簡單創建一個starter使用additional-spring-configuration-metadata.json進行提示。

在resources/META-INF目錄下創建additional-spring-configuration-metadata.json

內容大致如下:

{"properties": [
    {
      "name": "swagger.basePackage",
      "type": "java.lang.String",
      "description": "文檔掃描包路徑。"
    },
    {
      "name": "swagger.title",
      "type": "java.lang.String",
      "defaultValue": "平臺系統接口詳情",
      "description": "title 如: 用戶模塊系統接口詳情。"
    },
    {
      "name": "swagger.description",
      "type": "java.lang.String",
      "defaultValue": "在線文檔",
      "description": "服務文件介紹。"
    },
    {
      "name": "swagger.termsOfServiceUrl",
      "type": "java.lang.String",
      "defaultValue": "https://www.test.com/",
      "description": "服務條款網址。"
    },
    {
      "name": "swagger.version",
      "type": "java.lang.String",
      "defaultValue": "V1.0",
      "description": "版本。"
    }
]}

大家參考下面properties表格進行配置上的理解。

deprecation每個properties元素的屬性中包含的JSON對象可以包含以下屬性：

對應的@ConfigurationProperties類如下:

@Data
@ConfigurationProperties(SwaggerProperties.PREFIX)
public class SwaggerProperties {

  public static final String PREFIX = "swagger";

  /**
   * 文檔掃描包路徑
   */
  private String basePackage = "";

  /**
   * title 如: 用戶模塊系統接口詳情
   */
  private String title = "平臺系統接口詳情";

  /**
   * 服務文件介紹
   */
  private String description = "在線文檔";

  /**
   * 服務條款網址
   */
  private String termsOfServiceUrl = "https://www.test.com/";

  /**
   * 版本
   */
  private String version = "V1.0";

}

現在就可以在application.properties文件里嘗試提示。

以上是“springboot之如何使用additional-spring-configuration-metadata.json自定義提示”這篇文章的所有內容，感謝各位的閱讀！希望分享的內容對大家有幫助，更多相關知識，歡迎關注億速云行業資訊頻道！