SpringBoot（四）配置文件

发表于 更新于 分类于 阅读次数： 本文字数： 4.9k 阅读时长 ≈ 4 分钟

关于 SpringBoot 配置文件，在之前的文章中已经提到配置文件格式，主要是两种格式的配置，这里并没有哪个配置写法一定优于另一种写法，对于配置文件名（application.yml 或者 application.properties），可以更改，为了减少不必要的麻烦，不建议修改，本篇文章以 yml 文件作为示例

本篇文章示例代码见：springboot-config

YAML

YAML是JSON的超集，因此是用于指定分层配置数据的便捷格式。只要在类路径上有SnakeYAML库，SpringApplication类就会自动支持YAML作为属性的替代 。

语法规则

  • 大小写敏感
  • 缩进（只能使用空格，空格数量不重要）表示层级
  • 注释用 # 符号

数据结构

  1. 不可再分的单个的值，如数字，字符串等。 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    env: dev
    crate-date: 2020
    is-mac: true

    # ~表示NULL值
    email: ~

    # 多行字符串可以使用 | 保留换行符，也可以使用 > 折叠换行
    # + 表示保留文字块末尾的换行，- 表示删除字符串末尾的换行
    message: |-
      hello world ${crate-date}

    # 单引号
    # 会转义特殊字符，特殊字符最终只是一个普通的字符串数据
    # 输出：mac \n catalina
    name1: 'mac \n catalina'

    # 双引号
    # 不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思
    # 输出：mac
    # catalina
    name2: "mac \n catalina"
  2. 数组，一组按次序排列的值 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    # 这种写法，必须有两层结构，而且第二层（language 名字）是必须满足 Java 属性字段命名规则
    list:
      language:
        - 'object-c'
        - 'swift'
        - 'c'
    # 或者行内写法
    list-program-languages: object-c, swift, c
    # SpEL 获取数组
    el:
      list: object-c, swift, c
  3. 对象，键值对的集合 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    # 对象
    object:
      name: Jerry
      age: 20

    # 或者行内写法
    persons: { name: Jerry, age: 20 }

    # Map
    map-object:
      map:
        key1: value1
        key2: value2

    # 或者行内写法
    mapObjects.maps: { key1: value1,key2: value2 }
  4. 随机数 
    1
    2
    3
    4
    5
    # 随机数
    secret: ${random.value}
    number: ${random.int}
    bignumber: ${random.long}
    uuid: ${random.uuid}
  5. 默认值，占位符获取之前配置的值，如果没有可以是用:指定默认值
    1
    2
    bootapp.name: SpringBoot
      description: ${bootapp.name}是一个spring应用程序
  1. : 号后面有一个空格
  2. 对于复杂的数据结构（对象，List，Map），需要配套 @ConfigurationProperties 定义对应的对象

配置

为了在配置自定义属性时，向配置 SpringBoot 属性自动提示的功能，导入如下的包

1
2
3
4
5
6
7
8
9
10
11
12
<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
<!-- @ConfigurationProperties annotation processing (metadata for IDEs)
         生成spring-configuration-metadata.json类，需要引入此类-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
</dependency>

或者在 gradle 配置文件中添加依赖

1
2
compileOnly 'org.springframework.boot:spring-boot-configuration-processor'
annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"

如果任然无法自动提示，请查看你的编辑器 IDEA 中是否开启了 Annonation Processing
idea-annotation-processors

定义配置

默认配置

Common application properties，是 SpringBoot 官方提供的一些默认配置属性说明，如果需要更改，只需要在 application.yml 文件中重写该属性即可，比如重新设置服务的启动端口为 9090

1
2
server:
  port: 9090

自定义配置

首先在 application.yml 文件中根据上面所述的规则写法进行自定义字段的声明

1
2
3
myConfig:
  maps:
    key: value

配置的使用

@Value @ConfigurationProperties @PropertySource
使用场景 单一属性注入，注解写在类的属性上 批量注入，注解写在类上 加载自定义配置文件，用于静态类获取配置文件中定义的信息
松散语法 不支持 支持 支持
SpEL 支持 不支持 支持
JSR-303 数据校验 @Validated 不支持 支持 支持
复杂类型（数组，Map，对象等） 不完全支持（数组支持行内定义） 支持 支持

ConfigurationProperties

@ConfigurationProperties 注解是 SpringBoot提供的一种使用属性的注入方法，不仅可以方便的把配置文件中属性值与所注解类绑定，还支持松散绑定，JSR-303 数据校验等功能

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/**
 * 使用 @ConfigurationProperties 配置属性必须是小写，多单词之间可用'-'连接
 *
 * @author : Jerry xu
 * @since : 2020/3/29  16:26
 */
@Data
@Component
@ConfigurationProperties(prefix = "list")
public class ConfigListBean {

    /**
     * 这里不能再用 @Value("") 去加载，修饰当前的字段，
     * 必须指定其属性名和配置文件中定义的名称一致
     */
    private List<String> language;

}

Value

@Value 注解支持直接从配置文件中读取值，同时支持 SpEL 表达式，但是不支持复杂数据类型和数据验证

使用 @Value 获取配置文件中定义的值，通常其类是被 @Controller，@Service，@Component 等注解修饰，如果是一般普通的类（如一些工具类）并 不能 只接获取到配置文件中定义的值

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@Data
@Component
public class GradleDataBean {

    @Value("${env}")
    private String env;
    @Value("${crate-date}")
    private Integer createDate;
    @Value("${is-mac}")
    private Boolean isMac;
    @Value("${email}")
    private String email;
    @Value("${message}")
    private String message;
    @Value("${name1}")
    private String name1;
    @Value("${name2}")
    private String name2;

    @Value("${list-program-languages}")
    private List<String> programLanguages;
    
    /**
     * 使用el表达式，获取定义数组
     */
    @Value("#{'${el.list}'.split(',')}")
    private List<String> programList;

    @Value("${secret}")
    private String secret;
    @Value("${number}")
    private Integer number;
    @Value("${bignumber}")
    private Long bigNumber;
    @Value("${uuid}")
    private String uuid;
}

PropertySource

@PropertySource 注解加载自定义配置文件，由于 @PropertySource 指定的文件会优先加载，所以如果在 applocation.properties 文件中存在相同的属性配置，会覆盖前者中对应的值，且 @PropertySource 不支持 yml 文件注入

多环境配置

在实际的开发中，不同环境对应不同的配置，因此我们需要根据环境来配置不同的项目配置信息，SpringBoot 也是支持我们进行多环境的配置，通常情况下，我们命名为 application-{profile}.properties/yml ，其中
{profile}表示不同的环境，比如：dev（开发），prod（线上） 等

关于具体的多环境配置，可以参考文章 SpringBoot（五）多环境配置

配置文件加载顺序

Spring Boot 启动会扫描以下位置的配置文件（application.properties 或 application.yml） 作为Spring Boot 的默认配置文件

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

加载顺序可以查看下图
application-sort

优先级从高到低，高优先级的配置会覆盖低优先级的配置

参考

  • 介绍两种SpringBoot读取yml文件中配置数组的方法
  • Spring的@Value可以注入复杂类型吗？今天教你通过@value注入自定义类型
  • Properties and Configuration