配置文件

一、配置文件

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

• application.properties
• application.yml

配置文件的作用：修改SpringBoot自动配置的默认值（SpringBoot在底层自动配置好）

配置文件放在src/main/resources目录或者类路径/config下。

yml是YAML（YAML Ain't Markup Language）语言的文件，以数据为中心，比json，xml更适合做配置文件。

YAML(YAML Ain't Markup Language)

YAML A Markup Language：是一个标记语言

YAML isn't Markup Language：不是一个标记语言

二、YAML语法

1，基本语法

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

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

server:
   port:8080
   path:/hello

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

2，值的写法

1）字面量: 普通的值（数字，字符串，布尔）

k: v  ：字面直接来写

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

""(双引号)：不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思。如：name: "zhangsan \n lisi"   输出: zhangsan 换行 lisi

''(单引号)：会转义特殊字符，特殊字符最终只是一个普通的字符串数据。如：name: 'zhangsan \n lisi'  输出:   zhangsan \n lisi

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

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

对象还是k:v的方式

friends:
    lastname: zhangsan
    age: 20

行内写法：

friends: {lastname: zhangsan,age: 18}

3）数组（List、Set）

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

pets:
  - cat
  - dog
  - pig

行内写法

pets: [cat,dog,pig]

三、配置文件注入值

配置文件

person:
  lastName: 李四
  age: 20
  boss: true
  birth: 2017/11/12
  maps: {k1: v1,k2: v2,K3: v3}
  list:
    - lisi
    - wangwu
  dog:
    name: tom
    age: 3

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;

    private Map<String,Object> maps;
    private List<Object> list;
    private Dog dog;

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

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

除了使用application.yml文件进行配置，还是使用application.properties文件进行配置

person.lastName=张三
person.age=20
person.boss=true
person.birth=2010/10/1
person.maps.k1=v1
person.maps.k2=v2
person.maps.k3=v3
person.list=a,b,c
person.dog.name=tom
person.dog.age=3

运行程序，发现出现中文乱码，这是因为properties配置文件在idea中默认utf-8可能会乱码。

 需要调整一下，properties文件采用的是ascll码，而idea默认的是utf-8，需要设置运行的时候转换一下。

 除了使用@ConfigurationProperties注解注入外，还可以使用@Value注解注入

2，@Value获取值和@ConfigurationProperties获取值比较

配置文件无论yml还是properties他们都能获取到值，但是需要根据具体的业务场景具体使用。

• 只是在某个业务逻辑中获取一下配置文件中的某项值，使用@Value
• 专门编写了一个javabean来和配置文件进行映射，就使用@ConfigurationProperties

@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;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;

当配置文件中lastName的值必须是邮箱格式，否则会注入失败。

3，@PropertySource&@ImportResource&@Bean

@PropertySrouce：加载指定的配置文件

类似person类有很多，所有的配置都放在全局配置文件中（application.yml和application.properties）。需要把这部分内容提取出来，放在一个properties文件中，然后使用@propertySource注解加载这些文件。

resources目录下的person.properties文件

person.lastName=张三
person.age=20
person.boss=true
person.birth=2010/10/1
person.maps.k1=v1
person.maps.k2=v2
person.maps.k3=v3
person.list=a,b,c
person.dog.name=tom
person.dog.age=3

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

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

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

<?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.company.service.HelloService"></bean>
</beans>

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

SpringBoot推荐给容器中添加组件的方式，推荐使用全注解的方式。

1，配置类@Configuration 替换Spring配置文件

2，使用@Bean给容器添加组件

/**
* @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
* 在配置文件中用<bean><bean/>标签添加组件
*
*/
@Configuration
public class MyAppConfig {
   //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
   @Bean
   public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
   }
}

四、配置文件占位符

随机数

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

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

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.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

五、Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境。

1，多Profile文件

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

如：application-prod.yml，application-dev.yml，application-test.yml

默认使用application.properties的配置

2，yml支持多文档块方式，三个中横线---来隔开。

server:
    port: 8081
spring:
    profiles:
        active: prod
‐‐‐
server:
    port: 8083
spring:
    profiles: dev
‐‐‐
server:
    port: 8084
spring:
    profiles: prod #指定属于哪个环境

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.proflies.active=dev

 六、配置文件加载位置

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

1. -file:./config
2. -file:./
3. -classpath:/config/
4. -classpath:/

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

还可以通过spring.config.location来改变默认的配置文件位置。

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

java -jar helloworld-02-0.0.1-SNAPSHOT.jar --spring.config.location=d:/application.properties

七、外部配置加载顺序

springboot支持多种外部配置方式。

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

1，命令行参数

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

java -jar helloword-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc

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

2，来自java:comp/env的JNDI属性

3，java系统属性（System.getProperties()）

4，操作系统环境变量

5，RandomValuePropertySource配置的random.*属性值

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

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

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

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

10，@Configuration注解类上的@PropertySource

11,通过SpringApplicationsetDefaultProperties指定的默认属性

所有支持的配置加载来源

参考官方文档