@ConfigurationProperties使用

創(chuàng)建一個(gè)類，類名上方注解，配置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屬性是配置文件里的前綴，即配置文件中以前綴 + 變量名的形式配置一條記錄，來(lái)對(duì)應(yīng)類中的一個(gè)變量，如下：

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

@ConfigurationProperties特點(diǎn)

寬松綁定

如下配置都是可以被識(shí)別綁定的：

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

支持復(fù)雜屬性類型

支持從配置參數(shù)中解析 durations (持續(xù)時(shí)間)

hello.properties.duration=20s

List 和 Set

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

激活@ConfigurationProperties

通過(guò)@EnableConfigurationProperties

如果一個(gè)配置類只單單用@ConfigurationProperties注解，那么在IOC容器中是獲取不到properties 配置文件轉(zhuǎn)化的bean。我們可以在想要使用該配置類的類上注解@EnableConfigurationProperties，并配置相關(guān)的類，即可拿到該裝配好配置的類了。如下所示：

通過(guò)@ConfigurationPropertiesScan

該注解有點(diǎn)類似與@CompomentScan注解掃描@Compoment注釋的類相似，也是用來(lái)掃描項(xiàng)目中@ConfigurationProperties注解的類，并注入spring容器中。只需將該注解注釋于項(xiàng)目啟動(dòng)類上即可

其實(shí)@ConfigurationProperties更多的作用是將配置文件中的配置與類中變量對(duì)應(yīng)上來(lái)，而上述兩種方式是告訴Spring容器要把這個(gè)有配置特性的Bean在程序啟動(dòng)的時(shí)候給創(chuàng)建出來(lái)。那談到的創(chuàng)建Bean，我們就會(huì)想到Spring創(chuàng)建Bean的各種方式，這些方式的同樣能夠激活@ConfigurationProperties，詳細(xì)請(qǐng)看Spring Boot創(chuàng)建Bean的幾種方式

@ConfigurationProperties與@Value對(duì)比

使用 Spring Boot Configuration Processor 完成自動(dòng)補(bǔ)全

當(dāng)我們?cè)谂渲梦募袑懝俜街С值呐渲玫臅r(shí)候，我們都會(huì)發(fā)現(xiàn)的有自動(dòng)補(bǔ)全配置的一個(gè)功能，那怎么也讓我們自己的配置也實(shí)現(xiàn)這種功能呢？

其實(shí)當(dāng)你用這個(gè)注解的時(shí)候，IDE是會(huì)提示你這一點(diǎn)的，她會(huì)在文件的上方提示你要可以配置自動(dòng)補(bǔ)全的功能：

實(shí)現(xiàn)的方式就是項(xiàng)目導(dǎo)入依賴：

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

然后重新編譯或運(yùn)行項(xiàng)目：

項(xiàng)目會(huì)生產(chǎn)一個(gè)json文件

然后能夠?qū)崿F(xiàn)自動(dòng)提示補(bǔ)全配置項(xiàng)的功能了

到此這篇關(guān)于Java中@ConfigurationProperties實(shí)現(xiàn)自定義配置綁定問(wèn)題分析的文章就介紹到這了,更多相關(guān)@ConfigurationProperties自定義配置綁定內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論