springboot之additional-spring-configuration-metadata.json自定義提示

簡介

additional-spring-configuration-metadata.json、spring-configuration-metadata.json在springboot-starter官方專案或第三方starter專案中隨處可見，那它起的作用是什麼？讓我們一起探討一下。

官方文章

官方一篇文章很詳細講解了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檔案裡嘗試提示。

總結

當然了，這個只是實現了簡單的配置提示功能，其他的功能大家可以再次產考(配置元資料)文章進行學習。

示例程式碼地址: swagger-spring-b