SpringBoot怎么实现读取YML,yaml,properties文件

发布时间：2023-04-14 11:36:14 作者：iii
来源：亿速云阅读：254

SpringBoot怎么实现读取YML、YAML、Properties文件

在Spring Boot应用程序中，配置文件是管理应用程序设置和属性的重要部分。Spring Boot支持多种配置文件格式，包括YAML（YML）和Properties文件。本文将详细介绍如何在Spring Boot中读取这些配置文件，并展示如何在实际项目中使用这些配置。

1. Spring Boot配置文件概述

Spring Boot支持多种配置文件格式，主要包括：

Properties文件：传统的键值对格式，文件扩展名为.properties。
YAML文件：一种人类可读的数据序列化格式，文件扩展名为.yml或.yaml。

Spring Boot默认会加载application.properties或application.yml文件作为应用程序的配置文件。这些文件通常位于src/main/resources目录下。

2. 读取Properties文件

2.1 基本配置

在Spring Boot中，读取Properties文件非常简单。你只需要在application.properties文件中定义属性，然后在代码中使用@Value注解或@ConfigurationProperties注解来注入这些属性。

2.1.1 使用`@Value`注解

@Value注解可以直接将配置文件中的属性值注入到Spring管理的Bean中。

# application.properties
app.name=MyApp
app.version=1.0.0

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {

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

    @Value("${app.version}")
    private String appVersion;

    public void printConfig() {
        System.out.println("App Name: " + appName);
        System.out.println("App Version: " + appVersion);
    }
}

2.1.2 使用`@ConfigurationProperties`注解

@ConfigurationProperties注解可以将配置文件中的属性绑定到一个Java对象中。

# application.properties
app.name=MyApp
app.version=1.0.0

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;

    // Getters and Setters

    public void printConfig() {
        System.out.println("App Name: " + name);
        System.out.println("App Version: " + version);
    }
}

2.2 多环境配置

在实际开发中，我们通常需要为不同的环境（如开发、测试、生产）配置不同的属性。Spring Boot支持通过application-{profile}.properties文件来实现多环境配置。

# application-dev.properties
app.name=MyApp (Dev)
app.version=1.0.0

# application-prod.properties
app.name=MyApp (Prod)
app.version=1.0.0

在启动应用程序时，可以通过spring.profiles.active属性来指定激活的环境。

java -jar myapp.jar --spring.profiles.active=prod

3. 读取YAML文件

3.1 基本配置

YAML文件是一种更加结构化的配置文件格式，适合配置复杂的嵌套属性。Spring Boot同样支持通过@Value和@ConfigurationProperties注解来读取YAML文件中的配置。

3.1.1 使用`@Value`注解

# application.yml
app:
  name: MyApp
  version: 1.0.0

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class AppConfig {

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

    @Value("${app.version}")
    private String appVersion;

    public void printConfig() {
        System.out.println("App Name: " + appName);
        System.out.println("App Version: " + appVersion);
    }
}

3.1.2 使用`@ConfigurationProperties`注解

# application.yml
app:
  name: MyApp
  version: 1.0.0

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;

    // Getters and Setters

    public void printConfig() {
        System.out.println("App Name: " + name);
        System.out.println("App Version: " + version);
    }
}

3.2 多环境配置

与Properties文件类似，YAML文件也支持多环境配置。可以通过application-{profile}.yml文件来实现。

# application-dev.yml
app:
  name: MyApp (Dev)
  version: 1.0.0

# application-prod.yml
app:
  name: MyApp (Prod)
  version: 1.0.0

在启动应用程序时，可以通过spring.profiles.active属性来指定激活的环境。

java -jar myapp.jar --spring.profiles.active=prod

4. 自定义配置文件

除了默认的application.properties和application.yml文件外，Spring Boot还支持自定义配置文件。你可以通过@PropertySource注解来加载自定义的Properties文件。

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:custom.properties")
public class CustomConfig {
}

# custom.properties
custom.name=CustomApp
custom.version=2.0.0

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class CustomConfig {

    @Value("${custom.name}")
    private String customName;

    @Value("${custom.version}")
    private String customVersion;

    public void printConfig() {
        System.out.println("Custom Name: " + customName);
        System.out.println("Custom Version: " + customVersion);
    }
}

5. 配置文件优先级

Spring Boot在加载配置文件时，会按照一定的优先级顺序进行加载。优先级高的配置会覆盖优先级低的配置。以下是Spring Boot配置文件的加载顺序（从高到低）：

命令行参数
application-{profile}.properties或application-{profile}.yml
application.properties或application.yml
@PropertySource注解指定的配置文件

6. 总结

在Spring Boot中，读取YML、YAML和Properties文件非常简单。通过@Value和@ConfigurationProperties注解，我们可以轻松地将配置文件中的属性注入到Spring管理的Bean中。此外，Spring Boot还支持多环境配置和自定义配置文件，使得应用程序的配置管理更加灵活和强大。

通过本文的介绍，你应该已经掌握了如何在Spring Boot中读取不同类型的配置文件，并能够在实际项目中灵活运用这些知识。希望本文对你有所帮助！