首页 二、配置文件（Spring Boot教程笔记4）
文章
取消

二、配置文件（Spring Boot教程笔记4）

发表于 2022/02/21 更新于 2022/11/21
作者 HuangHongxing
14 分钟阅读

4. 配置文件占位符

  1. 随机数
1

   ${random.value}, ${random.int}, ${random.long}, ${random.int(10)}, ${random.int[1024, 65536]}
  1. 占位符获取之前配置的值，如果没有可以使用“：”指定的默认值
1
2
3
4
5
6
7
8
9

   person.last-name=zhangshan${random.int}
   person.age=23
   person.birth=2017/2/13
   person.maps.k1=v1
   person.maps.k2=21
   person.lists=a,b,c
   # 获取之前配置的person.last-name的值,如果没有,person.dog.name默认等于"a"
   person.dog.name=${person.last-name:a} 
   person.dog.age=2

5.Profile

Profile是Spring对不同环境提供不同配置功能的支持，比如说我开发时用开发环境，我测试时用测试环境，可以通过在配置文件指定参数等方式快速切换环境。

1. 多Profile文件

格式：application-{profile}.properties或者applicaiton-{profile}.yml

譬如，我配置文件有三份：

1532248133899

application-dev.properties是dev环境的配置文件，application-prod.properties是prod环境的配置文件。

默认使用application.properties的配置。

2. yml支持多文档块方式

.yml可以用“—”划分文档块，每一份文档块的名字就是Spring下profiles的值，在主文档块是用spring->profiles->active指定激活哪个环境，这时候，resources里的配置文件只需要该.yml格式的配置文件就好。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# application.yml
# 主配置环境
server:
  port: 8081
spring:
  profiles:
    active: dev
---
# dev环境
server:
  port: 8082
spring:
  profiles: dev
---
# prod环境
server:
  port: 8083
spring:
  profiles: prod

3. 激活指定的profile

1.在主配置文件中指定要切换到哪个环境

1
2
3

# /resources/application.properties
# 指定激活dev环境（同路径下还有application-dev.properties配置文件,就是激活这一份配置文件）
spring.profiles.active=dev

2. 命令行参数

1

--spring.profiles.active=dev  # 指定用dev环境

1532249242826

如果已经打包了，怎么指定环境？

在jar包里用命令行: java -jar spring-boot-02-config-0.01-SNAPSHOT.jar –spring.profiles.active=dev指定。

1532249678070

3. jvm参数

-DSpring.profiles.active=dev

1532249776262

#### 命令行参数和jvm参数指定环境的优先级比主配置文件高，就是说主配置文件的spring.profiles.active激活dev，但是命令行参数激活prod环境，那么最终是系统运行在prod环境下的。

6. 配置文件加载位置

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

1
2
3
4

- file:./config/ # 文件路径下的config文件夹下
- file:./    # 文件路径下的
- classpath:/config/ # 类路径下的config文件夹下
- classpath:/   # 类路径下的

以上是按照优先级从高到低的顺序进行加载配置，所有位置的文件都会被加载，互补配置。

1532251045420

通过spring.config.location改变配置文件位置。项目打包好之后，可以通过命令行参数的形式，启动项目的时候来指定配置文件的新位置，指定的这个配置文件会和默认加载的配置文件共同起作用形成互补配置。

1532251517801

–spring.config.location=G:/application.properties, 指定新的配置文件位置是G盘下的application.properties。如果G:\application.properties的话，\a是转义字符，所以得改成G:/application.properties。

7. 外部配置加载顺序

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

  1. 命令行参数
1
2

   # --配置项=值，多个配置用空格分开
   java -jar spring-boot.jar --server.port=8080 --server.context-path=/abc

  1. 来自java:comp/env的NDI属性

  2. Java系统属性（System.getProperties())

  3. 操作系统环境变量

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

  5. 由jar包外向jar包内寻找，优先加载profile。

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

SpringBoot项目jar包和我们自己自定义的外部application.properties放在同一路径下，然后启动项目jar包，该配置文件会生效。

  1. @Configutation注解类上的@PropertySource
  2. 通过SpringApplication.setDefaultProperties指定的默认属性

8. 自动配置原理

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

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

  2. @EnableAutoConfiguration作用：

    • 利用EnableAutoConfigurationImportSelector给容器导入了一些组件，导入的组件内容可以看selectImports()方法。

    • List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置。原理：

1
2
3
4
5
6
7

       /**
       * 扫描所有jar包类路径下的META-INF/spring.factories，
       * 然后把扫描到的内容包装成properties对象。
       * 从properties中获取到EnableAutoConfiguration.Class类（类名）对应的值，
       * 然后将他们添加在容器中。
       */
       SpringFactoriesLoader.loadFactoryNmaes()

1
2
3

 **将类路径下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到了容器中。**

 * 来到Maven：org.springframework.boot:spring-boot-autoconfigure:1.5.14.RElEASE的jar包中，在里面的META-INF里找到spring.factories中有：

1
2

       # Auto Configure
       org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

1

   **将类路径下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到容器中。**

1
2
3
4
5
6
7
8

       # Auto Configure
       org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
       # 底下就全是EnableAutoConfiguration的值
       org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
       org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
       org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
       org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
       ......

1
2
3
4
5
6
7

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

 * 每一个配置类进行自动配置功能。

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

   ***IDEA全局搜索类：Ctrl+N。***

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

       @Configuration // 这是一个配置类，跟配置文件一样，也可以给容器中添加组件。
       @EnableConfigurationProperties(HttpEncodingProperties.class) // 启动指定类的ConfigurationProperties功能(解释在下面)
       @ConditionalOnWebApplication // Spring底层的@Conditional注解，根据不同条件，如果满足指定条件，整个配置类里面的配置就会生效。@ConditionalOnWebApplication ==> 判断当前应用是否是Web应用
       @ConditionalOnClass(CharacterEncodingFilter.class) // 判断当前项目有没有CharacterEncodingFilter这个类
       @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) // 判断配置文件中是否存在spring.http.encoding.enabled这个配置（prefix = "spring.http.encoding", value = "enabled"），如果配置文件中没有该配置，那么spring.http.encoding.enabled默认为true（matchIfMissing）。
       public class HttpEncodingAutoConfiguration {
           // 表示已经和SpringBoot的配置文件映射了，故properties就能取到封装好的配置文件里的配置
           private final HttpEncodingProperties properties;
           // 这个类只有一个有参构造器，在只有一个有参构造器的情况下，参数的值就会从容器中拿，因为有前面的@EnableConfigurationProperties(HttpEncodingProperties.class)这个注解，所以能拿到，这个注解还能将HttpEncodingProperties加入到ioc容器中
        public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
          this.properties = properties;
        }
        @Bean // 给容器中添加characterEncodingFilter组件，这个组件的某些值需要从properties中获取
        @ConditionalOnMissingBean(CharacterEncodingFilter.class) // 判断出容器中没有CharacterEncodingFilter这个组件，才可以将该组件添加到容器里
        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;
        }

1
2
3

   @ConditionalOnWebApplication, @ConditionalOnClass(CharacterEncodingFilter.class), @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) ==> 根据当前不同的条件判断，决定这个HttpEncodingAutoConfiguration配置类是否生效。

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

1
2
3

       // 解释上面的@EnableConfigurationProperties(HttpEncodingProperties.class)这个注解
       @ConfigurationProperties(prefix = "spring.http.encoding") // 从配置文件中获取指定的值和Bean的属性进行绑定。由prefix = "spring.http.encoding"可看成，我们配置文件可以配spring.http.encoding这个属性，可以配什么值，需要看HttpEncodingProperties这个类有什么值可以配。
       public class HttpEncodingProperties {

1

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

注：

  1. SpringBoot启动会加载大量的自动配置类，我们看我们需要的功能SpringBoot有没有默认写好的自动配置类，如果写好了，我们再来看这个自动配置类中配置了哪些组件，只要我们要用的组件存在，我们就不用再来配置了，如果没有，就得写一个配置类，将我们的组件配过去。

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

1
2

   xxxxAutoConfiguration：自动配置类，给容器中添加组件
   xxxxProperties：封装配置文件中相关的属性

9.自动配置类是否启用

1. @Conditional派生注解

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

@Conditional拓展注解作用（判断是否满足当前指定条件）
@ConditionalOnJava容器中的java版本是否符合要求
@ConditionalOnBean容器中存在指定Bean
@ConditionalOnMissingBean容器中不存在指定Bean
@ConditionalOnExpression满足SpEL表达式指定
@ConditionalOnClass容器中有指定的类
@ConditionalOnMissingClass容器中没有指定的类
@ConditionalOnSingleCandidate容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty容器中指定的属性是否有指定的值
@ConditionalOnResource类路径下是否存在指定的资源文件
@ConditionalOnWebApplication当前是Web环境
@ConditionalOnNotWebApplication当前不是Web环境
@ConditionalOnJndiJNDI存在指定项

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

可以通过在application.properties里添加配置debug=true，然后运行系统，系统就会在在控制台里打印“自动配置报告”。

1
2

# application.properties
debug=true # 开启SringBoot的Debug模式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 自动配置报告
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches: # 匹配上的，启用的自动配置类
-----------------
   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
......
Negative matches: # 没有匹配上的，没启用的自动配置类
-----------------
   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
......
SprintBoot教程笔记
SpringBoot 学习笔记
最近更新
文章内容