@EnableConfigurationProperties注解

@EnableConfigurationProperties注解

@EnableConfigurationProperties 注解的作用是:让使用了 @ConfigurationProperties 注解的类生效,并且将该类注入到 IOC 容器中,交由 IOC 容器进行管理

读取配置文件内容，并且将对象注入到 IOC 容器有一下几种方式：

一、使用 @ConfigurationProperties + @Component 注解

① application.yml

ruoyi:
  name: AAA
  age: 12

② RuoyiProperties.java

@Data
@Component
@ConfigurationProperties(prefix = "ruoyi")
public class RuoyiProperties {

    private String name;
    private int age;
    
}

③ 启动类

@SpringBootApplication
public class Application {

    public static void main(String[] args) {

        ConfigurableApplicationContext run = SpringApplication.run(Application.class, args);
        System.out.println(run);
    }

}

④ 测试结果：

通过 @ConfigurationProperties + @Component 注解可以 获取到了配置文件的值，并且这个类也加载到了 IOC 容器了。

二、使用 @ConfigurationProperties + @EnableConfigurationProperties 注解

① application.yml

ruoyi:
  name: AAA
  age: 12

② RuoyiProperties.java

@Data
@ConfigurationProperties(prefix = "ruoyi")
public class RuoyiProperties {

    private String name;
    private int age;

}

③ RuoyiConfig.java

@Configuration
@EnableConfigurationProperties({RuoyiProperties.class})
public class RuoyiConfig {

}

④ 启动类

@SpringBootApplication
public class Application {

    public static void main(String[] args) {

        ConfigurableApplicationContext run = SpringApplication.run(Application.class, args);
        System.out.println(run);
    }

}

⑤ 测试结果：

通过@ConfigurationProperties + @EnableConfigurationProperties 注解 可以获取到了配置文件的值，并且这个类也加载到了 IOC 容器了。

三、使用 @ConfigurationProperties + @Bean注解

① application.yml

ruoyi:
  name: AAA
  age: 12

② RuoyiProperties.java

@Data
@ConfigurationProperties(prefix = "ruoyi")
public class RuoyiProperties {

    private String name;
    private int age;

}

③ RuoyiConfig.java

@Configuration
public class RuoyiConfig {
    @Bean
    public RuoyiProperties ruoyiProperties() {
        return new RuoyiProperties();
    }
}

④ 主启动

@SpringBootApplication
public class Application {

    public static void main(String[] args) {

        ConfigurableApplicationContext run = SpringApplication.run(Application.class, args);
        System.out.println(run);
    }

}

⑤测试结果：

通过@ConfigurationProperties + @Bean 注解 可以获取到了配置文件的值，并且这个类也加载到了 IOC 容器了。

四、总结

• 如果要使 xxx.properties 配置文件与 Java Bean 动态绑定,那么就必须将这个 Java Bean 加入到容器中,并且需要在该类上使用 @ConfigurationProperties 注解

• @EnableConfigurationProperties(A.class)的作用就是如果 A 这个类上使用了 @ConfigurationProperties 注解,那么 A 这个类会与 xxx.properties 进行动态绑定,并且会将 A 这个类加入 IOC 容器中,并交由 IOC 容器进行管理

• 如果一个配置类只配置@ConfigurationProperties注解，而没有使用@Component，那么在IOC容器中是获取不到properties 配置文件转化的bean。但是要是有 @EnableConfigurationProperties 注解的话，也可以实现注入到 IOC 容器，说白了 @EnableConfigurationProperties 相当于把使用 @ConfigurationProperties 的类进行了一次注入。

五、扩展

① application.yml

ruoyi:
  name: AAA
  age: 12

② RuoyiProperties.java

@Data
@Component
@ConfigurationProperties(prefix = "ruoyi")
public class RuoyiProperties {

    private String name;
    private int age;

}

③ RuoyiConfig.java

@Configuration
public class RuoyiConfig {

	// @Bean+方法参数：参数从容器中获取，默认不写 @Autowired 效果是一样的，都能自动从容器中获取
    @Bean
    public Object get(RuoyiProperties ruoyiProperties) {
        return ruoyiProperties;
    }
}

④ 测试类

@SpringBootApplication
public class Application {

    public static void main(String[] args) {

        ConfigurableApplicationContext run = SpringApplication.run(Application.class, args);
        System.out.println(run);
    }

}

⑤ 测试

这里想说明什么问题？@Bean+方法参数：参数从容器中获取，默认不写 @Autowired 效果是一样的，都能自动从容器中获取