栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

[编程] 手把手教你如何优雅编写自己自定义在SpringCloud中配置参数类

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

[编程] 手把手教你如何优雅编写自己自定义在SpringCloud中配置参数类

一、需求

你是否也想实现在SpringCloud工程的配置文件,比如 application.yaml 文件中可以实现类似代码提示的功能提示自己所自定义的配置参数,包括参数的描述,参数的默认值等信息?如下图:

比方说我们想实现的自定义参数配置效果如下:

二、准备 1. 依赖添加

要让我们自定义好的配置参数在 yaml 文件中能够正常提示,我们需要在工程中添加以下依赖:


    org.springframework.boot
	spring-boot-configuration-processor

2. 编写自定义配置类 
package com.demo.prop;

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


@Data
@ToString
@ConfigurationProperties(prefix = "linmu.prop") // prefix表示该配置类中的配置参数的统一前缀
public class DemoProperties {

    
    private TypeEM type; // 枚举,yaml中会自动提示可选的值

    
    private int maxSize = 1; // 有默认值,maxSize在SpringCloud2.0的yaml文件中对应的配置项是 max-size

    
    private Other other = new Other(); // 参数集合,可以使用内部静态类进行统一管理分类

    @Data
    @ToString
    public static class Other {

        
        private String name;

        
        private Boolean enable = true;

    }

}
3. 构建工程

build 工程后,在工程的 target/classes/META-INF 路径下会生成 spring-configuration-metadata.json,这个文件是支持配置自动提示所必需的。

现在打开工程的yml文件,敲下配置的关键词,即可看到提示。

三、配置类使用 1. 通过注解进行使用

在需要使用到配置参数的类上添加以下注解,然后注入对应的参数类即可。

import org.springframework.boot.context.properties.EnableConfigurationProperties;

@EnableConfigurationProperties({DemoProperties.class})
2. 通过Bean进行使用

如下定义参数的Bean:

@Bean
public DemoProperties demoProperties() {
	return new DemoProperties();
}

在需要使用到的类中注入该参数类即可使用

四、附录

Demo源码工程下载

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/943418.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号