SpringBoot读取配置文件常用方法解析

在SpringBoot应用中，读取配置文件是十分常见的操作，SpringBoot为读取配置文件提供了多种方式，下面对这些方法进行详细解析。

1. 使用@Value注解

@Value注解是Spring框架中常用的用于获取配置文件中属性值的注解，也可以用于将自定义配置属性值注入到Spring管理的Bean中。使用方法如下：

@Value("${property.name}")
private String propertyName;

其中，${}中的property.name即为在application.properties或application.yml中定义的配置属性名称。

示例：

application.yml文件内容如下：

info:
  app:
    name: MyApplication

使用@Value注解读取application.yml中的info.app.name配置属性值：

@Value("${info.app.name}")
private String appName;

2. 使用Environment对象

Environment是Spring框架中读取配置文件的核心类，其可获取由Spring加载的所有环境属性和属性源。使用方法如下：

@Autowired
private Environment env;

public void printProperties() {
    for (String profileName : env.getActiveProfiles()) {
        logger.info("Current profile is: {}", profileName);
    }
    logger.info("Property from application.properties: {}", env.getProperty("property.name"));
    logger.info("Property from application.yml: {}", env.getProperty("info.app.name"));
}

其中，env.getActiveProfiles()方法可获取当前活跃的profile名称，env.getProperty(String)方法可获取配置文件中指定的属性值。

示例：

application.yml文件内容如下：

spring:
  profiles:
    active: prod

info:
  app:
    name: MyApplication

使用Environment对象读取以上配置文件中的属性值，并输出到控制台：

@Autowired
private Environment env;

public void printProperties() {
    logger.info("Current active profile is: {}", env.getActiveProfiles()[0]);
    logger.info("Application name is: {}", env.getProperty("info.app.name"));
}

3. 使用@ConfigurationProperties注解

@ConfigurationProperties注解是Spring框架中读取自定义配置属性的注解，使用方法如下：

首先，在配置类上添加@Configuration和@ConfigurationProperties(prefix = "prefixName")注解，其中prefixName为配置文件中自定义配置属性的前缀。

@Configuration
@ConfigurationProperties(prefix = "myapp")
public class AppConfig {
    private String name;
    private String version;
    // getter 和 setter 方法
}

然后，在application.properties或application.yml文件中添加以prefixName为前缀的自定义配置属性：

myapp.name = MyApplication
myapp.version = 1.0

此时，SpringBoot会将读取的自定义配置属性值注入到AppConfig对象中，可通过@Autowired注解将其注入到需要使用的Bean中。

示例：

application.yml文件内容如下：

myapp:
  name: MyApplication
  version: 1.0

创建一个自定义的配置类AppConfig，并使用@ConfigurationProperties注解读取application.yml中的配置属性值：

@Configuration
@ConfigurationProperties(prefix = "myapp")
public class AppConfig {
    private String name;
    private String version;

    // getter 和 setter 方法

    @Override
    public String toString() {
        return "AppConfig{" +
                "name='" + name + '\'' +
                ", version='" + version + '\'' +
                '}';
    }
}

在需要使用配置属性的Bean中注入AppConfig对象，并打印输出其中的属性值：

@Autowired
private AppConfig appConfig;

public void printProperties() {
    logger.info("Application name is: {}", appConfig.getName());
    logger.info("Application version is: {}", appConfig.getVersion());
}

总结

本文介绍了SpringBoot读取配置文件的常用方法，包括使用@Value注解、Environment对象和@ConfigurationProperties注解。在实际应用开发中，需根据具体需求选择合适的配置读取方法，以确保应用程序能够正常运行。