SpringBoot源码学习之路（二、配置文件与相关使用注解）

浅浅的花香味﹌ 2022-05-19 04:42 184阅读 0赞

# 配置文件 #

## 一、配置文件 ##

> SpringBoot使用一个全局的配置文件，配置文件名是固定的；  
> application.properties  
> application.yml  
> 配置文件的作用：修改SpringBoot自动配置的默认值。  
> YAML：**以数据为中心**，比Json、XML等更适合做配置文件。

--------------------

## 二、YAML语法 ##

### 1、基本语法 ###

k:(空格)v：表示一对键值对（空格必须有）；

以**空格**的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
        port: 8081
        path: /hello

属性和值也是大小写敏感；

### 2、值的写法 ###

#### 字面量：普通的值（数字，字符串，布尔） ####

字符串**默认**不用加上单引号或者双引号。  
name:zhangsan  
**”“：双引号**；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思。  
name: “zhangsan \\n lisi”：输出；zhangsan 换行 lisi  
**”：单引号**；会转义特殊字符，特殊字符最终只是一个普通的字符串数据。  
name: ‘zhangsan \\n lisi’：输出；zhangsan \\n lisi

#### 对象、Map（属性和值）（键值对）： ####

k: v：在下一行来写对象的属性和值的关系；注意缩进

对象还是k: v的方式

friends:
            lastName: zhangsan
            age: 20

行内写法：

friends: { lastName: zhangsan,age: 18}

#### 数组（List、Set）： ####

用- 值表示数组中的一个元素

pets:
     - cat  - dog  - pig

行内写法

pets: [cat,dog,pig]

--------------------

## 三、配置文件值注入 ##

#### 1.如何将配置文件中配置的每一个属性的值，映射到这个JavaBean中? ####

**实现方式一：**  
配置文件：

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

JavaBean:

/** * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定； * prefix = "person"：配置文件中哪个前缀下面的所有属性进行一一映射 * @Component:只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能； */
    @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;

> 提示：我们可以导入配置文件处理器，以后编写配置就有提示了.相当于如果实体类已经定义好了，当在配置文件中定义该类时，key会有自动提示！

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

**实现方式二：**  
用**@Value**注解也能实现初始化时获取配置文件中定义的值

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

#### 2.@Value获取值和@ConfigurationProperties获取值的比较（配置文件yml还是properties他们都能获取到值） ####

<table> 
 <thead> 
  <tr> 
   <th>@ConfigurationProperties</th> 
   <th>@Value</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>功能</td> 
   <td>批量注入配置文件中的属性</td> 
  </tr> 
  <tr> 
   <td>松散绑定（松散语法）</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>SpEL</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>JSR303数据校验</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>复杂类型封装</td> 
   <td>支持</td> 
  </tr> 
 </tbody> 
</table>

**对于这两种方式我们使用上该如何做选择呢？**  
如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；  
如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

#### 3、配置文件注入值数据校验 ####

