一、配置文件作用

整个项目中所有重要的数据都是在配置文件中配置的，例如：

• 数据库的连接信息（包含⽤户名和密码的设置）；
• 项⽬的启动端⼝；
• 第三⽅系统的调⽤秘钥等信息；
• ⽤于发现和定位问题的普通⽇志和异常⽇志等。

想象⼀下如果没有配置信息，那么 Spring Boot 项⽬就不能连接和操作数据库，甚⾄是不能保存可以⽤于排查问题的关键⽇志。所以配置⽂件是⾮常重要的。

二、配置文件的格式

Spring Boot 配置⽂件主要分为以下两种格式：

• .properties
• .yml

如下图所示：

properties 类型的配置⽂件属于老款式 (创建 Spring Boot 项⽬默认的配置⽂件格式)；而 yml 属于新款式 ~~

配置文件内容：

1. Spring Boot (Spring) 内置的配置项，例如 server.port
2. 用户自定义的配置项 (要符合格式)

约定大于配置：

• 配置文件都必须以 “application” 起始。
• properties 是创建 Spring Boot 项⽬默认的配置⽂件格式。
• 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中，当 properties 和 yml ⼀起存在⼀个项⽬中时，如果配置⽂件中出现了同样的配置，例如 properties 和 yml 中都配置了“server.port”，那么这个时候会以 properties 中的配置为主，也就是 .properties 配置文件的优先级更高，但加载完 .properties 文件之后，也会加载 .yml 文件的配置信息。
• 虽然理论上来讲 .properties 可以和 .yml 共存，但在实际的业务中，我们通常会采取一种统一的配置文件格式，这样可以更好地维护（降低故障率）。

三、properties 配置文件说明

properties 配置⽂件是最早期的配置⽂件格式，也是创建 Spring Boot 项⽬默认的配置⽂件。

3.1 properties 基本语法

properties 是以键值对的形式配置的，key 和 value 之间是以“=”连接的，如：

# 配置项⽬端⼝号
server.port=8084
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root

配置⽂件中使⽤ “#” 添加注释。

3.2 读取配置文件

在项⽬中想要主动读取配置⽂件中的内容，可以使⽤ @Value 注解来实现。

@Value 注解使⽤ “ ${} ” 的格式读取！否则只是把字符串赋值给了变量。

server.port=9090

package com.example.demo;

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

@RestController
public class TestController {
    @Value("${server.port}")
    private int port;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi," + port;
    }
}

启动后，通过 http://localhost:9090/hi 访问：

成功打印出来了配置信息。

无论是内置的还是自定义的配置信息都可以这样打印出 ~~

3.3 properties 优缺点分析

properties 是以 key-value 的形式配置的，如下图所示：

优点：
写法简单，不易出错：等号前面是 key 值，等号后面是 value 值。

缺点：
properties 配置文件中可能会有很多的冗余信息，比如这些：

可以使用 yml 配置文件的格式化来解决这个问题 ~

四、yml 配置文件说明

yml 是 YAML 的缩写。全称为 Yet Another Markup Language，翻译成中文就是“另⼀种标记语⾔”。

创建配置文件为 application.yaml 效果一模一样！

4.1 yml 优点分析

• yml 是⼀个可读性⾼，写法简单、易于理解，它的语法和 JSON 语⾔类似。
• yml ⽀持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
• yml ⽀持更多的编程语⾔，它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中。

4.2 yml 基本语法

yml 是树形结构的配置文件，基础语法为“key: value”，注意 key 和 value 之间是 英文冒号加空格，其中的空格不可省略！

• 一级目录：
  
  第⼀项配置为正确的，key 也是高亮显示的；第⼆项没有空格为错误的使用，key 也没有高亮显示。

• 多级目录：(使用 yml 连接数据库)
  
  与 properties 的格式相比简化很多。

某级目录重复的话，必须要合并在一起！

yml 配置不同数据类型及 null：

4.3 yml 基本配置读取

