快捷導(dǎo)航

Spring中的@ConfigurationProperties在方法上的使用詳解

更新時(shí)間：2024年01月31日 10:43:12 作者：搏·夢(mèng)

這篇文章主要介紹了Spring中的@ConfigurationProperties在方法上的使用詳解,@ConfigurationProperties應(yīng)該經(jīng)常被使用到,作用在類上的時(shí)候,將該類的屬性取值?與配置文件綁定,并生成配置bean對(duì)象,放入spring容器中,提供給其他地方使用,需要的朋友可以參考下

前言

在學(xué)習(xí)spring的時(shí)候，@ConfigurationProperties應(yīng)該經(jīng)常被使用到，作用在類上的時(shí)候，將該類的屬性取值與配置文件綁定，并生成配置bean對(duì)象，放入spring容器中，提供給其他地方使用。

在工作中，或者看spring內(nèi)部代碼的時(shí)候，無(wú)意發(fā)現(xiàn)@ConfigurationProperties居然還可以用在方法上,點(diǎn)開@ConfigurationProperties注解的時(shí)候，我們發(fā)現(xiàn)：

// targer：可作用在類、方法上
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
}

似乎平時(shí)我們都是用在類上的，因此特意寫這篇文章記錄一下，記錄@ConfigurationProperties的使用方式。

先說(shuō)結(jié)論

@ConfigurationProperties無(wú)論是使用在類上，或用在方法上，其本質(zhì)都是將某個(gè)配置類的屬性值與配置文件application.yml中內(nèi)容進(jìn)行綁定。
其使用場(chǎng)景用如下三種：
- @ConfigurationProperties + @Component + 在類上使用的場(chǎng)景
- @ConfigurationProperties + @EnableConfigurationProperties 在類上使用的場(chǎng)景
- @ConfigurationProperties + @Bean 在方法上使用的場(chǎng)景

代碼解釋

@Component + @ConfigurationProperties

在類上使用@ConfigurationProperties效果：

@Component
@ConfigurationProperties(prefix = "test.config")
@Setter
@ToString
public class TestConfigDemo {
    private String username;
    private String pwd;
}
// yml
test:
  config:
    username: test-config-username
    pwd: test-config-pwd
// 測(cè)試代碼
@Component
public class TestConfigAppRunner implements ApplicationRunner {
    @Autowired
    TestConfigDemo testConfigDemo;
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(testConfigDemo);
    }
}

在這里插入圖片描述

從上述可看出@ConfigurationProperties的作用，而@ConfigurationProperties的使用則是在配置類上需要有set方法、以及是需要@Component。

@EnableConfigurationProperties + @ConfigurationProperties

這里不做過(guò)多說(shuō)明

@Bean + @ConfigurationProperties

直接看代碼：

// 該配置類上 無(wú) 任何spring的注解
@Setter
@ToString
public class TestConfigDemo {
    private String username;
    private String pwd;
}

// 準(zhǔn)備個(gè)@Configuration 配置類
@Configuration
public class ConfigurationDemo {
	// 這里將TestConfigDemo 配置類 生成bean對(duì)象
    // 此時(shí)：TestConfigDemo里面的屬性將與配置文件yml內(nèi)容進(jìn)行綁定
    @Bean
    @ConfigurationProperties(prefix = "test.config")
    public TestConfigDemo testConfigDemo(){
        return new TestConfigDemo();
    }
}

@Component
public class TestConfigAppRunner implements ApplicationRunner {

    @Autowired
    TestConfigDemo testConfigDemo;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(testConfigDemo);
    }
}

在這里插入圖片描述

看到上述的例子，想必大家內(nèi)心此時(shí)的想法是：@ConfigurationProperties使用在方法上的效果，跟使用在類上的完全沒(méi)任何區(qū)別，只是將@ConfigurationProperties的位置換了一個(gè)地方，并無(wú)太大區(qū)別吧。

但其出現(xiàn)必然有其存在意義：個(gè)人覺(jué)得，其作用就是，如果項(xiàng)目中有個(gè)@Configuration這種類的話，可以把config配置類的注解內(nèi)容等都放入該類中，達(dá)到一種配置好管理的效果，之后如果要改什么內(nèi)容，只要看@Configuration這種類即可，無(wú)需到處找。

到此這篇關(guān)于Spring中的@ConfigurationProperties在方法上的使用詳解的文章就介紹到這了,更多相關(guān)@ConfigurationProperties的使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: