How to define constraints of yml configuration items in Spring boot environment

已于 2022-10-10 17:57:26 修改
阅读量444 收藏
点赞数
分类专栏： Java 文章标签： spring boot yml config
于 2022-01-08 16:55:27 首次发布
知识在分享中升华，思想在交流中沉淀。
本文链接：https://blog.csdn.net/qwfys200/article/details/122382625
版权

  经常使用Spring boot项目的小伙伴们可能会发现，当我们使用spring boot标准组件的配置项的时候，IDE无论是IDEA还是Eclipse都能够给出提示。那么，IDE是怎么知道Spring boot标准组件的配置项的元信息的呢，大家可能会说，IDE自动下载了Spring boot标准组件配置项的元信息，所以能给出提示了。那么，Spring boot标准组件配置项的元信息是以什么样的格式存放的，它放在什么地方呢？今天，我们就一起了解一下。

  根据Spring boot官方文档附件二配置元数据项的介绍，我们可以了解到配置元数据文件位于 META-INF/spring-configuration-metadata.json 下的 jars中，它们使用 JSON 格式，项目归类为“组”或“属性”，附加值提示归类为“提示”。

  接下来，我们创建一个用于演示的项目，项目结构如下：

lwk@harbin:~/Public/project/default/simagou$ tree
.
├── mvnw
├── mvnw.cmd
├── pom.xml
├── README.md
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── qwfys
│   │   │           └── app
│   │   │              └── simagou
│   │   │                  ├── config
│   │   │                  │   ├── SimagouAppConfig.java
│   │   │                  │   ├── SimagouAppProperties.java
│   │   │                  ├── controller
│   │   │                  ├── SimagouApplication.java
│   │   │                  │   ├── HelloController.java
│   │   │                  ├── SimagouApplication.java
│   │   └── resources
│   │       ├── application.yml
│   │       └── META-INF
│   │           ├── additional-spring-configuration-metadata.json
lwk@harbin:~/Public/project/default/simagou$
  • pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.8</version>
        <relativePath/>
    </parent>

    <groupId>com.qwfys.app</groupId>
    <artifactId>simagou</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    
    <name>simagou</name>
    <description>Demo project for Spring Boot</description>
    
    <properties>
        <java.version>1.8</java.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  • SimagouAppProperties
package com.qwfys.app.simagou.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

@Data
@ConfigurationProperties(prefix = SimagouAppProperties.FILE_SERVICE_PREFIX, 
        ignoreUnknownFields = true)
public class SimagouAppProperties {
    public static final String FILE_SERVICE_PREFIX = "simagou.file.service";

    /**
     * 下载
     */
    private Download download;

    /**
     * 上传
     */
    private Upload upload;

    @Data
    public static class Download {
        /**
         * 数据抓取
         */
        private Fetch fetch;

        /**
         * 可供文件下载的资源文件目录
         */
        private String path;
    }

    @Data
    public static class Fetch {
        /**
         * 每次迭代数
         */
        private int recordsOnce = 500;

        /**
         * 最大记录数,取值为0代表不做限制
         */
        private int maxRecords = 0;

        /**
         * 最大列数,取值为0代表不做限制
         */
        private int maxColumns = 0;

        /**
         * 感应数大小
         */
        private ContainerType containerType = ContainerType.TINY;

        public enum ContainerType {

            /**
             * 极小
             */
            TINY(200, "TINY"),

            /**
             * 小
             */
            SMELL(500, "SMELL"),

            /**
             * 中
             */
            MIDDLE(1000, "MIDDLE"),

            /**
             * 大
             */
            BIG(5000, "BIG"),

            /**
             * 极大
             */
            GREAT(10000, "GREAT"),
            ;

            int code;
            String label;

            private ContainerType(int code, String label) {
                this.code = code;
                this.label = label;
            }

            public int getCode() {
                return code;
            }

            public String getLabel() {
                return label;
            }
        }
    }

    @Data
    public static class Upload {
        /**
         * 标签系统可供文件上传的资源文件目录
         */
        private String path;
    }
}
  • LabelAppConfig
