SpringBoot配置文件-application.yml

目录

1 配置文件后缀.yml(yaml)与.properties

2 yml的书写

2.1 yml的规范

2.2 配置信息举例

3 yml的获取

3.1 获取的方式

3.2 举例

3.2.1 @Value("${键名}")

3.2.2 @ConfigurationProperties(prefix = "前缀")

---

1 配置文件后缀.yml(yaml)与.properties

两者均可以被SpringBoot项目自动识别，用于三方技术配置信息(如：mybatis)和自定义配置信息（如：自己写的工具类），但是两者的书写规范却有差异。现在以端口号和项目路径配置为例，直观的来看一下。

当使用.properties时：

server.port=8081
server.servlet.context-path=/test

当使用.yml时

server:
    port: 8081
    servlet:
        context-path: /test

我们可以看到.yml的层次显然更加清晰，正是这种差异，我们更多的会使用.yml作为application的后缀。

2 yml的书写

2.1 yml的规范

①值前至少要有一个空格，作为分隔符，eg:

port: 8081是正确的，但是port:8081运行却会报错

②使用缩进表示层级，相同层级缩进应相同（有点像Python），eg:

如上述1配置文件后缀的示例中，server与port就是不同层级，port和servlet是相同层级

2.2 配置信息举例

三方技术配置信息(有提示)和自定义配置信息的书写基本一样，现举两个自定义配置信息的例子：

①我们自定义了一个JDBCUtil类，我们之前的老做法是将username和password写在类中，如下：

public class JDBCUtil {
    private String username = "XXX";
    private String password = "YYY";
    //其它代码
}

但是系统的学习后，我们发现这样并不合适，因此我们会将其写入配置文件，方便修改和维护，如下：

jdbc:
    username: XXX
    password: YYY

之所以前面加了个jdbc层级，是为了避免与以后可能出现的相同名字的配置发生冲突

②数组相关的配置

color:
    - yellow
    - blue
    - red

 color数组中的不同元素以横杆作为分隔，逐个进行配置，注意：横杆与值之间同样有空格

3 yml的获取

3.1 获取的方式

①@Value("${键名}")

逐个进行获取

②@ConfigurationProperties(prefix = "前缀")

一次性进行获取，不过要保证成员变量的名字与配置文件里的名字要保持一致，比如都是username

3.2 举例

均以3.1的第一个例子JDBCUtil类的获取进行说明

3.2.1 @Value("${键名}")

@Component
public class JDBCUtil {
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
}

3.2.2 @ConfigurationProperties(prefix = "前缀")

@ConfigurationProperties(prefix = "jdbc")
@Component
public class JDBCUtil {
    private String username;
    private String password;
}

此时，如果配置文件中的变量数目或名字与类中的不一致，那么只会按照名字获取对应的值，不会报错。