Java中@ConfigurationProperties实现自定义配置绑定问题分析

 更新时间:2021年08月23日 10:01:15   作者:Acelin_H''''s Blog  
这篇文章主要介绍了@ConfigurationProperties实现自定义配置绑定问题,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

@ConfigurationProperties使用

创建一个类,类名上方注解,配置prefix属性,如下代码:

@ConfigurationProperties(
        prefix = "hello.properties"
)
public class MyProperties {

    private String myKey;
    private List<String> stringList;
    private Duration duration;

    public String getMyKey() {
        return myKey;
    }

    public void setMyKey(String myKey) {
        this.myKey = myKey;
    }

    public List<String> getStringList() {
        return stringList;
    }

    public void setStringList(List<String> stringList) {
        this.stringList = stringList;
    }

    public Duration getDuration() {
        return duration;
    }

    public void setDuration(Duration duration) {
        this.duration = duration;
    }

    @Override
    public String toString() {
        return "MyProperties{" +
                "myKey='" + myKey + '\'' +
                ", stringList=" + stringList +
                ", duration=" + duration +
                '}';
    }
}

prefix属性是配置文件里的前缀,即配置文件中以前缀 + 变量名的形式配置一条记录,来对应类中的一个变量,如下:

hello.properties.myKey=hello
hello.properties.duration=20s
hello.properties.string-list[0]=Acelin
hello.properties.string-list[1]=nice

@ConfigurationProperties特点

宽松绑定

如下配置都是可以被识别绑定的:

hello.properties.myKey=hello
hello.properties.mykey=hello
hello.properties.my-key=hello
hello.properties.my_key=hello
hello.properties.MY_KEY=hello
hello.properties.MY-KEY=hello

支持复杂属性类型

支持从配置参数中解析 durations (持续时间)

hello.properties.duration=20s

List 和 Set

hello.properties.string-list[0]=Acelin
hello.properties.string-list[1]=nice

激活@ConfigurationProperties

通过@EnableConfigurationProperties

如果一个配置类只单单用@ConfigurationProperties注解,那么在IOC容器中是获取不到properties 配置文件转化的bean。我们可以在想要使用该配置类的类上注解@EnableConfigurationProperties,并配置相关的类,即可拿到该装配好配置的类了。如下所示:

通过@ConfigurationPropertiesScan

该注解有点类似与@CompomentScan注解扫描@Compoment注释的类相似,也是用来扫描项目中@ConfigurationProperties注解的类,并注入spring容器中。只需将该注解注释于项目启动类上即可

其实@ConfigurationProperties更多的作用是将配置文件中的配置与类中变量对应上来,而上述两种方式是告诉Spring容器要把这个有配置特性的Bean在程序启动的时候给创建出来。那谈到的创建Bean,我们就会想到Spring创建Bean的各种方式,这些方式的同样能够激活@ConfigurationProperties,详细请看Spring Boot创建Bean的几种方式

@ConfigurationProperties与@Value对比

- @ConfigurationProperties @Value
功能 批量注入配置文件中的属性 一个个指定
松散绑定(松散语法) 支持 不支持
SpEL 不支持 支持
JSR303数据效验 支持 不支持
复杂类型封装 支持

使用 Spring Boot Configuration Processor 完成自动补全

当我们在配置文件中写官方支持的配置的时候,我们都会发现的有自动补全配置的一个功能,那怎么也让我们自己的配置也实现这种功能呢?

其实当你用这个注解的时候,IDE是会提示你这一点的,她会在文件的上方提示你要可以配置自动补全的功能:

实现的方式就是项目导入依赖:

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

然后重新编译或运行项目:

项目会生产一个json文件

然后能够实现自动提示补全配置项的功能了

到此这篇关于Java中@ConfigurationProperties实现自定义配置绑定问题分析的文章就介绍到这了,更多相关@ConfigurationProperties自定义配置绑定内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringCloud 中使用 Ribbon的方法详解

    SpringCloud 中使用 Ribbon的方法详解

    本文重点给大家介绍SpringCloud 中使用 Ribbon的方法,本文通过实例文字相结合的形式给大家介绍的非常详细,需要的朋友可以参考下
    2018-10-10
  • 解决IDEA2021版compiler.automake.allow.when.app.running不存在的问题

    解决IDEA2021版compiler.automake.allow.when.app.running不存在的问题

    很多文章介绍IntelliJ IDEA开启热部署功能都会写到在IntelliJ IDEA中的注册表中开启compiler.automake.allow.when.app.running选项,此选项在IntelliJ IDEA 2021.2之后的版本迁移到高级设置中,下面看下设置方法
    2021-09-09
  • Java中对于双属性枚举的使用案例

    Java中对于双属性枚举的使用案例

    今天小编就为大家分享一篇关于Java中对于双属性枚举的使用案例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Java 递归重难点分析详解与练习

    Java 递归重难点分析详解与练习

    一说起递归,我想每个人都不陌生。举个从小就听过的例子:从前有座山,山里有座庙,庙里有个和尚,和尚在讲故事,从前有座山,山里有座庙,庙里有个和尚,和尚在讲故事,从前有座山,要理解递归,就得先了解什么是递归,实际上这句话就是一个递归
    2021-11-11
  • 深入剖析Java之String字符串

    深入剖析Java之String字符串

    这篇文章主要为大家详细介绍了Java之String字符串,重新带大家认识String字符串,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • spring boot整合mybatis使用c3p0数据源连接mysql

    spring boot整合mybatis使用c3p0数据源连接mysql

    这篇文章主要为大家详细介绍了spring boot整合mybatis使用c3p0数据源连接mysql,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 分布式事务CAP两阶段提交及三阶段提交详解

    分布式事务CAP两阶段提交及三阶段提交详解

    这篇文章主要为大家介绍了分布式事务CAP、两阶段提交及三阶段提交的内容详解有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-01-01
  • 优化Java内存管理来防止“GC”错误的方法详解

    优化Java内存管理来防止“GC”错误的方法详解

    垃圾回收(GC)是 Java 中的一个重要机制,它可以管理内存并回收不再使用的对象所占用的资源,在本文中,我们将探讨一些技巧,帮助您避免这一错误,确保您的 Java 应用程序顺利运行,需要的朋友可以参考下
    2023-11-11
  • java中表示一个文件的File类型详解

    java中表示一个文件的File类型详解

    Java提供File类,让我们对文件进行操作,下面这篇文章主要给大家介绍了关于java中表示一个文件的File类型的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧
    2018-07-07
  • Java输入输出流方式(文件的复制)

    Java输入输出流方式(文件的复制)

    Java中的输入输出流主要用于数据的读取和写入,在文件复制中,我们首先创建输入流和输出流对象,然后打开源文件和目标文件,接着,通过循环读取源文件中的数据,并将其写入目标文件中,最后,关闭输入输出流以释放资源
    2025-02-02

最新评论