SpringBoot 中从yml配置文件中读取常用的参数值

Posted 2020-11-26 菜弟弟

SpringBoot现在基本上都是使用application-XXX.yml(生产环境为pro，开发测试环境为dev)来配置项目中的一些配置条件，在springboot中还可以通过从yml文件中将yml中的数据直接读取出来。

 

1.yml文件（这里设置参数的时候往往设置两层前缀，避免在调用的时候该属性中的部分参数名与计算机中的某些名字冲突）

test:
  person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

 

 

2.在JavaBean中读取参数值，并且将读取出来的值赋予到指定的属性上

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "testdemo.person"：配置文件中哪个下面的所有属性进行一一映射(yml文件中的参数名要和JavaBean中的属性名保持一致)
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "testdemo.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;
}

 

 3.pom.xml文件中导入依赖配置（注：这里可能需要启动一下项目，使之生效）

<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

 

 

 

4.@value 注解获取yml配置文件中的数据，以及@Validated进行数据校验

@Component
@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>      * <bean/>
     */

   //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;

 

 

5.@ConfigurationProperties(prefix = "person") 和 @value的区别

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

 

6.总结

 配置文件yml还是properties他们都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；