package com.qwfys.app.simagou.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SimagouAppConfig {

    @Bean
    public SimagouAppProperties getLabelAppProperties() {
        SimagouAppProperties properties = new SimagouAppProperties();
        properties.setDownload(getDownload());
        properties.setUpload(upload());
        return properties;
    }

    @Bean
    public SimagouAppProperties.Upload upload() {
        SimagouAppProperties.Upload upload = new SimagouAppProperties.Upload();
        return upload;
    }

    @Bean
    public SimagouAppProperties.Fetch getFetch() {
        SimagouAppProperties.Fetch fetch = new SimagouAppProperties.Fetch();
        return fetch;
    }

    @Bean
    public SimagouAppProperties.Download getDownload() {
        SimagouAppProperties.Download download = new SimagouAppProperties.Download();
        download.setFetch(getFetch());
        return download;
    }
}

  这个时候，我们进入项目根目录，执行打包命令:

mvn clean package -Dmaven.test.skip=true

  我们发现在目录target/classes/META-INF/中生成了配置元数据文件spring-configuration-metadata.json。观察后发现，生成的文件中，部分属性项没有默认值提示，属性可选项列表也没有。根据官网文档，缺失的这些内容需要我们手动添加到文件src/main/resources/META-INF/additional-spring-configuration-metadata.json中。接下来，我们就手动补充一些属性项的相关配置信息吧。

  • additional-spring-configuration-metadata.json

src/main/resources/META-INF/additional-spring-configuration-metadata.json

{
  "properties": [
    {
      "name": "simagou.file.service.download.fetch.records-once"
    },
    {
      "name": "simagou.file.service.download.fetch.container-type",
      "defaultValue": "TINY"
    }
  ],
  "hints": [
    {
      "name": "simagou.file.service.download.fetch.records-once",
      "type": "java.lang.Integer",
      "values": [
        {
          "value": 200
        },
        {
          "value": 500
        },
        {
          "value": 1000
        }
      ]
    },
    {
      "name": "simagou.file.service.download.fetch.container-type",
      "values": [
        {
          "value": "TINY",
          "description": "极小"
        },
        {
          "value": "SMELL",
          "description": "小"
        },
        {
          "value": "MIDDLE",
          "description": "中"
        },
        {
          "value": "BIG",
          "description": "大"
        },
        {
          "value": "GREAT",
          "description": "极大"
        }
      ]
    }
  ]
}

  接下来，我们继续用maven命令打包，命令同上，即：

mvn clean package -Dmaven.test.skip=true

  这个时候，我们接着进入目录target/classes/META-INF/打开文件spring-configuration-metadata.json就会看到上面我们手动添加的属性项已经补充到该文件中了，内容如下所示：

  • spring-configuration-metadata.json

target/classes/META-INF/spring-configuration-metadata.json

{
  "groups": [
    {
      "name": "simagou.file.service",
      "type": "com.qwfys.app.simagou.config.SimagouAppProperties",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties"
    },
    {
      "name": "simagou.file.service.download",
      "type": "com.qwfys.app.simagou.config.SimagouAppProperties$Download",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties"
    },
    {
      "name": "simagou.file.service.download.fetch",
      "type": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Download"
    },
    {
      "name": "simagou.file.service.upload",
      "type": "com.qwfys.app.simagou.config.SimagouAppProperties$Upload",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties"
    }
  ],
  "properties": [
    {
      "name": "simagou.file.service.download.fetch.container-type",
      "type": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch$ContainerType",
      "description": "感应数大小",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch",
      "defaultValue": "TINY"
    },
    {
      "name": "simagou.file.service.download.fetch.max-columns",
      "type": "java.lang.Integer",
      "description": "最大列数,取值为0代表不做限制",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch",
      "defaultValue": 0
    },
    {
      "name": "simagou.file.service.download.fetch.max-records",
      "type": "java.lang.Integer",
      "description": "最大记录数,取值为0代表不做限制",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch",
      "defaultValue": 0
    },
    {
      "name": "simagou.file.service.download.fetch.records-once",
      "type": "java.lang.Integer",
      "description": "每次迭代数",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Fetch",
      "defaultValue": 500
    },
    {
      "name": "simagou.file.service.download.path",
      "type": "java.lang.String",
      "description": "可供文件下载的资源文件目录",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Download"
    },
    {
      "name": "simagou.file.service.upload.path",
      "type": "java.lang.String",
      "description": "标签系统可供文件上传的资源文件目录",
      "sourceType": "com.qwfys.app.simagou.config.SimagouAppProperties$Upload"
    }
  ],
  "hints": [
    {
      "name": "simagou.file.service.download.fetch.container-type",
      "values": [
        {
          "value": "TINY",
          "description": "极小"
        },
        {
          "value": "SMELL",
          "description": "小"
        },
        {
          "value": "MIDDLE",
          "description": "中"
        },
        {
          "value": "BIG",
          "description": "大"
        },
        {
          "value": "GREAT",
          "description": "极大"
        }
      ]
    },
    {
      "name": "simagou.file.service.download.fetch.records-once",
      "values": [
        {
          "value": 200
        },
        {
          "value": 500
        },
        {
          "value": 1000
        }
      ]
    }
  ]
}

  这个时候IDE根据项目类路径目录就会探测到刚刚生成的文件spring-configuration-metadata.json，进而就可以在我们编辑application.properties或者application.yml的时候给出提示。

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

  • application.yml
