SpringBoot——配置文件的相关介绍

1：配置文件

• SpringBoot使用一个全局的配置文件，配置文件名是固定的；
  • application.properties
  • application.yml
    
• 配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

2：YAML的介绍

标记语言：

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

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

server:   
   port: 8088

XML举例

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

2.1 YAML语法

k:
 v:

• 写法：k:(空格)v：表示一对键值对（空格必须有）；
  以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的（属性和值也是大小写敏感）

server:
   port:8888

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

• k: v：字面直接来写；
  字符串默认不用加上单引号或者双引号；

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

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

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

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

• 对象、Map（属性和值）（键值对）

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

people:
     name: zlj
     age: 20

people: {name: zlj,age: 20}

• 数组（List、Set）
  用- 值表示数组中的一个元素

pets:  
   ‐ cat  
   ‐ dog  
   ‐ pig

pets: [cat,dog,pig]

3：配置文件值注入

3.1 @Value和@ConfigurationProperties

举例：写两个dog，person类，要求在配置文件中写入值，并注入到类里面，通过test方法得到结果

Person.java部分截取片段

/**

 * @Component只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@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;

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

• @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定(将配置文件中配置的每一个属性的值，映射到这个组件中)
• prefix = “person”：配置文件中哪个下面的所有属性进行一一映射
• 只有这个组件是容器中的组件（@Component），才能容器提供的**@ConfigurationProperties**功能；
• @ConfigurationProperties(prefix = “person”)默认从全局配置文件中获取值；

application.yml

server:
  port: 8081
  # 全局配置文件中的person属性进行一一映射
person:
  age: 12
  boss: true
  last-name: zlj
  birth: 2022/12/17
  maps:
     k2: v2
     k1: v1
  lists:
     - zlj
     - zzg
  dog:
     name: z
     age: 13

小技巧：我么添加导入配置文件处理器依赖，以后编写全局配置就有提示了

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

小技巧：我么导入一下依赖就可以进行测试test方法

      <dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

结果

Person{lastName='zlj', age=12, boss=true, birth=Sat Dec 17 00:00:00 CST 2022, maps={k2=v2, k1=v1}, lists=[zlj, zzg], dog=Dog{name='z', age=13}}

• @Value获取值和@ConfigurationProperties获取值比较

Spring中的Bean配置 (13)—— Spring表达式语言：SpEl

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

3.2 @PropertySource和@ImportResource

@PropertySource：加载指定的配置文件；

Person.java部分代码片段截取

@Component

//底下两个注解要同时存在才可以显示出person.properties对应的值
@PropertySource(value = {"classpath:person.properties"})
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

• SpringBoot会优先读取application.properties中的配置内容，接着是application.yml，再接着如果上面都没配置相关信息，就会读取person.properties中的内容

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

• Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别； 想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上

//导入Spring的配置文件让其生效

@ImportResource(locations = {"classpath:beans.xml"}) 

beans.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>

但是SpringBoot使用了一个更好的方式给容器中添加组件；（推荐使用全注解的方式）
1、配置类@Configuration------>Spring配置文件 （.xml）
2、使用@Bean给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件（.xml）
 *
 * 在Spring配置文件（.xml）中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }

}

4：配置文件占位符

4.1 随机数

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

4.2 占位符获取之前配置的值

application.yml

person:
  age: 12
  boss: true
  last-name: zlj
  birth: 2022/12/17
  maps:
     k2: ${random.int}
     k1: ${random.int}
  lists:
     - zlj
     - zzg
  dog:
     name: zl
     age: 13

application.properties

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

5：Profile

• 我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml
  默认使用application.properties的配置；

5.1 yml支持多文档块方式

5.2 激活指定profile

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

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文件作为Spring boot的默认配置文 件
  • –file:./config/
  • –file:./
  • –classpath:/config/
  • –classpath:/

优先级由高到底，高优先级的配置会覆盖低优先级的配置；
SpringBoot会从这四个位置全部加载主配置文件；互补配置；

• 我们还可以通过spring.config.location来改变默认的配置文件位置
  使用方法：
  项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默 认加载的这些配置文件共同起作用形成互补配置；

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

7：自动配置

1）SpringBoot启动会加载大量的自动配置类
2）我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；
3）我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

4）给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这 些属性的值；