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

这篇文章主要介绍了@ConfigurationProperties实现自定义配置绑定问题，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

@ConfigurationProperties使用

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

@ConfigurationProperties( prefix = "hello.properties" ) public class MyProperties { private String myKey; private List stringList; private Duration duration; public String getMyKey() { return myKey; } public void setMyKey(String myKey) { this.myKey = myKey; } public List getStringList() { return stringList; } public void setStringList(List 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=20sList 和 Sethello.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的几种方式