Spring 通過 Environment 接口提供了容器的環境抽象，該接口包含兩個關鍵部分 Profiles 和 Properties。

一、條件注冊

在講 Profile 之前，先了解 Spring 容器根據條件注冊 Bean 的實現。

Condition 接口和 @Conditional 注解

實現 Condition 接口定義條件邏輯，然后在定義 Bean 的時候使用 @Conditional 來指定條件。
當符合 CustomCondition 條件的類才會被注冊到容器中。

public class CustomCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 條件邏輯
        return true;
    }
}

@Component
@Conditional(CustomCondition.class)
public class ConditionExample {

}

@Conditional 注解可與所有定義 Bean 的注解使用，包括 @Component、@Configuration、@Bean 等。

二、Profiles

Profile 可以根據配置來決定類是否注冊，當類配置了 Profile，只有激活該 Profile 時才將該類注冊到容器。

1. Profile 配置

@Profile 是基于 Condition 接口實現的，可以參考 @Profile 和 ProfileCondition 的源碼。

@Component
@Profile("dev")
public class ProfileExample {

}

@Configuration
public class AppConfig {

    @Bean
    @Profile("dev")
    public BeanExample beanExample() {
        return new BeanExample();
    }
}

@Profile 注解可與所有定義 Bean 的注解使用，包括 @Component、@Configuration、@Bean 等。

同一個類可以配置多個 Profile 值，也支持簡單的邏輯操作。

// 激活dev或prod時注冊
@Profile({"dev", "prod"})

// 激活dev或prod時注冊
@Profile("dev | prod")

// 同時激活dev和prod時注冊
@Profile("dev & prod")

// 沒有激活dev時注冊
@Profile("!dev")

2. Profile 激活

配置了 Profile 的類，只有當容器激活相同的 Profile 時，類才會被注冊到容器中。

public class Main {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
        ConfigurableEnvironment environment = applicationContext.getEnvironment();
        environment.setActiveProfiles("dev");
        applicationContext.scan("cn.codeartist.spring.env");
        applicationContext.refresh();
    }
}

一般情況下，通過配置 spring.profiles.active=dev 來激活。

默認激活的 Profile

環境配置中沒有激活的 Profile 時，會使用默認的 Profile，環境配置中存在激活的 Profile 時，默認配置失效。

public class Main {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
        ConfigurableEnvironment environment = applicationContext.getEnvironment();
        environment.setDefaultProfiles("prod");
        applicationContext.scan("cn.codeartist.spring.env");
        applicationContext.refresh();
    }
}

一般情況下，通過配置 spring.profiles.default=prod 來指定默認的 Profile。

三、Properties

Environment 接口繼承了 PropertyResolver 接口，來管理容器中所有的配置資源，包括但不限于：

• 配置文件屬性
• JVM 系統屬性
• 環境變量屬性
• JNDI 變量屬性
• ServletContext 屬性
• ServletConfig 屬性

1. PropertySource 抽象

PropertySource 抽象類用于簡單地維護 Key-Value 屬性資源。

例如 StandardEnvironment 類配置的 JVM 系統屬性和環境變量屬性對象。

public class StandardEnvironment extends AbstractEnvironment {

    @Override
    protected void customizePropertySources(MutablePropertySources propertySources) {
        propertySources.addLast(new MapPropertySource("systemProperties", getSystemProperties()));
        propertySources.addLast(new SystemEnvironmentPropertySource("systemEnvironment", getSystemEnvironment()));
    }
}

每一個配置資源都會定義一個 PropertySource 對象，多個配置資源由 PropertySources 接口統一管理。

@PropertySource 注解

該注解可以導入配置資源到 Spring 環境中，與 @Configuration 使用。

例如導入 classpath 下的 properties 配置文件資源。

@Configuration
@PropertySource("classpath:spring.properties")
public class AppConfig {

}

2. 優先級

PropertySources 接口管理著多個配置資源，并且是有層級的。
如果多個配置資源里面存在相同的配置，容器會根據配置資源的優先級來注入。
常用的 StandardServletEnvironment 環境類，優先級從高到低為：

• ServletConfig 屬性（DispatcherServlet 上下文配置）
• ServletContext 屬性（web.xml 上下文配置）
• JNDI 環境變量（java:comp/env/ 配置）
• JVM 系統屬性 (-D 指定的命令行參數)
• 環境變量屬性（操作系統環境變量）

3. 占位符

在項目中，可以使用 Environment 直接獲取配置資源中的配置。
也可以使用 ${key} 占位符來指定配置資源中的屬性值。

@Component
public class BeanExample {

    @Autowired
    private Environment env;

    public void test() {
        String val = env.getProperty("test.value");
        // Print: CodeArtist
        String val1 = env.resolvePlaceholders("test.value=${test.value}");
        // Print: test.value=CodeArtist
    }
}

@Value 注解可以給字段注入值，也可以使用占位符來注入配置資源中的值。

@Component
public class BeanExample {

    @Value("${test.value:default}")
    private String name;

}

@Configuration
public class AppConfig {

    @Bean
    public BeanExample beanExample(@Value("${test.value:default}") String name) {
        return new BeanExample();
    }
}

四、附錄

1. 常用注解

2. 示例代碼

Gitee 倉庫：https://gitee.com/code_artist/spring
項目模塊：spring-ioc
示例路徑：cn.codeartist.spring.env

最新文章關注 CodeArtist 碼匠公眾號。