simagou:
  file:
    service:
      download:
        fetch:
          records-once: 200
          max-records: 100000
          max-columns: 200
        path: ${user.home}/.app/label/download
      upload:
        path: ${user.home}/.app/label/upload
  • HelloController
package com.qwfys.app.simagou.controller;

import com.qwfys.app.simagou.config.LabelAppProperties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.RestController;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/hello")
public class HelloController {
    private static final Logger logger = LoggerFactory.getLogger(HelloController.class);

    @Autowired
    private LabelAppProperties labelAppProperties;

    @GetMapping("/index")
    public String sayHello() {
        final LabelAppProperties.Fetch fetch = labelAppProperties.getDownload().getFetch();
        final int maxRecords = fetch.getMaxRecords();
		logger.info("maxRecords:{}",maxRecords)
		return "Hello,Welcome to Hangzhou!"
    }
}

  怎么样，是不是很简单呢？

qwfys200
关注
专栏目录
Spring Boot入门教程(四):配置文件
人不风流枉少年
03-20 4067
配置方式 每个starter都有自己默认的配置，如果需要改变默认值，可以在其他地方配置来覆盖掉默认的值，覆盖默认的配置有多种方式，每种方式的优先级也不同，如果在多个地方配置则优先使用优先级高的值，其中命令行参数优先级最高, 其中大部分参数一般都配置在属性文件application.properties中，属性文件即可以覆盖starter中默认的值，也可以自定义值 在命令行行输入的参数 SPR...
Spring Boot学习总结（8）——SpringBoot Common application properties（application.properties）详解
科技D人生
05-05 3632
各种属性可以在您的application.properties/application.yml文件或命令行开关指定。下面提供了常见的Spring启动属性和引用它们的基础类的列表。 # =================================================================== # COMMON SPRING BOOT PROPERTIES # # T
SpringBoot——2.自动装配&&实用工具&&yaml
weixin_45483328的博客
05-14 612
文章目录1.自动装配1.1 @Configuration、@Bean1.2 @ComponentScan、@import1.3 @Conditional1.4 @ImportResource1.5 @ConfigurationProperties1.6 配置小结2.实用工具2.1 Lombok2.2 Developer-Tools2.3 Spring Initializr3. yaml配置文件4.1 yaml使用4.2 数据类型4.3 yaml文件自动提示 1.自动装配 1.1 @Configuration
spring配置yml提示
qq_36022463的博客
09-08 202
导入依赖 spring-boot-configuration-processor <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</op.
springboot配置yml代码提示
qq_53876295的博客
04-23 578
springboot配置yml代码提示
【springboot】yaml文件配置提示
王佑辉的博客
01-04 705
springboot yaml文件配置提示。
spring boot自定义配置时在yml文件输入有提示
一寸一寸光阴
10-11 630
自定义一个配置类，然后在yml文件具体配置值时，一般不会有提示，这个解决这个问题。重新build一下加入依赖所在的项目。重新刷一下Pom依赖。
如何用python批量生成变量/数组 How to define a batch of regular variables in python
jiaoyiru的博客
09-24 4438
【问题情境 Situation】 现在需要生成一系列数组变量形如a_1=[], a_2=[], a_3=[], ... , a_n=[]，之所以不能用二维数组是因为这些list的长度在之后使用过程中并不相同，index也不一致，不方便计算 Assuming a series of variables like a_1=[], a_2=[], a_3=[], ... , a_n=[] need ...
Java-The maximum number of Cell Styles was exceeded. You can define up to 64000 style in a .xlsx
zym_1321的博客
07-06 4338
java.lang.IllegalStateException: The maximum number of Cell Styles was exceeded. You can define up to 64000 style in a .xlsx Workbook
spring boot 项目 启动正常 但是用maven 打包jar后 在cmd 启动报错。
weixin_42700493的博客
01-23 8405
java环境 spring boot 2.0.4.RELEASE jdk 1.8 编码 UTF-8  spring-cloud.version Finchley.RELEASE; 经测试 把对应的 poi 文件导入导出的文件和引入jar删除了就可以了，不删的话只能在 工具中重启不能打成jar  以下是报错信息： 2019-01-23 11:17:02.224 [main] INFO  c.n...
Spring Boot2.1.6学习笔记：元数据文件（properties|yml文件自动提示）
OceanSky的专栏
12-28 1128
参考： https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/html/configuration-metadata.html#configuration-metadata-annotation-processor Spring Boot Jars包含元数据文件，这些文件提供了所有支持的配置属性的详细信息。这些文件旨在让I...
idea SpringBoot yml文件没有提示
qq_42982633的博客
05-11 1147
前两天学者别的技术博主吧idea一些不用插件给禁用了结果这几天yml文件没有提示让我很是难受 百度说要安装Sring Assistant插件结果装上直接报错 解决： 别乱删插件都装回去就好了
IDEA-SpringBoot项目yml配置文件不自动提示解决办法
最新发布
qq_45344586的博客
05-10 2371
本文为SpringBoot项目配置文件.yaml/.yml文件编写时没有自动提示的解决方案
springboot基础(61):如何开启yml提示功能
不积跬步，无以至千里
08-02 1946
自己定义的starter，配置yml文件时没有提示，如何增加提供功能？demo以ip-spring-boot-starter为例。
学习小妙招：springboot中配置文件属性提示
qq_42807952的博客
07-23 492
出现这样的问题不是sprintboot带来的，是我们的IDEA的小bug。当然我的配置文件名字也有问题，最好设置为application.yml。当我们在springboot的配置类文件.yml文件中进行配置时候，发现我们配置属性时属性提示不出来。5.保存后回来发现改文件名的小图标变成了spring的小绿叶图标，命令提示也出来了，成功！4.点击这个+号，进入这个Files选择resource下的文件5.导致了我们很难进行有效的配置，浪费很多的时间，效率大大的降低了。解决这个bug，重新找回咱们的提示！
SpringBoot学习_day7
奋斗的龙猫的博客
09-04 444
自定义starter 统计ip的访问次数 springboot项目开启yml提示功能
idea中yml文件没有提示解决办法
zdgdq的专栏
01-27 2283
两步解决yml文件不显示提示，yaml文件显示提示问题 1、在插件中心，先下载下图两个插件 2、在Editor=》File Types新增文件类型，文件名匹配规则需要将yaml和yml的都加上，加好之后，重启idea，即刻生效。
springboot配置自动提示
qq_42682999的博客
03-01 670
springboot配置自动提示添加依赖打包排除依赖 添加依赖 下面展示一些 内联代码片。 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional>
idea springbot 配置文件yml或properties无提示解决方案
OceanSky的专栏
04-19 9211
最近使用idea开发springboot项目经常遇到yml或properties配置文件图标变为非绿叶无任何自动提示，这样用起来不舒服；尝试了很多种解决方案都无效，今天找到了一种有效的解决方案，分享给大家； 一、看下yml配置文件非绿叶示例图 上图中的这种文件是无自动化提示； 二、解决方案，选择File->Project Structure 选中Configuration Files点击下面的小绿叶图标： 最后点击弹框左下角的＋号选择需要的yml或者properties配置文件，然后点击.
in Unity 2D, how to define a string?
05-25
In Unity 2D, you can define a string by declaring a variable of type string. Here's an example: ```csharp string myString = "Hello World!"; ``` In this example, we're declaring a variable called `...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

qwfys200

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值