全局配置文件

### 1.5 全局配置文件

全局配置文件能够对一些默认配置值进行修改。Spring Boot使用一个application.properties或者application.yaml的文件作为全局配置文件，该文件存放在src/main/resource目录或者类路径的/config，一般会选择resource目录。接下来，将针对这两种全局配置文件进行讲解 ：

#### 1.5.1 application.properties配置文件

使用Spring Initializr方式构建Spring Boot项目时，会在resource目录下自动生成一个空的application.properties文件，Spring Boot项目启动时会自动加载application.properties文件。

我们可以在application.properties文件中定义Spring Boot项目的相关属性，当然，这些相关属性可以是系统属性、环境变量、命令参数等信息，也可以是自定义配置文件名称和位置

```properties

server.port=8081

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.config.additional-location=

spring.config.location=

spring.config.name=application

```

接下来，通过一个案例对Spring Boot项目中application.properties配置文件的具体使用进行讲解

演示：

预先准备了两个实体类文件，后续会演示将application.properties配置文件中的自定义配置属性注入到Person实体类的对应属性中

（1）先在项目的com.lagou包下创建一个pojo包，并在该包下创建两个实体类Pet和Person

```java

public class Pet {

private String type;

private String name;

// 省略属性getXX()和setXX()方法

// 省略toString()方法

}

```

```java

@Component //用于将Person类作为Bean注入到Spring容器中

@ConfigurationProperties(prefix = "person") //将配置文件中以person开头的属性注入到该类中

public class Person {

private int id; //id

private String name; //名称

private List hobby; //爱好

private String[] family; //家庭成员

private Map map;

private Pet pet; //宠物

// 省略属性getXX()和setXX()方法

// 省略toString()方法

}

```

@ConfigurationProperties(prefix = "person")注解的作用是将配置文件中以person开头的属性值通过setXX()方法注入到实体类对应属性中

@Component注解的作用是将当前注入属性值的Person类对象作为Bean组件放到Spring容器中，只有这样才能被@ConfigurationProperties注解进行赋值

（2）打开项目的resources目录下的application.properties配置文件，在该配置文件中编写需要对Person类设置的配置属性

<img src="./images/image-20191225151413976.png" alt="image-20191225151413976" style="zoom:67%;" />

​ 编写application.properties配置文件时，由于要配置的Person对象属性是我们自定义的，Spring Boot无法自动识别，所以不会有任何书写提示。在实际开发中，为了出现代码提示的效果来方便配置，在使用@ConfigurationProperties注解进行配置文件属性值注入时，可以在pom.xml文件中添加一个Spring Boot提供的配置处理器依赖:

```xml

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-configuration-processor</artifactId>

<optional>true</optional>

</dependency>

```

​ 在pom.xml中添加上述配置依赖后，还需要重新运行项目启动类或者使用“Ctrl+F9”快捷键（即Build Project）重构当前Spring Boot项目方可生效

（3）查看application.properties配置文件是否正确，同时查看属性配置效果，打开通过IDEA工具创建的项目测试类，在该测试类中引入Person实体类Bean，并进行输出测试

```java

@RunWith(SpringRunner.class) // 测试启动器，并加载Spring Boot测试注解

@SpringBootTest // 标记为Spring Boot单元测试类，并加载项目的ApplicationContext上下文环境

class SpringbootDemoApplicationTests {

// 配置测试

@Autowired

private Person person;

@Test

void configurationTest() {

System.out.println(person);

}

}

```

打印结果：


可以看出，测试方法configurationTest()运行成功，同时正确打印出了Person实体类对象。至此，说明application.properties配置文件属性配置正确，并通过相关注解自动完成了属性注入

#### 1.5.2 application.yaml配置文件

YAML文件格式是Spring Boot支持的一种JSON超集文件格式，相较于传统的Properties配置文件，YAML文件以数据为核心，是一种更为直观且容易被电脑识别的数据序列化格式。application.yaml配置文件的工作原理和application.properties是一样的，只不过yaml格式配置文件看起来更简洁一些。

* YAML文件的扩展名可以使用.yml或者.yaml。

* application.yml文件使用 “key:（空格）value”格式配置属性，使用缩进控制层级关系。

这里，针对不同数据类型的属性值，介绍一下YAML

（1）value值为普通数据类型（例如数字、字符串、布尔等）

​ 当YAML配置文件中配置的属性值为普通数据类型时，可以直接配置对应的属性值，同时对于字符串类型的属性值，不需要额外添加引号，示例代码如下

```yaml

server:

port: 8081

path: /hello

```

​ 上述代码用于配置server的port和path属性，port和path属于一个级别

（2）value值为数组和单列集合

当YAML配置文件中配置的属性值为数组或单列集合类型时，主要有两种书写方式：缩进式写法和行内式写法。

其中，缩进式写法还有两种表示形式，示例代码如下

```yaml

person:

hobby:

- play

- read

- sleep

```

​ 或者使用如下示例形式

```yaml

person:

hobby:

play,

read,

sleep

```

上述代码中，在YAML配置文件中通过两种缩进式写法对person对象的单列集合（或数组）类型的爱好hobby赋值为play、read和sleep。其中一种形式为“-（空格）属性值”，另一种形式为多个属性值之前加英文逗号分隔（注意，最后一个属性值后不要加逗号）。

```yaml

person:

hobby: [play,read,sleep]

```

​ 通过上述示例对比发现，YAML配置文件的行内式写法更加简明、方便。另外，包含属性值的中括号“[]”还可以进一步省略，在进行属性赋值时，程序会自动匹配和校对

（3）value值为Map集合和对象

当YAML配置文件中配置的属性值为Map集合或对象类型时，YAML配置文件格式同样可以分为两种书写方式：缩进式写法和行内式写法。

其中，缩进式写法的示例代码如下

```yaml

person:

map:

k1: v1

k2: v2

```

对应的行内式写法示例代码如下

```yaml

person:

map: {k1: v1,k2: v2}

```

在YAML配置文件中，配置的属性值为Map集合或对象类型时，缩进式写法的形式按照YAML文件格式编写即可，而行内式写法的属性值要用大括号“{}”包含。

接下来，在Properties配置文件演示案例基础上，通过配置application.yaml配置文件对Person对象进行赋值，具体使用如下

（1）在项目的resources目录下，新建一个application.yaml配置文件，在该配置文件中编写为Person类设置的配置属性

```yaml

对实体类对象Person进行属性配置

person:

id: 1

name: lucy

hobby: [吃饭，睡觉，打豆豆]

family: [father,mother]

map: {k1: v1,k2: v2}

pet: {type: dog,name: 旺财}

```

（2）再次执行测试


可以看出，测试方法configurationTest()同样运行成功，并正确打印出了Person实体类对象。

需要**说明**的是，本次使用application.yaml配置文件进行测试时需要提前将application.properties配置文件中编写的配置注释，这是因为application.properties配置文件会覆盖application.yaml配置文件