程序员社区

@ConfigurationProperties注解将配置文件值注入到Java Bean


       我们已经知道 Spring Boot 中使用的是.properties.yml 两个格式的配置文件。下面就来介绍:Spring Boot 配置文件中的值,如何注入到我们自定义的 Java Bean 中。(或者:Java Bean 如何获取配置文件中的值来注入)

       本文分别以 ymlproperties 两个格式的配置文件,来介绍如何将配置内容注入到 Java Bean类呢?如下分别为 Java Bean类,继续往下看↓↓↓↓↓

JavaBean类

1.Person类

public class Person {
   

    private String name;

    private int age;

    private boolean isManager;

    private Date birthday;

    private Map<String,Object> map;

    private List<String> list;

    private Address address;

    /** * 此处省略get/set/toString() 方法 */
}

2.Address类

public class Address {
   

    private String province;

    private String distinct;

    private String county;

    /** * 此处省略get/set/toString() 方法 */
 }

1.yml 配置文件值注入

application.yml配置文件:

person:
  name: 扛麻袋的少年
  age: 27
  isManager: true
  birthday: 2020-03-27
  map:
    k1: v1
    k2: v2
  list:
    - basketball
    - tennis
    - swim
  address:
    province: 山西省
    distinct: 晋中市
    county: 祁县

步骤:

  1. 在Java Bean 类上,添加@Component注解。
  2. 同时,再添加 @ConfigurationProperties(prefix = “person”)注解;
  3. 在 pom.xml 中,导入配置文件处理器依赖。以后编写ymlproperties配置文件,这些配置项就会有相对应的提示了。
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

解析:

  1. 添加@Component注解。切记:只有这个组件是容器中的组件,才能使用容器提供的@ConfigurationProperties注解功能;
  2. @ConfigurationProperties 注解:它会告诉 Spring Boot 将本类中的所有属性和配置文件中相关的配置进行绑定;prefix = "person":告诉 Spring Boot 应该读取配置文件中哪个下面的所有属性进行一一映射;
  3. 添加 Maven 依赖。

具体配置如图:
在这里插入图片描述
测试:
        我们在SpringBoot为我们提供的测试类中进行测试,查看配置文件内容是否已经成功注入到我们自定义的 Person 类中。如下图所示,我们可以看到它已经帮我们注入到了 Person 类中。
在这里插入图片描述


2.properties 配置文件值注入

       你会看到,我们在导入配置文件处理器后,配置文件进行绑定就会有相对应的提示了。接下来我们编写 properties 类型配置文件,来完成 peoperties 文件值得注入。
在这里插入图片描述
        如下是一些 properties 类型yml 类型编写上的一些区别。properties 配置文件值的注入部分,和 yml 配置文件值得注入步骤一模一样,该加的注解、maven依赖都得一个不落的加上。
在这里插入图片描述
测试:
在这里插入图片描述
乱码解决:

      Setting------Editor------File Encodings 中,进行解决。如下图所示↓↓↓↓↓
在这里插入图片描述
优先级测试:yml 和 properties 两种同时写,没人会这么干的,哈哈
在这里插入图片描述


博主写作不易,来个关注呗

求关注、求点赞,加个关注不迷路 ヾ(◍°∇°◍)ノ゙

博主不能保证写的所有知识点都正确,但是能保证纯手敲,错误也请指出,望轻喷 Thanks♪(・ω・)ノ

赞(0) 打赏
未经允许不得转载:IDEA激活码 » @ConfigurationProperties注解将配置文件值注入到Java Bean

一个分享Java & Python知识的社区