当前位置：首页 > article >正文

springboot 读取配置的方式

article 2024/10/22 10:11:46

Spring Boot 提供了多种方式来读取和使用配置属性。这些配置可以来自不同的源，如 application.properties 或 application.yml 文件、环境变量、命令行参数等。Spring Boot 会自动将这些配置加载到环境中，并且提供了方便的机制来访问它们。以下是几种常见的读取配置的方式：

1. 使用 `@Value` 注解

@Value 注解可以直接注入属性值到字段或方法参数中。

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

@Component
public class MyComponent {

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

    // Getter and Setter
}

这里 ${my.property:default_value} 表示从配置文件中获取 my.property 的值，如果找不到该属性，则使用默认值 default_value。

2. 使用 `@ConfigurationProperties`

对于更复杂的对象，你可以创建一个 POJO 类并使用 @ConfigurationProperties 注解来绑定一组相关的属性。

首先，在类上添加 @ConfigurationProperties 和 @Component 注解：

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

@Component
@ConfigurationProperties(prefix = "my.config")
public class MyConfigProperties {
    private String property1;
    private int property2;

    // Getters and Setters
}

然后在配置文件中定义相应的属性：

# application.properties
my.config.property1=some-value
my.config.property2=42

或者

# application.yml
my:
  config:
    property1: some-value
    property2: 42

最后，你可以在其他组件中注入这个配置类：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    private final MyConfigProperties myConfigProperties;

    @Autowired
    public MyService(MyConfigProperties myConfigProperties) {
        this.myConfigProperties = myConfigProperties;
    }

    // Use myConfigProperties
}

3. 使用 `Environment` 接口

你可以通过注入 Environment 接口来访问配置属性。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    private final Environment env;

    @Autowired
    public MyComponent(Environment env) {
        this.env = env;
    }

    public void printMyProperty() {
        System.out.println(env.getProperty("my.property", "default_value"));
    }
}

4. 使用 `@Value` 和构造函数注入

从 Spring Framework 5.0 开始，推荐使用构造函数注入，这样可以使你的代码更加简洁和安全。

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

@Component
public class MyComponent {

    private final String myProperty;

    public MyComponent(@Value("${my.property:default_value}") String myProperty) {
        this.myProperty = myProperty;
    }

    // Use myProperty
}