配置文件

约 385 字大约 1 分钟

2026-05-11

使用

在创建 SpringBoot 项目后，在 resources 文件夹下会默认创建一个 application.properties 文件，这是 SpringBoot 默认的配置文件，用于配置一些项目的信息。

配置文件还可以使用另一种格式 application.yml 或 application.yaml，与 application.properties 的区别是 yml 文件使用缩进进行格式化。

application.properties

spring.application.name=demo
server.servlet.context-path=/api
server.port=8080

application.yml/application.yaml

spring:
  application:
    name: demo
server:
  port: 8080
  servlet:
    context-path: /api

由于 yml/yaml 文件使用缩进进行格式化，但同属性名多时，解构比 properties 文件更清晰，因此项目开发中更多使用 yml/yaml 文件进行配置。

获取配置信息

当我们需要在代码当中获取一些全局的配置信息时，例如邮箱信息，可以使用 @Value 注解或者 @ConfigurationProperties 注解。

emnail:
  from: [email protected]
  code: xxxxx
  host: smtp.enail.com

@Value

使用 @Value 注解获取配置信息需要全匹配配置项，例如 email.from 配置项，那么 @Value("${email.from}") 才能获取到该配置项的值。

@Component
public class EmailService {

    @Value("${email.from}")
    private String from;
  
    @Value("${email.code}")
    private String code;
  
    @Value("${email.host}")
    private String host;
}

但需要获取同一 key 中多个属性时，不难看到需要多次用 @Value 注解书写多次相同属性，因此 @ConfigurationProperties 注解就更为方便。

@ConfigurationProperties

@ConfigurationProperties 只需要提供一个前缀，只要成员变量名与属性相同就可以获取到该属性的值。

@Component
@ConfigurationProperties(prefix = "email")
public class EmailService {
    private String from;
    private String code;
    private String host;
}