Springboot之additional-spring-configuration-metadata.json自定义提示

迷南。 2021-06-10 20:39 423阅读 0赞

### 简介 ###

`additional-spring-configuration-metadata.json`、`spring-configuration-metadata.json`在`springboot-starter`官方项目或第三方`starter`项目中随处可见，那它起的作用是什么？让我们一起探讨一下。

> 官方文章

官方一篇文章很详细讲解了`Configuration Metadata`的作用。  
有兴趣的小伙伴可以查看下([配置元数据][Link 1])。

> 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`

![image.png][]

内容大致如下:

{"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`表格进行配置上的理解。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>目的</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>属性的全名。名称采用小写的周期分隔形式(例如server.address)。此属性是强制性的。</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>String</td> 
   <td>属性的数据类型的完整签名（例如java.lang.String），但也是完整的泛型类型（例如java.util.Map&lt;java.util.String,acme.MyEnum&gt;）。您可以使用此属性来指导用户可以输入的值的类型。为了保持一致性，通过使用其包装对应项（例如，boolean变为java.lang.Boolean）来指定基元的类型。请注意，此类可能是一个复杂类型，它从Stringas绑定的值转换而来。如果类型未知，则可以省略。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>可以向用户显示的组的简短描述。如果没有可用的描述，则可以省略。建议描述为简短段落，第一行提供简明摘要。描述中的最后一行应以句点（.）结尾。</td> 
  </tr> 
  <tr> 
   <td>sourceType</td> 
   <td>String</td> 
   <td>贡献此属性的源的类名称。例如，如果属性来自带注释的类@ConfigurationProperties，则此属性将包含该类的完全限定名称。如果源类型未知，则可以省略。</td> 
  </tr> 
  <tr> 
   <td>defaultValue</td> 
   <td>Object</td> 
   <td>默认值，如果未指定属性，则使用该值。如果属性的类型是数组，则它可以是值数组。如果默认值未知，则可以省略。</td> 
  </tr> 
 </tbody> 
</table>

`deprecation`每个`properties`元素的属性中包含的JSON对象可以包含以下属性：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>目的</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>level</td> 
   <td>String</td> 
   <td>弃用级别，可以是warning（默认）或error。当属性具有warning弃用级别时，它仍应绑定在环境中。但是，当它具有error弃用级别时，该属性不再受管理且不受约束。</td> 
  </tr> 
  <tr> 
   <td>reason</td> 
   <td>String</td> 
   <td>该属性被弃用的原因的简短描述。如果没有可用的原因，可以省略。建议描述为简短段落，第一行提供简明摘要。描述中的最后一行应以句点（.）结尾。</td> 
  </tr> 
  <tr> 
   <td>replacement</td> 
   <td>String</td> 
   <td>替换此不推荐使用的属性的属性的全名。如果此属性没有替换，则可以省略。</td> 
  </tr> 
 </tbody> 
</table>

对应的`@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`文件里尝试提示。  
![image.png][image.png 1]

SpringBoot的配置文件，IDE会读取spring-configuration-metadata.json来提示，自定义Start中，配置类属性可以通过下面的依赖进行编译生成。

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <optional>true</optional>
            </dependency>

## ##

### 总结 ###

当然了，这个只是实现了简单的配置提示功能，其他的功能大家可以再次产考([配置元数据][Link 1])文章进行学习。

> 示例代码地址:  [swagger-spring-boot][]

[Link 1]: https://docs.spring.io/spring-boot/docs/2.1.7.RELEASE/reference/html/configuration-metadata.html#configuration-metadata-format
[image.png]: /images/20210527/f96ff208c1df42f38ba4b0647c3b926d.png
[image.png 1]: /images/20210527/bd1720b7f4cc4774a462c64442cf8754.png
[swagger-spring-boot]: https://github.com/purgeteam/swagger-spring-boot