SpringBoot专题学习Part5：配置文件中的值的获取/@ConfigurationProperties和@Value的使用及对比

太过爱你忘了你带给我的痛 2023-07-15 05:55 68阅读 0赞

`@ConfigurationProperties`和`@Value`这两个注解都能获取配置文件中的属性值

那么 它们都是如何使用的 且有什么具体的区别 使用时有什么注意事项呢

**废话不多说 直接进入正题**

两个用于测试的实体类：

public class Dog {
        
        private String name;
        private Integer age;
    }

public class Person {
        
        private String name;
        private Integer age;
        private Boolean isStudent;
        private Date birth;
        private Map<String,Object> maps;
        private List<Object> lists;
        private Dog dog;
    }

用于测试的配置文件：

person.name=张三
    person.age=19
    person.isStudent=true
    person.birth=2020/01/01
    person.maps.k1=v111
    person.maps.k2=v211
    person.lists=pico,tankman
    person.dog.name=dog
    person.dog.age=2

引入配置文件处理器依赖：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
    </dependency>

该依赖用于**生成配置文件的元数据信息**  
能够提供**自动提示和补全功能**

# 方式一：@ConfigurationProperties注解 #

在需要映射的**类的前面**加入@ConfigurationProperties注解  
从而将配置文件中的值映射到该组件中  
目的是告诉SpringBoot该类中所有属性和配置文件中所有属性相关 需要进行**绑定**

该注解里面有个prefix属性：告诉配置文件 要将**哪个属性**下面的所有属性进行一一映射  
该容器必须为Spring的组件才能让Spring进行管理 因此还需加入`@Component`注解

注解加在POJO**类上**使用：

@Component
    @ConfigurationProperties(prefix = "person")
    public class Person {
        
        private String name;
        private Integer age;
        private Boolean isStudent;
        private Date birth;
        private Map<String,Object> maps;
        private List<Object> lists;
        private Dog dog;
    
        ...
    }

开始测试：

@Autowired
    private Person person;
    
    @Test
    void contextLoads() {
        
        System.out.println(person);
    }

![在这里插入图片描述][20200315165817324.png]  
输出成功

# 方式二：@Value注解 #

@Value注解相当于是xml配置文件中的：

value里的值支持三种格式：

*  1、字面量
 *  2、$\{\}从环境变量/配置文件中获取值
 *  3、\#\{\}SPEL表达式

注解加在POJO**类的属性上**使用：

@Component
    public class Person {
        
        @Value("${person.name}")
        private String name;
        @Value("${person.age}")
        private Integer age;
        @Value("${person.isStudent}")
        private Boolean isStudent;
    
        ...
    }

开始测试：

@Autowired
    private Person person;
    
    @Test
    void contextLoads() {
        
        System.out.println(person);
    }

![在这里插入图片描述][20200315170101805.png]  
输出成功

--------------------

## @Value和@ConfigurationProperties两种方式获取值的区别 ##

*  **1、**`@Value`支持SPEL表达式  
    而`@ConfigurationProperties`不支持SPEL表达式
 *  **2、**`@ConfigurationProperties`可以批量注入配置文件中的属性  
    而`@Value`必须一个个指定
 *  **3、**`@ConfigurationProperties`支持松散绑定  
    例：  
    *person.firstName：标准方式  
    person.first-name：(-)短横杠后面的一个字母代表大写  
    person.first\_name：(\_)下划线后面的一个字母也是代表大写  
    PERSON\_FIRST\_NAME：推荐系统属性使用该写法*  
    而`@Value`不支持松散绑定 必须完全严丝合缝
 *  **4、**`@ConfigurationProperties`支持JSR-303数据校验  
    而`@Value`不支持

@ConfigurationProperties(prefix = "person")
    @Validated
    public class Person {
        
        @Email //数据必须为邮箱格式 否则会报错
        private String name;
    
        ...
    }

*  **5、**`@ConfigurationProperties`支持复杂类型封装 例如Map集合  
    而`@Value`不支持 会抛出异常

### 总结： ###

若只是在某个业务逻辑中需要获取一下配置文件中的某个值 就用`@Value`  
若用一个JavaBean(POJO)来映射配置文件 则用`@ConfigurationProperties` 为了一次性注入多个属性值

--------------------

[20200315165817324.png]: /images/20230528/79064e5853b743f7b1ee8351ab5f69de.png
[20200315170101805.png]: /images/20230528/3ec7bbfc1789437293c24c812cd212c1.png