@Component
    @ConfigurationProperties(prefix = "person")
    @Validated//表明需要校验
    public class Person { 
        //lastName必须是邮箱格式
        @Email
        private String lastName;

#### 4、@PropertySource 、 @ImportResource 、 @Bean注解分析 ####

**注解一：@PropertySource 加载指定的配置文件**

/** *相当于从【classpath:person.properties】配置文件中获取前缀为【person】的属性值 */
    
    @Component
    @PropertySource(value = {
       "classpath:person.properties"})
    @ConfigurationProperties(prefix = "person")
    public class Person { 
        private String lastName;
        private Integer age;

**注解二：@ImportResource ： 导入Spring的配置文件，让配置文件里面的内容生效**（不推荐）  
Spring Boot里面没有Spring的配置文件（.xml），我们自己编写的配置文件，也不能自动识别；  
想让Spring的配置文件生效，加载进来；需要将@**ImportResource**标注在一个启动类上

bean.xml:

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
        <bean id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
    
    </beans>

启动类：

@ImportResource(locations = {
       "classpath:beans.xml"})//导入Spring的配置文件让其生效
    @SpringBootApplication
    public class SpringBoot02ConfigApplication { 
        public static void main(String[] args) {
            SpringApplication.run(SpringBoot02ConfigApplication.class, args);
        }
    }

**注解三：@Bean：给容器中添加组件（配合@Configuration注解使用）**

/** * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件 */
    
    @Configuration
    public class MyAppConfig { 
        //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
        @Bean
        public HelloService helloService02(){
            System.out.println("配置类@Bean给容器中添加组件了...");
            return new HelloService();
        }
    }

--------------------

## 四、配置文件占位符 ##

### 1、随机数 ###

//随机数在占位符的用法
    ${random.value}、${random.int}、${random.long}
    ${random.int(10)}、${random.int[1024,65536]}

### 2、占位符获取之前配置的值，如果没有可以是用:指定默认值 ###

person.last-name=张三${random.uuid}
    person.age=${random.int}
    person.birth=2017/12/15
    person.boss=false
    person.maps.k1=v1
    person.maps.k2=14
    person.lists=a,b,c
    #也可以在占位符中定义某一个对象的属性值，如定义person.hello=hello
    person.dog.name=${person.hello:hello}_dog
    person.dog.age=15

--------------------

## 五、Profile的使用 ##

### 1、多Profile文件 ###

> 我们在主配置文件编写的时候，文件名可以是 application-\{profile\}.properties/yml

### 2、yml支持多文档块方式(用“—”来区分文档块) ###

server:
      port: 8081
    spring:
      profiles:
        active: prod
    
    ---
    server:
      port: 8083
    spring:
      profiles: dev
    
    
    ---
    
    server:
      port: 8084
    spring:
      profiles: prod

### 3、激活指定profile（三种方式） ###

1、在配置文件中指定 spring.profiles.active=dev

2、命令行：  
 java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar –spring.profiles.active=dev；  
 可以直接在测试的时候，配置传入命令行参数

3、虚拟机参数，不论全局配置文件配置的是什么，都会运行都会制定激活虚拟机参数所配置的信息；  
Idea – Edit Congigurations — 左侧选中要执行的主类 — VM options — 输入：-Dspring.profiles.active=dev

--------------------

## 六、内部配置文件加载位置 ##

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件。

<table> 
 <thead> 
  <tr> 
   <th>Tables</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>file:./config/ （file指的时候项目根目录）</td> 
  </tr> 
  <tr> 
   <td>file:./</td> 
  </tr> 
  <tr> 
   <td>classpath:/config/</td> 
  </tr> 
  <tr> 
   <td>classpath:/</td> 
  </tr> 
 </tbody> 
</table>

优先级由高到底，高优先级的配置会覆盖低优先级的配置；SpringBoot会从这四个位置全部加载主配置文件。形成**互补配置**；  
总而言之多个配置文件就会形成**覆盖**且又能**互补**的配置效果。

另外，我们还可以通过**spring.config.location**来改变默认的配置文件位置

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

--------------------

## 七、外部配置加载顺序 ##

**SpringBoot也可以从以下位置加载配置； 优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置：(加粗项为较常用的方式)**

**1.命令行参数**所有的配置都可以在命令行上进行指定(多个配置用空格分开)  
如：java -jar xxx.jar –server.port=8087 –server.context-path=/abc

2.来自java:comp/env的JNDI属性  
3.Java系统属性（System.getProperties()）  
4.操作系统环境变量  
5.RandomValuePropertySource配置的random.\*属性值

【**由jar包外向jar包内进行寻找**】  
【**优先加载带profile**】

**6.jar包外部的application-\{profile\}.properties或application.yml(带spring.profile)的配置文件**

**7.jar包内部的application-\{profile\}.properties或application.yml(带spring.profile)的配置文件**

**【再来加载不带profile】**