【JavaEE Spring】SpringBoot 配置文件详解

1. 配置文件的作用

配置文件是用来配置项目中重要的数据的，比如：

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

配置⽂件的作用是⾮常重要的！

2. SpringBoot配置文件的格式

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

• .properties
• .yml
  
  properties属于“老版”配置文件格式，也是SpringBoot项目默认的文件格式，yml属于新版文件格式，可以表示的信息也更多（详细见下文）

特殊说明：

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

3. 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

（配置⽂件中使⽤“#”来添加注释信息，#后边是否有空格不作要求，看个人习惯）
注意等号=两边不能有空格分开，要挨在一起写，并且等号右边内容写完了之后也要避免空格，避免出现配置文件识别bug

3.2 读取配置文件

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

@Value 注解使⽤**“${}**”的格式读取，如下代码所示：

@Component
public class ReadProperties {
    @Value("${server.port}")
    private String port;

    @PostConstruct
    public void postConstruct(){
        System.out.println("port:"+port);
    }
}

读取成功~

@Component 在 Spring Boot 启动时候会注⼊到框架中，注⼊到框架中时会执⾏ @PostConstruct 初始化⽅法，这个时候就能读取到配置信息了。

3.3 properties 缺点分析

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

从上述配置key看出，properties 配置⽂件中会有很多的冗余的信息，⽐如这些：

想要解决这个问题，就可以使⽤ yml 配置⽂件格式~

4. yml配置文件说明

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

yml 是⼀个可读性⾼，易于理解，并且可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。

yml 最⼤的优势是可以跨语言，不止是 Java 中可以使⽤ golang、python 都可以使⽤ yaml 作为配置文件。

4.1 yml 基本语法

yml 是树形结构的配置⽂件，它的基础语法是“key: value”，注意 key 和 value 之间使⽤英文冒号+空格的⽅式组成的，其中的空格不可省略。

其中第⼀项的配置为正确的，key 也是⾼亮显示的，⽽第⼆项没有空格是错误的使⽤⽅式，第⼆项的key 也没有⾼亮显示。

示例：使⽤ yml 连接数据库

yml 和 properties 连接数据库的配置对比：

4.2 yml 使用进阶

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

4.2.2 yml 配置读取

yml 读取配置的⽅式和 properties 相同，使⽤ @Value 注解即可，实现代码如下：

@Component
public class ReadYml {
    @Value("${string.value}")
    private String hello;

    @PostConstruct
    public void postConstruct(){
        System.out.println("read yml:hello"+hello);
    }
}

注意：如果读取不存在的key的value时springboot启动会报错：


如果读取key存在值为null（~）时，读取出来的内容是一个空字符：

4.3 value 值加单双引号的问题

字符串默认不⽤加上单引号或者双引号，如果加英⽂的单双引号可以表示特殊的含义。

如：

尝试读取这几个配置信息：

结果如下：

从上述结果可以得出以下结论：

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

4.4 使用yml配置对象

在 yml 中配置对象，如下配置：

或者是使用行内写法（与上面写法作用一致）：

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

package com.example.demo;

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

@ConfigurationProperties(prefix = "student")
@Component
public class StudentComponent {
    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;
    }
    @Override
    public String toString() {
        return "StudentComponent{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

（注意：以上代码中的 getter 和 setter ⽅法不能省略。也可以使用@Data注解达到相同作用）

调用类的实现如下：

@Component
public class ReadYmlBean {

    @Autowired //属性注入（对象注入）
    private StudentComponent studentComponent;

    @PostConstruct //前置方法
    public void postConstruct(){
        System.out.println(studentComponent);
    }
}

启动springboot：

读取对象成功~

4.5 使用yml配置集合

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

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致，表示集合时推荐这个写法）：

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

@Component
@ConfigurationProperties(prefix = "dbtypes2")
@Data
public class ListConfig {
    private List<String> name;

// 使用@Data注解的作用相当于可以省略以下两个方法（get/set）
 public List<String> getName() {
        return name;
    }

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

打印类实现如下：

@Component
public class ReadYmlList {

    @Autowired
    private ListConfig listConfig;

    @PostConstruct
    public void postConstruct(){
        System.out.println(listConfig.getName());
    }
}

启动springboot：

打印集合内容成功~

4.6 查看更多系统配置项

想要查看spring boot 更多系统配置项，还可以访问官网 ：官网链接，点击跳转

5. properties VS yml 总结

• properties 是以 key=value 的形式配置的键值类型的配置⽂件，而 yml 使⽤的是类似 json 格式的树形配置方式进⾏配置的，yml 层级之间使⽤换行缩进的⽅式配置，key 和 value 之间使⽤“: ”英文冒号加空格的⽅式设置，并且空格不可省略。

• properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的解决数据冗余的问题。

• yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使用⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件。

• yml 虽然可以和 properties 共存，但⼀个项⽬中建议使用统⼀的配置类型文件。

• over ~~