SpringBoot-application.yml配置文件的用法

bootstrap.yml与application.yml

简介

bootstrap与application都有两种配置格式：yml格式与properties格式。

项	bootstrap.yml	application.yml
加载顺序	先于 application.yml 加载	后于 bootstrap.yml 加载
作用	在程序引导时执行，应用于更加早期配置信息读取。如可以使用来配置application.yml中使用到参数等。	应用程序特有配置信息，可以用来配置后续各个模块中需使用的公共参数等

技术上，bootstrap.yml 是被一个父级的 Spring ApplicationContext 加载的。这个父级的 Spring ApplicationContext是先加载的，在加载application.yml 的 ApplicationContext 之前。

为何需要把 config server 的信息放在 bootstrap.yml 里？

答：当使用 Spring Cloud 的时候，配置信息一般是从 config server 加载的，为了取得配置信息（比如密码等），你需要一些提早的引导配置。因此，把 config server 信息放在 bootstrap.yml，用来加载在这个时期真正需要的配置信息。

bootstrap典型应用场景

1. 当使用 Spring Cloud Config Server的时候，你应该在 bootstrap.yml里面指定 spring.application.name和 spring.cloud.config的配置项
2. 一些加密/解密的信息

应用配置优先级

官网文档

SpringBoot 外部配置

简介

Spring Boot 的应用配置可使用properties或yml 文件等，在高优先级里设置的属性都会覆盖低优先级的相同属性。如果高优先级里没有设置某个属性，则会使用低优先级的设置的属性值。

优先级整体顺序

1. Devtools全局设置属性在你的主目录(~/.spring-boot-devtools.properties当devtools处于激活状态时）。
2. 测试中的@TestPropertySource注解
3. 测试中的@SpringBootTestproperties注解属性
4. 命令行参数；
   1. 法1：命令行指定
      1. java -jar demo.jar –server.port=8081
   2. 法2：指定配置文件
      1. 法1：java -jar myproject.jar –spring.config.location=classpath:/default.properties,classpath:/override.properties
      2. 法2：java -jar -Dspring.config.location=D:\config\config.properties springbootrestdemo-0.0.1-SNAPSHOT.jar 
5. 来自SPRING_APPLICATION_JSON（嵌入在环境变量或系统属性中的内联JSON）的属性
6. ServletConfig初始化参数
7. ServletContext初始化参数
8. 来自 java:comp/env 的 JNDI 属性；
9. Java 系统属性 （System.getProperties());
10. 操作系统环境变量；
11. RandomValuePropertySource 配置的 random. *属性值；
12. jar 包外部的 application-{profile}.properties 或 application.yml (带 spring.profile)配置文件；
13. jar 包内部的 application-{profile}.properties 或 application.ym (带 spring.profile)配置文件；
14. jar 包外部的 application.properties 或 application.yml (不带 spring.profile)配置文件；
15. jar 包内部的 application.properties 或 application.yml (不带 spring.profile)配置文件；
16. @Configuration 注解类上的 @PropertySource;
17. 通过 SpringApplication.setDefaultProperties 指定的默认属性。

配置文件的优先级

使用配置文件的方式时，Spring程序会按下边路径从上到下的优先级顺序：

jar 包同级路径的config目录
jar 包同级路径
classpath（即resources）的config目录
classpath（即resources）根目录

若同目录下存在application.properties与application.yml，application.properties优先级高。

优先级如下图所示

实例

配置文件

我在上边四个文件中分别加入一些内容：

项目根目录/config/application.yml：

firstName: Tony(/config/application.yml)

项目根目录/application.yml：

firstName: Tony(/application.yml)

resources/config/application.yml：

firstName: Tony(resources/config/application.yml)

resources/application.yml：

firstName: Tony(resources/application.yml)

controller代码

package com.example.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @Value("${firstName}")
    private String firstName;

    @GetMapping("/test1")
    public String test1() {
        return firstName;
    }
}

测试

访问：http://localhost:8080/test1

结果：（获得的是优先级最高的（项目根目录/config/application.yml）里的配置）

Tony(/config/application.yml)

把上边“项目根目录/config/application.yml”里边的firstName项删除。

访问：http://localhost:8080/test1

结果：（获得的是优先级第二高的（项目根目录/application.yml）里的配置）

Tony(/application.yml)

jar包实例

测试上边“工程目录示例”的程序

打包（可以发现，项目根目录/config/application.yml和项目根目录/application.yml都没被打包进去）

测试

使用java -jar demo_SpringBoot-0.0.1-SNAPSHOT.jar来运行

访问：http://localhost:8080/test1

结果：

Tony(resources/config/application.yml)

在jar包同级路径添加配置文件

配置

config/application.yml：

firstName: Tony(/config/application.yml)

application.yml：

firstName: Tony(/application.yml)

测试

使用java -jar demo_SpringBoot-0.0.1-SNAPSHOT.jar来运行

访问：http://localhost:8080/test1

结果：

Tony(/config/application.yml)

application.properties

配置示例

# 服务器配置
server.port=8080 #端口号设置

# 数据库配置
spring.datasource.url = jdbc:mysql://localhost:3306/DatebaseName（自己数据库名）
spring.datasource.username = root
spring.datasource.password = 123
spring.datasource.driverClassName = com.mysql.jdbc.Driver

application.yml

yml/yaml-配置文件的用法 – 自学精灵

配置示例

# 服务器配置
server:
  port: 8082

# spring配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/DatebaseName
    username: root
    password: 123
    driverClassName: com.mysql.jdbc.Driver

配置大全

其他网址 

springboot官网配置（英文）

其他

WebMvcConfigurationSupport

注意：如果继承了WebMvcConfigurationSupport对mvc进行配置，则yml的配置会无效。例如：

public class WebMvcConfig extends WebMvcConfigurationSupport{}

原因：WebMvcAutoConfiguration有个条件注解：@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)

也就是说，当缺少WebMvcConfigurationSupport.class实现类的时候，才会使用yml的自动配置。