SpringBoot注入配置文件

yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

1.yaml注入配置文件

1. 在springboot项目中的resources目录下新建一个文件 application.yaml

2. 编写一个实体类 Dog；

   package nuc.ss.pojo;
   
   @Component  //注册bean到容器中
   public class Dog {
       private String name;
       private Integer age;
       
       //有参无参构造、get、set方法、toString()方法  
   }
   

3. 思考，我们原来是如何给bean注入属性值的！@Value，给狗狗类测试一下：

   @Component //注册bean
   public class Dog {
       @Value("旺财")
       private String name;
       @Value("3")
       private Integer age;
   }
   

4. 在SpringBoot的测试类下注入狗狗输出一下；

   @SpringBootTest
   class Springboot02ConfigApplicationTests {
   
       @Autowired
       private Dog dog;
   
       @Test
       void contextLoads() {
           System.out.println(dog);
       }
   
   }
   
   

   结果成功输出，@Value注入成功，这是我们原来的办法对吧。

5. 我们在编写一个复杂一点的实体类：Person 类

   @Component //注册bean到容器中
   public class Person {
       private String name;
       private Integer age;
       private Boolean happy;
       private Date birth;
       private Map<String,Object> maps;
       private List<Object> lists;
       private Dog dog;
       
       //有参无参构造、get、set方法、toString()方法  
   }
   

6. 我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！

   person:
     name: qinjiang
     age: 3
     happy: false
     birth: 2000/01/01
     maps: {k1: v1,k2: v2}
     lists:
      - code
      - girl
      - music
     dog:
       name: 旺财
       age: 1
   

7. 我们刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！

   /*
   @ConfigurationProperties作用：
   将配置文件中配置的每一个属性的值，映射到这个组件中；
   告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
   参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
   */
   @Component
   @ConfigurationProperties(prefix = "person")
   public class Person {
       private String name;
       private Integer age;
       private Boolean happy;
       private Date birth;
       private Map<String,Object> maps;
       private List<Object> lists;
       private Dog dog;
   
       //有参无参构造、get、set方法、toString()方法
   }
   
   

8. IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！

   • 在pom中导入依赖

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

9. 确认以上配置都OK之后，我们去测试类中测试一下：

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

   结果：所有值全部注入成功！

yaml配置注入到实体类完全OK！

2.加载指定的配置文件

• **@PropertySource ：**加载指定的配置文件；
• @configurationProperties：默认从全局配置文件中获取值；

1. 我们去在resources目录下新建一个person.properties文件

   name=xiaoyu
   

2. 然后在我们的代码中指定加载person.properties文件

   @PropertySource(value = "classpath:person.properties")
   @Component //注册bean
   public class Person {
   
       @Value("${name}")
       private String name;
   
       ......  
   }
   

3. 再次输出测试一下：指定配置文件绑定成功！

3.配置文件占位符

配置文件还可以编写占位符生成随机数

person:
  name: huangkaiyu${random.uuid}
  age: ${random.int}
  happy: false
  birth: 2000/10/26
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - music
    - girl
  dog:
    name: ${person.hell:hello}_修勾
    age: 3

4.回顾properties配置

• 我们上面采用的yaml方法都是最简单的方式，开发中最常用的；
• 也是springboot所推荐的！
• 那我们来唠唠其他的实现方式，道理都是相同的；写还是那样写；配置文件除了yml还有我们之前常用的properties ， 我们没有讲，我们来唠唠！

【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；settings–>FileEncodings 中配置；

5.对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

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

1. @ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加

2. 松散绑定： yml中写的last-name实际对应的是lastName：符号 —后面跟着的字母默认是大写的。这就是松散绑定。
   

3. JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性

4. 复杂类型封装，yml中可以封装对象 ， 使用value就不支持

结论：

配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接**@configurationProperties**，不要犹豫！