獲取Spring當前配置的兩種方式

更新時間：2024年01月09日 09:49:28 作者：念念清晰

這篇文章主要給大家介紹了獲取Spring當前配置的,兩種方式文中通過代碼示例給大家介紹的非常詳細,對大家的學習或工作有一定的幫助,需要的朋友可以參考下

獲取配置名稱的2種方式

通過@Value注解獲取
通過Environment類獲取

代碼示例如下

package org.example.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;

@Configuration
@Slf4j
public class Config1 implements InitializingBean, EnvironmentAware {
    // 如果沒有配置會報錯，所以必須指定默認值
    @Value("${spring.profiles.active:''}")
    private String envName;
    @Value("${spring.application.name:''}")
    private String appName;
    private Environment environment;

    // 使用注入的方式也可以獲取到 Environment 對象
    //@Resource
    //private Environment environment2;


    @Override
    public void afterPropertiesSet() throws Exception {
        log.info("[環(huán)境名稱]通過Value注解獲取 = {}", envName);
        log.info("[應用名稱]通過Value注解獲取 = {}", appName);
        String property = environment.getProperty("spring.application.name");
        log.info("[應用名稱]通過environment獲取 = {}", property);
        String[] activeProfiles = environment.getActiveProfiles();
        String[] defaultProfiles = environment.getDefaultProfiles();
        if (activeProfiles.length > 0) {
            log.info("[環(huán)境名稱]通過environment獲取 = {}", activeProfiles[0]);
        } else {
            log.info("[activeProfiles為空]");
        }
        if (defaultProfiles.length > 0) {
            log.info("[環(huán)境名稱]通過environment獲取 = {}", defaultProfiles[0]);
        } else {
            log.info("defaultProfiles為空");
        }
    }

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
}

運行Application

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

可以得到如下結果

[環(huán)境名稱]通過Value注解獲取 = ''
[應用名稱]通過Value注解獲取 = spring-profiles-test-default
[應用名稱]通過environment獲取 = spring-profiles-test-default
[activeProfiles為空]
[環(huán)境名稱]通過environment獲取 = default

注意

默認啟動應用時，我們并未顯式的指定任何profiles名稱。這是Spring默認是default。如果使用@Profile注解激活需要這樣使用

@Profile({"default"})

需要注意的是，默認啟動應用時。使用@Value("${spring.profiles.active}")這種方式并不能獲取到環(huán)境的名稱，因為我們沒有在任何地方定義spring.profiles.active這個變量。所以需要指定默認值，否則會報錯。

思考

思考：哪些應用場景下，我們需要獲取當前配置的名稱。

某段代碼不想放到生產環(huán)境中，但在測試環(huán)境由于某些原因又必須需要（比如方便快速定位bug等原因）
開發(fā)一款插件，對外提供高度定制化的配置項

假如我們要開發(fā)一款插件（或者別的項目），打包成jar包放到maven倉庫供全網程序猿使用。比如pagehelper這樣有修改的插件。那插件中一定會暴露出很多配置項供開發(fā)者選擇。假設我們現(xiàn)在有一個需求，這個插件只能在非生產環(huán)境運行。該怎么辦呢？解決思路其實很簡單，就是動態(tài)配置。