Spring Boot配置文件值的注入方式

小鱼儿 2021-10-14 22:59 381阅读 0赞

本文是探讨spring boot的配置文件中的值注入到JavaBean的两种方式，在Spring Boot整合各种组间的过程中，底层就是会用到这种注入方式来简化配置文件，往往只需我们在配置文件中配置少许内容，springboot就会自动读取该值从而达到简化配置的目的。

### 1.@ConfigurationProperties注入 ###

下面我们看如何将下面的配置文件中的值映射到实体类中：

persion.last-name=张三
    persion.age=12
    persion.boss=false
    persion.birth=2018-12-12
    persion,maps.key1=value1
    persion.maps.keyword=sjdks
    persion.lists=a,b,c,d
    persion.dog.name=dog
    persion.dog.age=5

配置文件中包含了一般数据类型外还包含了list、map、和对象，如何将这些值映射给下面的persion类呢？

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

其中Dog是个对象，旨在演示配置文件如何映射一个对象。  
将配置文件中配置的每一个属性的值，映射到这个组件中  
@ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；  
prefix = “person”：配置文件中哪个下面的所有属性进行一一映射  
只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；所以在该类上加了@Component注解，将其加入容器中。

### 2.@value("")注入 ###

还有一种方式可实现配置文件值的注入，我们来看下面的代码：

@Component
    public class Person {
    @value("${persion.last-name}")
    private String lastName;
    @Value("#{11*2"})
    private Integer age;
    @Value("true")
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    }

这种注入方式就和我们以前写标签形式注入的原理一致

就像上面一样，@Value注解可以给类的属性逐一添加属性，value的值可以是自变量，可以从配置文件中读取，还可以定义表达式。

### 3.两种方式的差异 ###

那@ConfigurationProperties注解和@Value两种注入方式有什么不同呢？下面是他们的区别：

区别点 @ConfigurationProperties @Value  
功能 批量注入 配置文件中的属性 一个个指定  
松散绑定（松散语法） 支持 不支持  
SpEL 不支持 支持  
JSR303数据校验 支持 不支持  
复杂类型封装 支持 不支持

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；  
如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

### 4.注入数据校验 ###

@Component
    @ConfigurationProperties(prefix = "person")
    @Validated
    public class Person {
    //lastName必须是邮箱格式
    @Email
    //@Value("${person.last‐name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

如上代码，在给lastName属性注入值的同时校验该值是否为Email格式，在字段上加@Email注解  
这时采用@Value()注解注入是行不通的，@Email注解不会起作用，即起不到校验的作用。  
采用第一种方式可搭配@Email注解一起使用。

### 5.其他注入注解 ###

#### 1.@PropertySource：加载指定的配置文件 ####

@PropertySource(value = {"classpath:person.properties"})
    @Component
    @ConfigurationProperties(prefix = "person")
    public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;

#### 2.@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效 ####

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；  
想让Spring的配置文件生效，加载进来需要将@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})
    导入Spring的配置文件让其生效