二、配置文件

1、配置文件

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

• application.properties
• application.yml

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

YAML（YAML Ain’t Markup Language）

• YAML A Markup Language：是一个标记语言
• YAML isn’t Markup Language：不是一个标记语言；

标记语言：
以前的配置文件；大多都是使用 xxx.xml文件；
YAML：<mark>数据为中心</mark> ， 比json、xml等更适合做配置文件

YAML：配置例子

server:
  port: 8081

XML：

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

2、 YAML语法：

1、基本语法

K：（空格）V ⇒ 表示一对键值对（空格必须有） ；
以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一层级的

server:
  port: 8081
  path: /hello

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

2、值的写法

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

K：V ⇒ 字面直接来写；
字符串默认不用加上单引号或者双引号；
“” ：双引号 ⇒ 不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思
name:"zhangshan \n lisi " ⇒ 输出：zhangshan 换行 lisi

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

name:"zhangshan \n lisi " ⇒ 输出：zhangshan \n lisi

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

K：V：
对象还是 K：V 的方式

friends:
	lastName: zhangshan
	age: 20

行内写法

friends: {lastName: zhanghan , age: 18}

数组（List、Set）：

用 - 值表示足足中的一个元素

pets:
  - cat
  - dog
  - pig

行内写法

pets: [cat,dog,pig]

3、 配置文件值注入

配置文件

server:
  port: 8081
# path: /hello

Person: 
  lastName: zhangsan
  age: 18
  boss: false 
  birth: 2017/12/12 
  maps: {k1: v1 , k2: 12}
  list: 
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    age: 2

javaBean

/** * 将配置文件中配置的每个属性值， * 映射到这个组件中 * @ConfigurationProperties: 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定； * prefix="person": 配置文件中哪个下面的所有属性进行一一映射 * * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能； */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
	private String lastName ; 
	private Integer age ; 
	private Boolean boss ; 
	private Date birth ; 
	

我们可以导入配置文件的处理器，以后编写配置就有提示了。

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

JSR303
@Validated
类
@Email
属性
这个属性要 Email 形式

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

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

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

package com.edut.springboot.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将本类中的所有属性和配置文件中相关的配置进行绑定； * prefix="person": 配置文件中哪个下面的所有属性进行一一映射 * * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能； */
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
	
	/** * <bean class="Person"> * <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property> * </bean> */
	//@Value("${person.last-name}")
	@Email
	private String lastName ;
	//@Value("#{11*2}")
	private Integer age ;
	//@Value("true")
	private Boolean boss ; 
	private Date birth ; 
	

4、 @PropertySource&@ImportResource

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

package com.edut.springboot.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.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

/** * 将配置文件中配置的每个属性值， * 映射到这个组件中 * @ConfigurationProperties: 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定； * prefix="person": 配置文件中哪个下面的所有属性进行一一映射 * * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能； */
@Component
@ConfigurationProperties(prefix = "person" )
@PropertySource(value = "classpath:person.properties" , encoding = "UTF-8")
//@Validated
public class Person {
	
	/** * <bean class="Person"> * <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property> * </bean> */
	//@Value("${person.last-name}")
	//@Email
	private String lastName ;
	//@Value("#{11*2}")
	private Integer age ;
	//@Value("true")
	private Boolean boss ; 
	private Date birth ; 

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

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

package com.edut.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

@ImportResource(locations = "classpath:beans.xml")
@SpringBootApplication
public class LearnSpringbootQuickApplication {

	public static void main(String[] args) {
		SpringApplication.run(LearnSpringbootQuickApplication.class, args);
	}

}

<?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 class="com.edut.springboot.service.HelloService" />

</beans>

不来编写 Spring 的配置文件

SpringBoot 推荐 @Configuration @Bean

SpringBoot 推荐给容器中添加组件的方式：springBoot官方推荐使用使用全注解的配置方式：
1、配置类 - - - Spring配置文件
2、使用@Bean给容器添加组件

package com.edut.springboot.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.edut.springboot.service.HelloService;

/** * @Configuration 指明当前类似一个配置类，就是来替代之前的spring配置文件 * * 在配置文件中使用<bean></bean>添加标签组件 */
//@Configuration
public class MyAppConfig {