针对简单数据类型， yml 读取配置的方式和 properties 相同，使用 @Value 注解即可。

注意事项：value 值加单双引号
字符串默认不⽤加单引号 / 双引号，如果加 英文单双引号 可以表示特殊的含义。

package com.example.demo;

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

@RestController
public class TestController {
    @Value("${mykey.str1}")
    private String str1;

    @Value("${mykey.str1}")
    private String str2;

    @Value("${mykey.str1}")
    private String str3;

    @RequestMapping("/hi")
    public void postConstruct() {
        System.out.println("str1:"+str1);
        System.out.println();
        System.out.println("str2:"+str2);
        System.out.println();
        System.out.println("str3:"+str3);
    }
}

启动后，通过 http://localhost:8080/hi 访问，这时控制台：

得出结论：

• 字符串默认不⽤加上单引号 / 双引号。
• 单引号会转义特殊字符，特殊字符最终只是⼀个普通的字符串数据。
• 双引号不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思。

有时候设置完配置并没有生效，可能是缓存导致的。解决方案：
删除项目中的 target 文件夹，然后重新运行程序 (target 会重新生成)！

4.4 配置对象与读取

前面提到 yml ⽀持更多的数据类型。
我们还可以在 yml 中配置对象，如下配置：

student:
  id: 1
  name: Java
  age: 18

或者是使用行内写法 (与上面的写法作用一致)：

student: {id: 1,name: Java,age: 18}

这个时候就不能⽤ @Value 来读取配置中的对象了，此时要使⽤另⼀个注解 @ConfigurationProperties 来读取，具体实现如下：

package com.example.demo.model;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "student") // 将配置文件中的 student 配置赋值给当前的对象
public class Student {
    private int id;
    private String name;
    private int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

package com.example.demo;

import com.example.demo.model.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    private Student student;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi," + student.getName() + " | age: " + student.getAge();
    }
}

启动后，通过 http://localhost:8080/hi 访问，结果：

成功读取到了！

约定大于配置：(注意事项)

• 配置对象的属性(字段)赋值是通过 setter 方法实现的。所以 setter 方法不能忽略，否则启动就会报错！
• @Component (五大类注解) 不能没有。既然要用，就要先放入 Spring 中。

4.5 配置集合与读取

配置⽂件也可以配置 List 集合，如下所示：

mylist:
  dbtype:
    - mysql
    - sqlserver
    - db2

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致）：

mylist: {dbtype: [mysql,sqlserver,db2]}

集合的读取和对象⼀样，也是使⽤ @ConfigurationProperties 来读取的，具体实现如下：

package com.example.demo.model;

import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Setter
@Getter
@ConfigurationProperties(prefix = "mylist")
@Component
public class MyList {
    private List dbtype;
}

package com.example.demo;

import com.example.demo.model.MyList;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    private MyList myList;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi,"+ myList.getDbtype().size()+" | get(0):"+myList.getDbtype().get(0);
    }
}

通过 http://localhost:8080/hi 访问：

成功读取到了！

约定大于配置：(注意事项)

• 配置集合名 与 类属性名…等 一定要对应准确，一字不差！
• 配置集合的赋值同样是通过 setter 方法实现的。
• 不需要设置List泛型；若设置了一定要对应。

五、设置不同环境的配置文件

5.1 创建不同环境的配置文件

环境是很多的，这里只是举这三个为例 ~~

除了主配置文件 application.yml，创建 application-dev.yml (开发环境)；application-test.yml (测试环境)；application-prod.yml (生产环境) 的配置文件。

application- 这个格式不能变！

5.2 在 application.yml 中设置运行环境

在 application.yml 中设置运行环境：

spring:
  profiles:
    active: dev # test / prod

设置为 dev 的话，此时配置信息就是 application.yml 和 application-dev.yml 的配置信息 ~~

附录

1）Spring Boot 读取配置文件的 N 种方法

https://juejin.cn/post/7132641888166739982

2）更多系统配置项

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties