SpringBoot3讀取配置文件application.properties屬性值的幾種方式

更新時間：2024年11月04日 09:26:42 作者：WiFiMing

這篇文章主要介紹了SpringBoot3讀取配置文件application.properties屬性值的幾種方式,文中通過代碼示例給大家講解的非常詳細(xì),對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下

1. 使用 @Value 注解讀取單個屬性值

@Value 注解可以直接用于注入 application.properties 文件中的屬性值。

示例

假設(shè)在 application.properties 中定義了以下配置項：

app.name=MyApp
app.version=1.0.0

可以在任意 @Component、@Service、@Controller 等注解標(biāo)注的類中，通過 @Value 注解獲取這些值：

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);
    }
}

注意：${app.name} 表示從配置文件中讀取 app.name 屬性值。

2. 使用 @ConfigurationProperties 注解讀取配置前綴

@ConfigurationProperties 注解允許批量讀取具有相同前綴的屬性，并將其注入到一個 Java 類中。這種方式適用于管理大量的配置項。

示例

假設(shè)在 application.properties 中定義了一組 app 前綴的屬性：

app.name=MyApp
app.version=1.0.0
app.description=A sample application

可以創(chuàng)建一個配置類，并使用 @ConfigurationProperties 注解將 app 前綴的屬性注入其中：

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

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

    private String name;
    private String version;
    private String description;

    // Getter and Setter methods

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

在其他類中可以通過注入 AppConfigProperties 類來獲取配置值：

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

@Service
public class AppService {

    private final AppConfigProperties appConfigProperties;

    @Autowired
    public AppService(AppConfigProperties appConfigProperties) {
        this.appConfigProperties = appConfigProperties;
    }

    public void printAppInfo() {
        System.out.println("App Name: " + appConfigProperties.getName());
        System.out.println("App Version: " + appConfigProperties.getVersion());
        System.out.println("App Description: " + appConfigProperties.getDescription());
    }
}

注意：@ConfigurationProperties 注解類必須是一個 @Component，并且需要在 application.properties 中啟用屬性綁定支持，通常在 Spring Boot 中默認(rèn)已啟用。

3. 使用 Environment 讀取屬性

Environment 接口提供了動態(tài)獲取屬性值的方式，適合用于在運行時讀取配置文件中的屬性。

示例

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

@Component
public class EnvironmentConfig {

    private final Environment environment;

    @Autowired
    public EnvironmentConfig(Environment environment) {
        this.environment = environment;
    }

    public void printEnvConfig() {
        String appName = environment.getProperty("app.name");
        String appVersion = environment.getProperty("app.version");

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

注意：Environment 接口適合在需要動態(tài)獲取配置或配置項不確定的場景中使用。

4. 使用 @PropertySource 加載自定義配置文件

除了 application.properties，也可以定義自定義配置文件，并使用 @PropertySource 注解加載其中的屬性。

示例

創(chuàng)建自定義配置文件 custom-config.properties，內(nèi)容如下：

custom.property1=value1
custom.property2=value2

使用 @PropertySource 注解加載自定義配置文件：

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

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

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

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

    public void printCustomConfig() {
        System.out.println("Custom Property 1: " + property1);
        System.out.println("Custom Property 2: " + property2);
    }
}