	//将方法的返回值添加到容器中，容器中这个组件默认的id就是方法名
	@Bean
	public HelloService helloService() {
		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.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.list=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=18

5、Profile

1、多Profile文件

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

2、yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active:
    - dev
---
spring:
  profiles: 
  - dev

server:
  port: 8082

3、 激活指定profile

1、 在配置文件中指定 : spring.profile.active=dev
2、 命令行

6、配置文件 优先级

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

按优先级从高到低

所有支持的配置加载来源，参考官方文档；

8、自动配置原理

配置文件到底能写什么？怎么写？自动配置原理：

一旦这个配置类生效；这个配置类就会给容器中添加各种组件；
这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

配置文件能配置的属性参照

自动配置原理：

1）、SpringBoot启动的时候加载主配置类，开启了自动配置功能

2）、@EnableAutoConfiguration作用：

• 利用 EnableAutoConfigurationImportSelector 给容器导入了一些组件
• 可以查看 selectImports() 方法的内容
• public String[] selectImports(AnnotationMetadata annotationMetadata) {
• List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
  • List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
  • Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
  • Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
    • public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
• <mark>扫描所有 jar 包类路径下 META-INF/spring.factories</mark>
• <mark>把扫描到的这些文件的内容包装成properties对象</mark>
• <mark>从properties中获取到 EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加到容器中</mark>

<mark>扫描所有 jar 包类路径下 META-INF/spring.factories
中获取到 EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加到容器中</mark>

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer

# Auto Configuration Import Listeners

这样的 xxxAutoConfiguration 类都是容器中的一个组件，都加入到容器中。用他们来做自动配置

3）、每一个自动配置类，进行自动配置功能。
4）、以 HttpEncodingAutoConfiguration（Http编码 自动配置） 作为例子解释自动配置原理

@Configuration(proxyBeanMethods = false) //表示这是一个配置类，以前编写的配置文件一样，也可以给容器添加组件
@EnableConfigurationProperties(HttpProperties.class) //启动指定类的 ConfigurationProperties 功能；
//将配置文件中对应的值和HttpEncodingProperties绑定起来
//并把HttpEncodingProperties加入到ioc容器中


@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) //Spring底层@Condition注解（详细，看spring注解版），
//根据不同条件，如果满足指定的条件，整个配置类里面的配置就会生效；
//判断当前应用是否是 web 应用


@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类 CharacterEncodingFilter ;
//SpringMVC中进行乱码解决的过滤器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判断配置文件中是否存在某个配置 spring.http.encoding ；
// 如果不存在，判断也是成立的。
//即使我们配置文件中不配置spring.http.enabled=true ，也是默认生效的。

public class HttpEncodingAutoConfiguration {

	//它已经和SpringBoot的配置文件映射了
	private final HttpProperties.Encoding properties;

	//自由一个有参构造器的情况下，参数的值就会从容器中拿
	public HttpEncodingAutoConfiguration(HttpProperties properties) {
		this.properties = properties.getEncoding();
	}

	@Bean //给容器中添加一个㢟，这个组件的某些值，需要从properties中获取
	@ConditionalOnMissingBean
	public CharacterEncodingFilter characterEncodingFilter() {
		CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
		//设置编码
		filter.setEncoding(this.properties.getCharset().name());
		filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
		filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
		return filter;
	}

根据当前不同的条件判断，决定这个配置类是否生效？

5）、所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(prefix = "spring.http") //从配置文件中获取指定的值和bean属性进行绑定
public class HttpProperties {

	private boolean logRequestDetails;

@ConfigurationProperties(prefix = "spring.http")
public class HttpProperties {

2、细节

1、 @Condition 派生注解（Spring注解版原生的@Condition作用）

作用：必须是@Condition指定的条件成立，才给容器中添加组件，配置里面所有的内容才生效；

自动配置类必须在一定条件下才会生效

怎么知道那些自动配置类生效：

我们可以通过启动 debug=true 属性；
来让控制台打印自动配置报告，
这样我们就可以很方便的知道哪些自动配置类生效；
Positive matches 生效的

2020-01-01 17:53:45.678 DEBUG 10584 --- [           main] .c.l.ClasspathLoggingApplicationListener : Application started with classpath: [file:/F:/environment/java/workspace/learn-springboot-quick/target/classes/, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter/2.2.2.RELEASE/spring-boot-starter-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot/2.2.2.RELEASE/spring-boot-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-autoconfigure/2.2.2.RELEASE/spring-boot-autoconfigure-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter-logging/2.2.2.RELEASE/spring-boot-starter-logging-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar, file:/C:/Users/uu/.m2/repository/ch/qos/logback/logback-core/1.2.3/logback-core-1.2.3.jar, file:/C:/Users/uu/.m2/repository/org/apache/logging/log4j/log4j-to-slf4j/2.12.1/log4j-to-slf4j-2.12.1.jar, file:/C:/Users/uu/.m2/repository/org/apache/logging/log4j/log4j-api/2.12.1/log4j-api-2.12.1.jar, file:/C:/Users/uu/.m2/repository/org/slf4j/jul-to-slf4j/1.7.29/jul-to-slf4j-1.7.29.jar, file:/C:/Users/uu/.m2/repository/jakarta/annotation/jakarta.annotation-api/1.3.5/jakarta.annotation-api-1.3.5.jar, file:/C:/Users/uu/.m2/repository/org/yaml/snakeyaml/1.25/snakeyaml-1.25.jar, file:/C:/Users/uu/.m2/repository/org/slf4j/slf4j-api/1.7.29/slf4j-api-1.7.29.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-core/5.2.2.RELEASE/spring-core-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-jcl/5.2.2.RELEASE/spring-jcl-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter-web/2.2.2.RELEASE/spring-boot-starter-web-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter-json/2.2.2.RELEASE/spring-boot-starter-json-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/core/jackson-databind/2.10.1/jackson-databind-2.10.1.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/core/jackson-annotations/2.10.1/jackson-annotations-2.10.1.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/core/jackson-core/2.10.1/jackson-core-2.10.1.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/datatype/jackson-datatype-jdk8/2.10.1/jackson-datatype-jdk8-2.10.1.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/datatype/jackson-datatype-jsr310/2.10.1/jackson-datatype-jsr310-2.10.1.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/jackson/module/jackson-module-parameter-names/2.10.1/jackson-module-parameter-names-2.10.1.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter-tomcat/2.2.2.RELEASE/spring-boot-starter-tomcat-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/apache/tomcat/embed/tomcat-embed-core/9.0.29/tomcat-embed-core-9.0.29.jar, file:/C:/Users/uu/.m2/repository/org/apache/tomcat/embed/tomcat-embed-el/9.0.29/tomcat-embed-el-9.0.29.jar, file:/C:/Users/uu/.m2/repository/org/apache/tomcat/embed/tomcat-embed-websocket/9.0.29/tomcat-embed-websocket-9.0.29.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-starter-validation/2.2.2.RELEASE/spring-boot-starter-validation-2.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/jakarta/validation/jakarta.validation-api/2.0.1/jakarta.validation-api-2.0.1.jar, file:/C:/Users/uu/.m2/repository/org/hibernate/validator/hibernate-validator/6.0.18.Final/hibernate-validator-6.0.18.Final.jar, file:/C:/Users/uu/.m2/repository/org/jboss/logging/jboss-logging/3.4.1.Final/jboss-logging-3.4.1.Final.jar, file:/C:/Users/uu/.m2/repository/com/fasterxml/classmate/1.5.1/classmate-1.5.1.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-web/5.2.2.RELEASE/spring-web-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-beans/5.2.2.RELEASE/spring-beans-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-webmvc/5.2.2.RELEASE/spring-webmvc-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-aop/5.2.2.RELEASE/spring-aop-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-context/5.2.2.RELEASE/spring-context-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/spring-expression/5.2.2.RELEASE/spring-expression-5.2.2.RELEASE.jar, file:/C:/Users/uu/.m2/repository/org/springframework/boot/spring-boot-configuration-processor/2.2.2.RELEASE/spring-boot-configuration-processor-2.2.2.RELEASE.jar]

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.2.2.RELEASE)

2020-01-01 17:53:45.766  INFO 10584 --- [   

============================
CONDITIONS EVALUATION REPORT
============================


Positive matches:
-----------------

   AopAutoConfiguration matched:
      - @ConditionalOnProperty (spring.aop.auto=true) matched (OnPropertyCondition)

Negative matches:
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required class 'javax.jms.ConnectionFactory' (OnClassCondition)

Exclusions:
-----------

    None


Unconditional classes:
----------------------

    org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration

    org.springframework.boot.autoconfi