通过@ConfigurationProperties与@EnableConfigurationProperties配合.yaml进行属性注入

￡神魔★判官ぃ 2022-02-28 08:58 215阅读 0赞

# 先说作用： #

@EnableConfigurationProperties注解的作用是：使使用 @ConfigurationProperties 注解的类生效。

## 说明： ##

如果一个配置类只配置\*\*@ConfigurationProperties\*\*注解，而没有使用@Component，那么在IOC容器中是获取不到properties 配置文件转化的bean。说白了 **@EnableConfigurationProperties** 相当于把使用 **@ConfigurationProperties** 的类进行了一次注入。  
测试发现 **@ConfigurationProperties** 与 **@EnableConfigurationProperties** 关系特别大。  
测试证明：  
**@ConfigurationProperties** 与 **@EnableConfigurationProperties** 的关系。  
**@EnableConfigurationProperties** 文档中解释：

> 当@EnableConfigurationProperties注解应用到你的@Configuration时，  
> 任何被@ConfigurationProperties注解的beans将自动被Environment属性配置。  
> 这种风格的配置特别适合与SpringApplication的外部YAML配置进行配合使用。

测试发现：  
1.使用 **@EnableConfigurationProperties** 进行注册

package com.example.demo;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @Component
    /*prefix定义配置文件中属性*/
    @ConfigurationProperties(prefix="local")
    public class ComponentProperties { 
    
        /*host和port属性必须保持与application.properties中的属性一致*/
        private String host;
        private String port;
    
        public void setHost(String host) { 
            this.host = host;
        }
        public void setPort(String port) { 
            this.port = port;
        }
    
        @Override
        public String toString() { 
            return "ComponentProperties [host=" + host + ", port=" + port + "]";
        }
    
    }

自动配置设置:

service.properties.name=my-test-name
    service.properties.ip=192.168.1.1
    service.user=kayle
    service.port=8080

一切正常，但是 **HelloServiceAutoConfiguration** 头部不使用 **@EnableConfigurationProperties**，测访问报错。

2.不使用 @EnableConfigurationProperties 进行注册，使用 @Component 注册

@ConfigurationProperties(prefix = "service.properties")
    @Component
    public class HelloServiceProperties { 
        private static final String SERVICE_NAME = "test-service";
    
        private String msg = SERVICE_NAME;
    
        public String getMsg() { 
            return msg;
        }
    
        public void setMsg(String msg) { 
            this.msg = msg;
        }
    
    }

Controller 不变，一切正常，如果注释掉 @Component 测启动报错。  
由此证明，两种方式都是将被 **@ConfigurationProperties** 修饰的类，加载到 Spring Env 中。

## 总结: ##

@ConfigurationProperties 与 @EnableConfiguration配合使用,后者会使得被前者标记的类扫描,否则的话则则需要在@ConfigurationProperties标记的类上加上@Component 注解,以使得此类被扫描

参考:  
作者：咪雅先森  
链接：[https://www.jianshu.com/p/7f54da1cb2eb][https_www.jianshu.com_p_7f54da1cb2eb]

[https_www.jianshu.com_p_7f54da1cb2eb]: https://www.jianshu.com/p/7f54da1cb2eb