Spring系列15：Environment抽象

本文内容

1. Environment抽象的2个重要概念
2. @Profile 的使用
3. @PropertySource 的使用

Environment抽象的2个重要概念

Environment 接口表示当前应用程序运行环境的接口。对应用程序环境的两个关键方面进行建模：配置文件( profiles )和属性(properties)。与属性访问相关的方法通过 PropertyResolver 超接口公开。环境对象的配置必须通过 ConfigurableEnvironment 接口完成，该接口从所有 AbstractApplicationContext 子类 getEnvironment() 方法返回

环境与配置文件

配置文件是一个命名的、逻辑的 bean 定义组，仅当给定的配置文件处于活动状态时才向容器注册。可以将 Bean 分配给配置文件，无论是在 XML 中定义还是通过注释 @Profile 定义；与配置文件相关的环境对象的作用是确定哪些配置文件（如果有）当前处于活动状态，以及哪些配置文件（如果有）默认应该是活动的。

环境与属性

属性在几乎所有应用程序中都发挥着重要作用，并且可能源自多种来源：属性文件、JVM 系统属性、系统环境变量、JNDI、servlet 上下文参数、属性对象、map等。与属性相关的环境对象的作用是为用户提供一个方便的服务接口，用于配置属性源并从中解析属性。

在 ApplicationContext 中管理的 Bean 可以注册为 EnvironmentAware 或 @Inject Environment，以便直接查询配置文件状态或解析属性。然而，在大多数情况下，应用程序级别的 bean 不需要直接与 Environment 交互，而是可能必须将 ${...} 属性值替换为属性占位符配置器，例如 PropertySourcesPlaceholderConfigurer，它本身是 EnvironmentAware 并且从 Spring 3.1 开始使用 context:property-placeholder 时默认注册 ，或是通过java bean的方式注册到容器中。

PropertySourcesPlaceholderConfigurer 分析可以阅读上一篇： Spring系列14：IoC容器的扩展点

接口源码粗览

接口继承关系

接口源码如下提供配置文件相关的接口方法，其继承的 PropertyResolver 提供属性相关的接口。

public interface Environment extends PropertyResolver {
    // 当前激活的配置文件列表
    // 设置系统属性值 spring.profiles.active=xxx 可激活
    // 或是调用 ConfigurableEnvironment#setActiveProfiles(String...)激活
    String[] getActiveProfiles();

    // 当没有明确设置活动配置文件时，默认配置文件集返回为活动状态。
    String[] getDefaultProfiles();

    // 返回活动配置文件是否与给定的 Profiles 匹配
    boolean acceptsProfiles(Profiles profiles);

}

PropertyResolver 是针对任何底层源解析属性的接口，主要接口方法如下。有一个非常重要的实现类是 PropertySourcesPlaceholderConfigurer 。

public interface PropertyResolver {

    // 是否包含属性
    boolean containsProperty(String key);
    // 获取属性值
    String getProperty(String key);
    // 获取属性值带默认值
    String getProperty(String key, String defaultValue);
    // 获取属性值
    <T> T getProperty(String key, Class<T> targetType);
    // 获取属性值带默认值
    <T> T getProperty(String key, Class<T> targetType, T defaultValue);

    // 获取属性值
    String getRequiredProperty(String key) throws IllegalStateException;
    //  获取属性值
    <T> T getRequiredProperty(String key, Class<T> tar