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

更新時間：2024年01月31日 10:43:12 作者：搏·夢

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

前言

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

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

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

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

先說結論

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

代碼解釋

@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
// 測試代碼
@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

這里不做過多說明

@Bean + @ConfigurationProperties

直接看代碼：

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

// 準備個@Configuration 配置類
@Configuration
public class ConfigurationDemo {
	// 這里將TestConfigDemo 配置類 生成bean對象
    // 此時：TestConfigDemo里面的屬性將與配置文件yml內(nèi)容進行綁定
    @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);
    }
}

在這里插入圖片描述