Spring Boot读取配置的几种方式

文章目录

• • [@Value 注解读取配置](#@Value 注解读取配置)
  • [@ConfigurationProperties 绑定配置](#@ConfigurationProperties 绑定配置)
  • [Environment 对象读取配置](#Environment 对象读取配置)
  • [@PropertySource 注解读取外部配置文件](#@PropertySource 注解读取外部配置文件)
  • [ApplicationArguments 读取命令行参数](#ApplicationArguments 读取命令行参数)
  • [@Bean 方法和 @ConfigurationProperties 结合](#@Bean 方法和 @ConfigurationProperties 结合)

在 Spring Boot 中，可以通过多种方式读取配置。Spring Boot 提供了灵活的配置方式，使得应用程序能够方便地获取配置参数。
在 Spring Boot 中，可以通过多种方式读取配置。Spring Boot 提供了灵活的配置方式，使得应用程序能够方便地获取配置参数。
Spring Boot提供了多种灵活的读取配置方式，开发者可以根据项目的具体需求和场景选择合适的方式。@Value注解和@ConfigurationProperties注解是两种常用的注入配置值的方式，分别适用于单个属性注入和批量属性绑定。Environment接口和EnvironmentAware接口提供了更为灵活的访问配置信息的方式。@PropertySource注解允许指定外部配置文件，而Java Properties类则提供了一种原生读取配置文件的方法。

1. 使用application.properties或application.yml文件
   Spring Boot默认会读取位于src/main/resources目录下的application.properties或application.yml文件作为应用的配置文件。这些文件中可以定义应用的属性，Spring Boot会自动加载这些文件，并将配置属性注入到应用程序中。YAML格式的文件（application.yml）语法相对简洁，可读性更好，适合用于编写较为复杂的配置文件。
2. 使用@Value注解
   @Value注解是Spring提供的一种注入配置值的方式，它允许将配置文件中的值注入到Spring管理的Bean中。这种方式简单直接，但只能单个属性注入，不适合批量处理。同时，如果配置的key不存在，应用启动时会报错。可以通过添加默认值来提高容错率。
3. 使用@ConfigurationProperties注解
   @ConfigurationProperties注解是Spring Boot推荐的一种批量绑定配置属性到Bean的方式。这种方式比@Value注解更加高效，适用于配置属性较多的情况。通过指定配置文件中某key的前缀，自动绑定所有匹配的属性，可以轻松地将配置属性映射到Bean的字段。
4. 使用Environment接口
   Environment是Spring底层提供的一个API，用于访问当前环境的配置信息。通过Environment的getProperty方法，可以动态地获取配置信息。这种方式适用于插件式开发，可以降低耦合性。可以通过@Autowired注解将Environment对象注入到任意Spring Bean中，然后使用该对象获取配置属性的值。
5. 实现EnvironmentAware接口
   通过实现EnvironmentAware接口，可以在Bean初始化时获取Environment对象，并对其进行操作。这种方式与直接使用Environment接口相似，但提供了一种更为灵活的方式，允许在Bean的初始化过程中访问配置信息。
6. 使用@PropertySource注解
   @PropertySource注解允许指定一个外部的配置文件，Spring将加载这个文件作为配置源。这可以用于读取除了默认配置文件之外的其他配置文件。需要注意的是，@PropertySource通常与@Configuration注解一起使用，以指定配置类的配置源。
7. 使用Java Properties类
   这是Java原生方式，指的是使用Java的I/O流读取配置文件，然后将读取的内容存储到Properties对象中。这种方式适用于读取自定义外部属性文件，但需要手动处理文件的读取和解析。

@Value 注解读取配置

@Value 注解是最直接的一种方式，可以用来注入配置文件中的属性到字段中。

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

@Component
public class MyComponent {

    @Value("${my.property}")
    private String myProperty;

    public void printProperty() {
        System.out.println("My Property: " + myProperty);
    }
}

在 application.properties 或 application.yml 中定义配置：

my.property=Hello, Spring Boot!

或者使用 YAML 格式：

my:

property: Hello, Spring Boot!

@ConfigurationProperties 绑定配置

@ConfigurationProperties 可以将一组相关的配置绑定到一个 POJO 类中，非常适合处理复杂的配置结构。

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

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

    private String name;
    private String version;

    // Getters and Setters
}

在 application.properties 或 application.yml 中定义配置：

app.name=MyApp

app.version=1.0.0

或者使用 YAML 格式：

app:

name: MyApp

version: 1.0.0

Environment 对象读取配置

Environment 接口提供了一种以编程方式读取配置的方法，可以在任何 Spring 管理的 Bean 中使用。

import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    private final Environment environment;

    public MyComponent(Environment environment) {
        this.environment = environment;
    }

    public void printProperty() {
        String myProperty = environment.getProperty("my.property");
        System.out.println("My Property: " + myProperty);
    }
}

@PropertySource 注解读取外部配置文件

@PropertySource 注解可以用来指定一个或多个外部属性文件，并将它们加载到 Spring 的 Environment 中。

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.beans.factory.annotation.Value;

@Configuration
@PropertySource("classpath:extra.properties")
public class ExtraConfig {

    @Value("${extra.property}")
    private String extraProperty;

    public void printExtraProperty() {
        System.out.println("Extra Property: " + extraProperty);
    }
}

在 extra.properties 文件中定义配置：

extra.property=Extra Value

ApplicationArguments 读取命令行参数

如果需要读取命令行参数，可以使用 ApplicationArguments 接口。

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class MyAppRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) {
        if (args.containsOption("myOption")) {
            System.out.println("Option present: " + args.getOptionValues("myOption"));
        }
    }
}

启动应用时：

java -jar myapp.jar --myOption=someValue

@Bean 方法和 @ConfigurationProperties 结合

你还可以在 @Bean 方法中使用 @ConfigurationProperties，这通常用于配置第三方库的参数。

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyConfig {

    @Bean
    @ConfigurationProperties(prefix = "app.datasource")
    public DataSource dataSource() {
        return new DataSource();
    }
}

在 application.properties 中定义：

app.datasource.url=jdbc:mysql://localhost:3306/mydb

app.datasource.username=root

app.datasource.password=secret

通过上述几种方式，你可以轻松地在 Spring Boot 应用中读取和管理配置。每种方式适用于不同的场景，你可以根据具体需求选择合适的方法。