SpringBoot的配置文件详解

柔情只为你懂 2022-05-11 02:26 266阅读 0赞

### **1.配置文件** ###

SpringBoot使用一个全局的配置文件，配置文件是固定的

\*application.properties

\*appication.yml

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

YAML(YAML Ain't Markup Language)  
YAML A Markup Language:是一个标记语言  
YAML isn't Markup Language:不是一个标记语言;

标记语言：

以前的配置文件；大多都使用的是x x x.xml文件

YAML：以数据为中心，比json、xml 更适合做配置文件

YAML配置例子：

server.port=8088

properties配置例子：

server.port=8089

xml配置文件例子：

### **2.YAML语法** ###

**  1.基本语法**

K:(空格)v    :表示一组键值对（必须有空格）

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

server:
       port:8082
       path:/zch

属性和值也是大小值敏感

** 2.值得写法**

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

k: v :字面直接来写

字符串默认不用加上单引号或者双引号

"":双引号；不会转移字符串里面的特殊字符；特殊字符会作为本身想表示的意思

name: "zhang \\n san"    输出为   zhang换行san

'':单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: "zhang \\n san"    输出为   zhang \\n san

**3.对象、Map(属性和值)（键值对）**

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

对象还是k: v 的方式

person:
        lastName: 张三
        age: 18

行内写法：

person: {lastName：zch,age :44}

**4.数组(list,set)**

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

pets:
      - cat
      - dog
      - pig

行内写法：

pets: [cat,dog,pig]

### **3.配置文件注入值（此处以YAMl文件为例）** ###

**1.配置文件**

server:
        port: 8081
    person:
        lastName: 张三
        age: 18
        boss: true
        birth: 2018/12/02
        map: {k1: c,k2: z}
        lists:
           - zz
           - bb
        dog:
          name: Tom
          age: 12

**2.javaBean:**

package com.hbsi.bean;
    
    import java.util.Date;
    import java.util.List;
    import java.util.Map;
    
    import javax.validation.constraints.Email;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    import org.springframework.validation.annotation.Validated;
    /*
     *  将配置文件中配置的每一个属性的值，映射到这个组件
     *  @ConfigurationProperties:告诉SpringBoot将本类中所有属性和配置文件中相关的配置进行绑定；
     *  只有这个组件是容器中的组件，才能用容器提供的@ConfigurationProperties功能
     */
    @Component
    @ConfigurationProperties(prefix = "person")
    //@Validated
    public class Person {
    	//可以通过@Value获取配置文件中某一个值
    	//@Email
        //@Value("${person.lastName}")  将@ConfigurationProperties注释，使用@Value也能获取配置文件中的值
    	private String lastName;
    	private Integer age;
    	private boolean boss;
    	private Date birth;
    	private Map<String, String> map;
    	private List lists;
    	private Dog dog;
    }

### **4.配置文件占位符** ###

**1.随机数**

${random.value}、${random.int}、${random.long} 2 ${random.int(10)}、${random.int[1024,65536]}

**2.占位符获取之前配置的值，如果没有可以用：指定默认值**

#person.last-name=abc¸${random.uuid}
    person.birth=2017/12/15
    person.boss=false
    person.maps.k1=v1
    person.maps.k2=14
    person.lists=a,b,c
    person.dog.name=${person.last-name:hello}_dog 9 
    person.dog.age=15

### **5.Profile** ###

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境。

**1.多Profile文件**

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

application.properties:默认全局配置文件

application-dev.properties:开发环境

application-prod.properties:生产环境

application-test.properties:测试环境

默认使用application.properties的配置；可以在默认配置文件中指定激活哪个profile

spring.profile.active=dev 激活开发环境

**2.yml支持多文档快方式**

server:
      port: 8080
    spring:
      profiles:
        active: dev    #开发环境      active:dev  开发环境被激活（端口8084） 如果不写默认为（8080）
     
    ---
    server:
      port: 8084
    spring:
      profiles: dev  开发环境
     
     
    ---
    server:
      port: 8085
    spring:
      profiles: prod 生产环境
     
     
    ---
    server:
      port: 8086
    spring:
      profiles: test

**3.激活指定profile**

1、在配置文件中指定 spring.profiles.active=dev  
2、命令行:  
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev; 可以直接在测试的时候，配置传入命令行参数  
3、虚拟机参数;  
\-Dspring.profiles.active=dev

### **6.配置文件加载位置** ###

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

-file:/config/

-file:/

-classpath:/config/

- classpath:/

优先级由高到低，高优先级的配置会覆盖低优先级的配置。

SpringBoot会从这四个位置加载配置文件;**互补配置**

**项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置。**

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

### **7.外部配置加载顺序** ###

SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置，所有的配置会

**1.命令行参数**  
所有的配置都可以在命令行上进行指定  
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.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

8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

10.@Configuration注解类上的@PropertySource 11.通过SpringApplication.setDefaultProperties指定的默认属性 所有支持的配置加载来源;