SpringBoot零基础详解二：配置文件application及自动配置原理_application配置文件

Table of Contents

二：配置文件

1：application配置文件

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

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

1.3：标记语言比较 YMAL和XML：

1.4：同级别配置项，properties配置级别高

2：YMAL语法

2.1：基本语法：

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

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

2.4：数组（List、Set）：

3：配置文件注入程序内；程序使用配置文件内容

3.1:YMAL配置文件：

3.2：properties配置文件；

3.3：@Value获取值和@ConfigurationProperties获取值比较

3.4：@PropertySource&@ImportResource&@Bean

4：配置文件占位符

4.1：随机数

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

5：Profile：多环境支持

5.1：properties文件：

5.2：yml支持多文档块方式

5.3：激活指定profile

6：配置文件的加载顺序

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

6.2：我们还可以通过spring.config.additional.location来改变默认的配置文件位置

7：外部配置文件加载顺序（方便运维管理）

7.1.命令行参数

7.2.来自java:comp/env的JNDI属性

7.3.Java系统属性（System.getProperties()）

7.4.操作系统环境变量

7.5.RandomValuePropertySource配置的random.*属性值

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

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

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

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

7.10.@Configuration注解类上的@PropertySource

7.11.通过SpringApplication.setDefaultProperties指定的默认属性

8：自动配置原理

8.1：自动配置原理；

8.2：以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

8.3：细节

---

二：配置文件

1：application配置文件

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

•application.properties

•application.yml

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

YAML（YAML Ain't Markup Language） yaml是一个标记语言

1.3：标记语言比较 YMAL和XML：

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

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

yml配置例子：

server:
  port: 8091

properties配置例子：

server.port=8090

xml配置例子：

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

1.4：同级别配置项，properties配置级别高

2：YMAL语法

2.1：基本语法：

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

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

server:
    port: 8081
    path: /hello

属性和值的大小写都很敏感； 

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

k: v  ----字面直接来写；

注：冒号后有空格

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

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

name: "zhangsan \n lisi"：输出；zhangsan 换行 lisi

''：单引号；会转义（改变）特殊字符含义，特殊字符最终只是一个普通的字符串数据

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

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

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

      对象还是k: v的方式

friends:
	lastName: zhangsan
	age: 20

    行内写法：

friends: {lastName: zhangsan,age: 18}

2.4：数组（List、Set）：

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

pets:
 - cat
 - dog
 - pig

行内写法：

pets: [cat,dog,pig]

3：配置文件注入程序内；程序使用配置文件内容

注：javabean必须有属性的get和set方法

3.1:YMAL配置文件：

person:
  lastName: zhansan
  age: 22
  map: {k1: v1,k2: v2}
  list:
    - wangwu
    - 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 Map<String,Object> map;
    private List<String> list;
 
    private Dog dog;

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

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

3.2：properties配置文件；

#perperties配置person
person.last-name=李四
person.age=33
person.map.k1=v2
person.map.k2=v1
person.list=1,2,3
person.dog.name=土豆
person.dog.age=3

如果出现乱码就是idea默认*.properties的编码格式为gbk，在设置中改成utf-8即可

3.3：@Value获取值和@ConfigurationProperties获取值比较

@value（）

区别：

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

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；可以在任何类变量上取到；

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

注：

1：松散绑定

2：SPEL(计算式)

可以支持这样的：@Value("#{2*11}")

3：JSR303校验：

@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;

4：复杂类型：

@value不支持map，对象等复杂类型；

3.4：@PropertySource&@ImportResource&@Bean

1：@PropertySource：加载指定的配置文件---分离properties；使默认的properties不再臃肿；

注：该方法只能用于properties配置文件，@Value和@ConfigurationProperties都适用；

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

以前我们想注册一个service配置文件；

然后检测容器中是否有改service

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

这样就注入了组件；

但是spring不推荐这样配置组件；SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

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

2、使用@Bean给容器中添加组件，//将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名

例：

4：配置文件占位符

4.1：随机数

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

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

5：Profile：多环境支持

5.1：properties文件：

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

默认使用的配置；

5.2：yml支持多文档块方式

注意：需要在任何一个properties文件下没有相同内容情况下指定，否则properties的优先级比较高

5.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：配置文件的加载顺序

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

–file:./config/（根目录下的config文件夹）

–file:./（根目录下）

–classpath:/config/（resources/config）

–classpath:/（resources）

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

SpringBoot会从这四个位置全部加载主配置文件；互补配置；

指定根目录用：

server.servlet.context-path=/boot

6.2：我们还可以通过spring.config.additional.location来改变默认的配置文件位置

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

注：--spring.config.location=xxx 在新版本中是替换的意思；

       --spring.config.additional.location 是追加的意思

7：外部配置文件加载顺序（方便运维管理）

7.1.命令行参数

所有的配置都可以在命令行上进行指定

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc

多个配置用空格分开； --配置项=值

7.2.来自java:comp/env的JNDI属性

7.3.Java系统属性（System.getProperties()）

7.4.操作系统环境变量

7.5.RandomValuePropertySource配置的random.*属性值

==由jar包外向jar包内进行寻找；==

==优先加载带profile==

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

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

==再来加载不带profile==

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

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

如：将打好的包的根目录下放置配置文件这就是外部配置文件，优先加载

7.10.@Configuration注解类上的@PropertySource

7.11.通过SpringApplication.setDefaultProperties指定的默认属性

官方文档： (https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-external-config)

8：自动配置原理

配置文件能写什么？怎么写？自动配置原理；

官方文档（Spring Boot Reference Documentation）

8.1：自动配置原理；

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

2）、@EnableAutoConfiguration 作用：

• 利用AutoConfigurationImportSelector给容器中导入一些组件？

• 可以查看selectImports()方法的内容；它表明哪些自动配置类是要加入到容器中

• 

• 继续追踪源码，可以看到getAutoConfigurationEntry（..)这个方法，其中configurations存放在数据就是加入容器的自动配置类的完整包路径

• 

• 

• 

• 

• Spring Boot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值，将这些值作为自动配置类导入到容器中，自动配置类就生效，帮我们进行自动配置工作

• 

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

3）、每一个自动配置类进行自动配置功能；

8.2：以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

//表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@Configuration(
    proxyBeanMethods = false
)
/**启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties
绑定起来；并把HttpEncodingProperties加入到ioc容器中*/
@EnableConfigurationProperties({HttpProperties.class})
//Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，
//整个配置类里面的配置就会生效；    判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
 
//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass({CharacterEncodingFilter.class})
 
//判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final 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(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }

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

一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；同时也是我们可以在配置文件中更改的；

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

总结：

1）、SpringBoot启动会加载大量的自动配置类

2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；

3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

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

xxxxAutoConfigurartion：自动配置类；

给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

8.3：细节

1：@Conditional派生注解（Spring注解版原生的@Conditional作用）

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

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

我们怎么知道哪些自动配置类生效；

2：查看系统启动的时候那些自动配置类生效；

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

未启动，未自动配置的自动配置类；