springboot之a(chǎn)dditional-spring-configuration-metadata.json自定義提示

簡介

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

官方文章

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

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文件后，在開發(fā)人員的IDE工具使用個人編寫的配置讀取很有效的在application.properties或application.yml文件下完成提示。

使用

1. 元數(shù)據(jù)格式

配置元數(shù)據(jù)文件位于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進行拓展。

下面簡單創(chuàng)建一個starter使用additional-spring-configuration-metadata.json進行提示惰说。

在resources/META-INF目錄下創(chuàng)建additional-spring-configuration-metadata.json

image.png

內(nèi)容大致如下:

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

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

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

對應(yīng)的@ConfigurationProperties類如下:

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

  public static final String PREFIX = "swagger";

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

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

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

  /**
   * 服務(wù)條款網(wǎng)址
   */
  private String termsOfServiceUrl = "https://www.test.com/";

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

}

現(xiàn)在就可以在application.properties文件里嘗試提示效拭。

image.png

總結(jié)

當然了，這個只是實現(xiàn)了簡單的配置提示功能胖秒，其他的功能大家可以再次產(chǎn)考(配置元數(shù)據(jù))文章進行學(xué)習(xí)缎患。

示例代碼地址: swagger-spring-boot