Spring Boot DAY03 配置文件的注入

目录

1.配置文件

2.yaml概述

2.1. yaml的语法基础

2.2 yaml文件的注入

 2.3 加载指定的配置文件

3.properties配置

4.对比

---

1.配置文件

SpringBoot使用的是全局配置的文件，配置文件的名称是固定的，分为两类：

• application.properties

  • 语法结构 ：key=value

• application.yaml

  • 语法结构 ：key：空格 value

在spring boot项目中用的最多的配置文件就是properties和yaml了，这两者是可以互用的，但是 YAML 配置是有序的，properties 配置是无序的 ，而且自定义的 YAML 目前暂时不支持使用注解直接注入到 Spring Boot 项目中。

配置文件的作用 ：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下（这个我在DAY01就说过了）

server.port=8081

2.yaml概述

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

这种语言以数据作为中心，而不是以标记语言为重点！

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

传统的xml配置：

<server>
    <port>8081<port>
</server>

yaml配置：

server：
  prot: 8080

2.1. yaml的语法基础

说明：语法要求严格！

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

其实这些语法和python非常的像，包括注释也非常像，下面我们可以看到

字面量：普通的值  [ 数字，布尔值，字符串  ]

字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；

k: v

注意：

• “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；

  比如 ：name: "fbw \n f"   输出 ：fbw  换行   f

• '' 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出

  比如 ：name: ‘fbw \n f’   输出 ：fbw  \n   f

对象、Map（键值对）

#对象、Map格式
k: 
    v1:
    v2:

在下一行来写对象的属性和值得关系，注意缩进(缩进和python完全一样)；比如：

student:
    name: 李白
    age: 3

行内写法：

student: {name: qinjiang,age: 3}

数组（ List、set ）

用 - 值表示数组中的一个元素,比如：

 lists:
    music
    basketball
    girls
    code
    - code

行内写法

lists: [basketball,girls,code]

配置文件占位符

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

people:
  name: 杜甫${random.uuid}
  age: ${random.int}
  single: false
  birth: 2001/1/1
  maps: {k2: v2,k3: v3}
  lists:
    music
    basketball
    girls
    code
    - code
  dog:
    name: 阿黄
    age: 3

2.2 yaml文件的注入

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

1.实体类Dog

package com.example.springboot.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    private String name;
    private int age;

}

如果我们要给Dog类注入属性值，我们在刚开始学Java时，首先会先new一个对象，然后通过set方法来注入属性值，然后我们又学了Spring，可以通过@Value来注入值，下面我们先使用@Value来注入属性值，然后再使用yaml文件注入，这样更能体现出yaml文件的便利性

2.使用Value注解

package com.example.springboot.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component//注册bean到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    @Value("旺财")
    private String name;
    @Value("3")
    private int age;

}

3.测试

package com.example.springboot;

import com.example.springboot.pojo.Dog;
import com.example.springboot.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootApplicationTests {
@Autowired
    Dog dog;
//    Person person;
    @Test
    void contextLoads() {
        System.out.println(dog);
        //System.out.println(person);
    }

}

 结果成功输出，@Value注入成功，当然在属性少的时候用@Value注入也没有那么麻烦，如果实体类的属性多的话，使用@Value就会繁琐了，尤其是和yaml文件注入相比，下面我们再引入一个例子：

1.person类

package com.example.springboot.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;


@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private int age;
    private Boolean single;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

2.编写yaml文件，注意一下，看看语法是不是和python一样

people:
  name: 杜甫${random.uuid}
  age: ${random.int}
  single: false
  birth: 2001/1/1
  maps: {k2: v2,k3: v3}
  lists:
    music
    basketball
    girls
    code
    - code
  dog:
    name: 阿黄
    age: 3

3.把yaml文件注入到实体类中(注意注释中的内容)

package com.example.springboot.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

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

PS:

IDEA会 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖，不引入依赖会报红

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

在pom.xml文件中引入这个依赖就行了

4. 测试

package com.example.springboot;

import com.example.springboot.pojo.Dog;
import com.example.springboot.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringbootApplicationTests {
@Autowired
    //Dog dog;
   Person person;
    @Test
    void contextLoads() {
       // System.out.println(dog);
        System.out.println(person);
    }

}

可以看出成功输出，

可以看出yaml可以减少我们的工作量，也便于维护

 2.3 加载指定的配置文件

其实在学到这时我也想到了如果有多个配置文件要怎么办，怎么选择，然后发现SpringBoot给我们提供了两个注解

@PropertySource ：加载指定的配置文件；（用来指定properties文件）

@configurationProperties：默认从全局配置文件中获取值；(用来指定yaml文件中哪一个下的属性)

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

name=fbw

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

这样就绑定了person.properties文件。

yaml文件的存放路径
1、项目根目录下的config目录中
2、项目根目录下
3、classpath下的config目录中
4、classpath目录下

四个位置中的application.yaml文件的优先级按照上面列出的顺序依次降低。即如果有同一个属性在四个文件中都出现了，以优先级高的为准。

3.properties配置

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

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

settings-->FileEncodings 中配置；

 测试一波:

1.新建user实体类：

@Component //注册bean
public class User {
    private String name;
    private int age;
    private String sex;

//有参、无参构造方法
}

2、编辑配置文件 user.properties

name=fbw
age=18
sex=男

3、我们在User类上使用@Value来进行注入

@Component //注册bean
@PropertySource(value = "classpath:user.properties")//必须要指定路径
public class User {
    //直接使用@value
    @Value("${name}") //从配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表达式 能够拼接
    private int age;
    @Value("男")  // 字面量 spring注入
    private String sex;
}

然后测试可以正常输出。

注意：properties文件使用的话要和@Value注解配合使用

4.对比

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

2、松散绑定：这个什么意思呢? 比如我的yaml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下,也就是说它的容错率比较高

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

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

结论：

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

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

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

yaml要比properties好用多了，学过这个也是学了实体类属性注入的进化史：

从new个对象然后调用set方法--->然后spring的@value注解--->再properties--->yaml,反正是越来越方便了，不知道后来还会有什么方法，尽量继续向后学吧。

明天22就开始考研了，祝他们成功！也希望明年我考研的话，也成功！(不过是真的难啊,22都457w，明年估计要破500w了）

2021/12/24  17:03