@ConfigurationProperties在方法上的使用

1. 前言

1. 在学习spring的时候，@ConfigurationProperties应该经常被使用到，作用在类上的时候，将该类的属性取值 与配置文件绑定，并生成配置bean对象，放入spring容器中，提供给其他地方使用。

2. 在工作中，或者看spring内部代码的时候，无意发现@ConfigurationProperties居然还可以用在方法上,点开@ConfigurationProperties注解的时候，我们发现：

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

3. 似乎平时我们都是用在类上的，因此特意写这篇文章记录一下，记录@ConfigurationProperties的使用方式。

2. 先说结论

1. @ConfigurationProperties无论是使用在类上，或用在方法上，其本质都是将某个配置类的属性值与配置文件application.yml中内容进行绑定。
2. 其使用场景用如下三种：
   1. @ConfigurationProperties + @Component + 在类上使用的场景
   2. @ConfigurationProperties + @EnableConfigurationProperties 在类上使用的场景
   3. @ConfigurationProperties + @Bean 在方法上使用的场景

3. 代码解释

1. @Component + @ConfigurationProperties

1. 在类上使用@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。

2. @EnableConfigurationProperties + @ConfigurationProperties

1. 之前写过这篇博客，这里就不重复写了，大家可以参考这篇 @EnableConfigurationProperties的使用方式以及作用

3. @Bean + @ConfigurationProperties

1. 直接看代码：

   // 该配置类上 无 任何spring的注解
   @Setter
   @ToString
   public class TestConfigDemo {
   
       private String username;
   
       private String pwd;
   }
   

   // 准备个@Configuration 配置类
   @Configuration
   public class ConfigurationDemo {
   
   	// 这里将TestConfigDemo 配置类 生成bean对象
       // 此时：TestConfigDemo里面的属性将与配置文件yml内容进行绑定
       @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);
       }
   }
   

   

2. 看到上述的例子，想必大家内心此时的想法是：@ConfigurationProperties使用在方法上的效果，跟使用在类上的完全没任何区别，只是将@ConfigurationProperties的位置换了一个地方，并无太大区别吧。

3. 但其出现必然有其存在意义：
   个人觉得，其作用就是，如果项目中有个@Configuration这种类的话，可以把config配置类的注解内容等都放入该类中，达到一种配置好管理的效果，之后如果要改什么内容，只要看@Configuration这种类即可，无需到处找。