2_1.springboot2.x配置之配置文件解析

1、配置文件

1、Spring Boot使用一个全局的配置文件：•application.properties、application.yml

2、配置文件放在src/main/resources目录或者类路径/config下

3、yml是YAML（YAML Ain’t Markup Language）语言的文件，以数据为中心，比json、xml等更适合做配置文件

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

YAML：配置例子

server:
   port: 8081

xml

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

4、全局配置文件的可以对一些默认配置值进行修改

2、YAML语法

1、基本语法

• 使用缩进表示层级关系
• 缩进时不允许使用Tab键，只允许使用空格。
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• 大小写敏感

2、YAML 支持的三种数据结构

• 对象：键值对的集合

  对象的一组键值对，使用冒号分隔。如：username: admin
  
  冒号后面跟空格来分开键值；
  
  {k: v}是行内写法

  friends:
  		lastName: zhangsan
  		age: 20
  

  行内写法：

  friends: {lastName: zhangsan,age: 18}
  

• 数组：一组按次序排列的值

  一组连词线（-）开头的行，构成一个数组，[]为行内写法

  pets:
   - cat
   - dog
   - pig
  

  行内写法

  pets: [cat,dog,pig]
  

• 字面量：单个的、不可再分的值

  k: v：字面直接来写；

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

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

  ​ name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

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

  ​ name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

  文档块：多个文档用—隔开

  #文档快
  spring:
    profiles:
      active: prod
  ---
  spring:
    profiles: dev
  server:
    port: 8083
  ---
  spring:
    profiles: prod
  server:
    port: 8084
  ---
  

---

3、配置文件值注入

application.yml

person:
   lastName: zhangsan
   age: 20
   boss: false
   bitrh: 2019/12/12
   maps: {k1: v1,k2: v2}
   lists:
    - lisi
    - wangwu
  dog: {name: xiaohu,age: 2}

javaBean:

package com.spboot.springboot.bean;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;

/*
* 将配置文件中的每一个属性的值，映射到这个组件中
* @ConfigurationProperties:告诉springboot将本类所有属性和配置文件中所有属性进行绑定
* @ConfigurationProperties(prefix = "person") prefix="" 配置文件中那个下面的属性进行一一映射
* 只有是容器中的组件，才能使用容器提供的@ConfigurationProperties，加入@Component
 * */
@Component
//@PropertySource(value = {"classpath:person.properties"}) //告诉springboot加载person.properties中属性值，并且进行绑定
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //lastName必须是邮箱格式
    //@Email
    private String lastName;
    private Integer age;
    private boolean boss;
    private Date bitrh;
    //@Value("${person.maps.k1}") 不支持复杂类型
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public boolean isBoss() {
        return boss;
    }

    public void setBoss(boolean boss) {
        this.boss = boss;
    }

    public Date getBitrh() {
        return bitrh;
    }

    public void setBitrh(Date bitrh) {
        this.bitrh = bitrh;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "Person{" + "lastName='" + lastName + '\'' + ", age=" + age + ", boss=" + boss + ", bitrh=" + bitrh + ", maps=" + maps + ", lists=" + lists + ", dog=" + dog + '}';
    }
}

注意：

将配置文件中的每一个属性的值，映射到这个组件中
@ConfigurationProperties:告诉springboot将本类所有属性和配置文件中所有属性进行绑定@ConfigurationProperties(prefix = "person") prefix="" 配置文件中那个下面的属性进行一一映射
只有是容器中的组件，才能使用容器提供的@ConfigurationProperties，
前提将配置类加入容器中@Component
@PropertySource(value = {"classpath:person.properties"}) 告诉springboot加载哪个配置文件，即person.properties中属性值，并且进行绑定

pom.xml中导入配置文件处理器，以后编写配置就有提示

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

注意配置文件乱码：

@Value和@ConfigurationProperties为属性注值对比

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

@ConfigurationProperties

与@Bean结合为属性赋值

与@PropertySource（只能用于properties文件）结合读取指定文件

@ConfigurationProperties Validation

支持JSR303进行配置文件值校验；

@Component
//@PropertySource(value = {"classpath:person.properties"}) //告诉springboot加载person.properties中属性值，并且进行绑定
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //lastName必须是邮箱格式
    //@Email
    private String lastName;
    private Integer age;
    private boolean boss;
    private Date bitrh;
    //@Value("${person.maps.k1}") 不支持复杂类型
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

@ImportResource读取外部配置文件

配置文件yml还是properties他们都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必须是邮箱格式
   // @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效

不用编写spring配置文件：

<?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.spboot.springboot.service.HelloService">

    </bean>

</beans>

可用以下配置文件类代替：

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1、配置类**@Configuration**------>Spring配置文件

2、使用**@Bean**给容器中添加组件

package com.spboot.springboot.config;

import com.spboot.springboot.service.HelloService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/*
* 指明当前类为配置类，代替以前的spring配置文件
* 在配置文件中使用<bean></bean>添加组件
* */
@Configuration
public class MyAppConfig {

    //讲方法的返回值添加到返回值，容器中组件默认id就是方面名
    @Bean
    public HelloService helloService(){

        System.out.println("配置类@Bean给容器添加组件");
        return new HelloService();
    }

}

4、配置文件占位符

1、随机数

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

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

# 配置person的值
person.last-name=张三${random.uuid}
person.age=${random.int}
person.boss=true
person.bitrh=2019/12/15
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

5、Profile简介

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

1、多profile文件形式

格式：application-{profile}.properties/yml：

•application-dev.properties、application-prod.properties

2、多profile文档块模式：

server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: dev

---

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

3、激活方式：

​ 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、配置文件加载位置

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

file:./config/

file:./

classpath:/config/

classpath:/

以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容。

也可以通过配置spring.config.location来改变默认配置,SpringBoot会从这四个位置全部加载主配置文件；互补配置；

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

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

7、外部配置加载顺序

SpringBoot也可以从以下位置加载配置； 优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置。

Spring Boot 支持多种外部配置方式

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指定的默认属性