关于Spring属性处理器PropertyResolver以及应用运行环境Environment的深度分析,强大的StringValueResolver使用和解析【享学Spring】(中)

简介: 关于Spring属性处理器PropertyResolver以及应用运行环境Environment的深度分析,强大的StringValueResolver使用和解析【享学Spring】(中)

ConfigurableEnvironment


扩展出了修改和配置profiles的一系列方法,包括用户自定义的和系统相关的属性。所有的环境实现类也都是它的实现~

// @since 3.1
public interface ConfigurableEnvironment extends Environment, ConfigurablePropertyResolver {
  void setActiveProfiles(String... profiles);
  void addActiveProfile(String profile);
  void setDefaultProfiles(String... profiles);
  // 获取到所有的属性源~   MutablePropertySources表示可变的属性源们~~~ 它是一个聚合的  持有List<PropertySource<?>>
  // 这样获取出来后,我们可以add或者remove我们自己自定义的属性源了~
  MutablePropertySources getPropertySources();
  // 这里两个哥们应该非常熟悉了吧~~~
  Map<String, Object> getSystemProperties();
  Map<String, Object> getSystemEnvironment();
  // 合并两个环境配置信息~  此方法唯一实现在AbstractEnvironment上
  void merge(ConfigurableEnvironment parent);
}


它会有两个分支:


  1. ConfigurableWebEnvironment:显然它和web环境有关,提供方法void initPropertySources(@Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig)让web自己做资源初始化~
  2. AbstractEnvironment:这个是重点,如下~


AbstractEnvironment


它是对环境的一个抽象实现,很重要。


public abstract class AbstractEnvironment implements ConfigurableEnvironment {
  public static final String IGNORE_GETENV_PROPERTY_NAME = "spring.getenv.ignore";
  public static final String ACTIVE_PROFILES_PROPERTY_NAME = "spring.profiles.active";
  public static final String DEFAULT_PROFILES_PROPERTY_NAME = "spring.profiles.default";
  // 保留的默认的profile值   protected final属性,证明子类可以访问
  protected static final String RESERVED_DEFAULT_PROFILE_NAME = "default";
  private final Set<String> activeProfiles = new LinkedHashSet<>();
  // 显然这个里面的值 就是default这个profile了~~~~
  private final Set<String> defaultProfiles = new LinkedHashSet<>(getReservedDefaultProfiles());
  // 这个很关键,直接new了一个 MutablePropertySources来管理属性源们
  // 并且是用的PropertySourcesPropertyResolver来处理里面可能的占位符~~~~~
  private final MutablePropertySources propertySources = new MutablePropertySources();
  private final ConfigurablePropertyResolver propertyResolver = new PropertySourcesPropertyResolver(this.propertySources);
  // 唯一构造方法  customizePropertySources是空方法,交由子类去实现,对属性源进行定制~ 
  // Spring对属性配置分出这么多曾经,在SpringBoot中有着极其重要的意义~~~~
  public AbstractEnvironment() {
    customizePropertySources(this.propertySources);
  }
  // 该方法,StandardEnvironment实现类是有复写的~
  protected void customizePropertySources(MutablePropertySources propertySources) {
  }
  // 若你想改变默认default这个值,可以复写此方法~~~~
  protected Set<String> getReservedDefaultProfiles() {
    return Collections.singleton(RESERVED_DEFAULT_PROFILE_NAME);
  }
  //  下面开始实现接口的方法们~~~~~~~
  @Override
  public String[] getActiveProfiles() {
    return StringUtils.toStringArray(doGetActiveProfiles());
  }
  protected Set<String> doGetActiveProfiles() {
    synchronized (this.activeProfiles) {
      if (this.activeProfiles.isEmpty()) { 
        // 若目前是empty的,那就去获取:spring.profiles.active
        String profiles = getProperty(ACTIVE_PROFILES_PROPERTY_NAME);
        if (StringUtils.hasText(profiles)) {
          //支持,分隔表示多个~~~且空格啥的都无所谓
          setActiveProfiles(StringUtils.commaDelimitedListToStringArray(
              StringUtils.trimAllWhitespace(profiles)));
        }
      }
      return this.activeProfiles;
    }
  }
  @Override
  public void setActiveProfiles(String... profiles) {
    synchronized (this.activeProfiles) {
      this.activeProfiles.clear(); // 因为是set方法  所以情况已存在的吧
      for (String profile : profiles) {
         // 简单的valid,不为空且不以!打头~~~~~~~~
        validateProfile(profile);
        this.activeProfiles.add(profile);
      }
    }
  }
  // default profiles逻辑类似,也是不能以!打头~
  @Override
  @Deprecated
  public boolean acceptsProfiles(String... profiles) {
    for (String profile : profiles) {
      // 此处:如果该profile以!开头,那就截断出来  把后半段拿出来看看   它是否在active行列里~~~ 
      // 此处稍微注意:若!表示一个相反的逻辑~~~~~请注意比如!dev表示若dev是active的,我反倒是不生效的
      if (StringUtils.hasLength(profile) && profile.charAt(0) == '!') {
        if (!isProfileActive(profile.substring(1))) {
          return true;
        }
      } else if (isProfileActive(profile)) {
        return true;
      }
    }
    return false;
  }
  // 采用函数式接口处理  就非常的优雅了~
  @Override
  public boolean acceptsProfiles(Profiles profiles) {
    Assert.notNull(profiles, "Profiles must not be null");
    return profiles.matches(this::isProfileActive);
  }
  // 简答的说要么active包含,要门是default  这个profile就被认为是激活的
  protected boolean isProfileActive(String profile) {
    validateProfile(profile);
    Set<String> currentActiveProfiles = doGetActiveProfiles();
    return (currentActiveProfiles.contains(profile) ||
        (currentActiveProfiles.isEmpty() && doGetDefaultProfiles().contains(profile)));
  }
  @Override
  public MutablePropertySources getPropertySources() {
    return this.propertySources;
  }
  public Map<String, Object> getSystemProperties() {
    return (Map) System.getProperties();
  }
  public Map<String, Object> getSystemEnvironment() {
    // 这个判断为:return SpringProperties.getFlag(IGNORE_GETENV_PROPERTY_NAME);
    // 所以我们是可以通过在`spring.properties`这个配置文件里spring.getenv.ignore=false关掉不暴露环境变量的~~~
    if (suppressGetenvAccess()) {
      return Collections.emptyMap();
    }
    return (Map) System.getenv();
  }
  // Append the given parent environment's active profiles, default profiles and property sources to this (child) environment's respective collections of each.
  // 把父环境的属性合并进来~~~~  
  // 在调用ApplicationContext.setParent方法时,会把父容器的环境合并进来  以保证父容器的属性对子容器都是可见的
  @Override
  public void merge(ConfigurableEnvironment parent) {
    for (PropertySource<?> ps : parent.getPropertySources()) {
      if (!this.propertySources.contains(ps.getName())) {
        this.propertySources.addLast(ps); // 父容器的属性都放在最末尾~~~~
      }
    }
    // 合并active
    String[] parentActiveProfiles = parent.getActiveProfiles();
    if (!ObjectUtils.isEmpty(parentActiveProfiles)) {
      synchronized (this.activeProfiles) {
        for (String profile : parentActiveProfiles) {
          this.activeProfiles.add(profile);
        }
      }
    }
    // 合并default
    String[] parentDefaultProfiles = parent.getDefaultProfiles();
    if (!ObjectUtils.isEmpty(parentDefaultProfiles)) {
      synchronized (this.defaultProfiles) {
        this.defaultProfiles.remove(RESERVED_DEFAULT_PROFILE_NAME);
        for (String profile : parentDefaultProfiles) {
          this.defaultProfiles.add(profile);
        }
      }
    }
  }
  // 其余方法全部委托给内置的propertyResolver属性,因为它就是个`PropertyResolver`
  ...
}


该抽象类完成了对active、default等相关方法的复写处理。它内部持有一个MutablePropertySources引用来管理属性源。


So,留给子类的活就不多了:只需要把你的属性源注册给我就OK了

StandardEnvironment

这个是Spring应用在非web容器运行的环境。从名称上解释为:标准实现


public class StandardEnvironment extends AbstractEnvironment {
  // 这两个值定义着  就是在@Value注解要使用它们时的key~~~~~
  /** System environment property source name: {@value}. */
  public static final String SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME = "systemEnvironment";
  /** JVM system properties property source name: {@value}. */
  public static final String SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME = "systemProperties";
  // 注册MapPropertySource和SystemEnvironmentPropertySource
  // SystemEnvironmentPropertySource是MapPropertySource的子类~~~~
  @Override
  protected void customizePropertySources(MutablePropertySources propertySources) {
    propertySources.addLast(new MapPropertySource(SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties()));
    propertySources.addLast(new SystemEnvironmentPropertySource(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, getSystemEnvironment()));
  }
}


StandardServletEnvironment


这是在web容器(servlet容器)时候的应用的标准环境。


public class StandardServletEnvironment extends StandardEnvironment implements ConfigurableWebEnvironment {
  public static final String SERVLET_CONTEXT_PROPERTY_SOURCE_NAME = "servletContextInitParams";
  public static final String SERVLET_CONFIG_PROPERTY_SOURCE_NAME = "servletConfigInitParams";
  public static final String JNDI_PROPERTY_SOURCE_NAME = "jndiProperties";
  // 放置三个web相关的配置源~  StubPropertySource是PropertySource的一个public静态内部类~~~
  @Override
  protected void customizePropertySources(MutablePropertySources propertySources) {
    propertySources.addLast(new StubPropertySource(SERVLET_CONFIG_PROPERTY_SOURCE_NAME));
    propertySources.addLast(new StubPropertySource(SERVLET_CONTEXT_PROPERTY_SOURCE_NAME));
    // 可以通过spring.properties配置文件里面的spring.jndi.ignore=true关闭对jndi的暴露   默认是开启的
    if (JndiLocatorDelegate.isDefaultJndiEnvironmentAvailable()) {
      propertySources.addLast(new JndiPropertySource(JNDI_PROPERTY_SOURCE_NAME));
    }
    super.customizePropertySources(propertySources);
  }
  // 注册servletContextInitParams和servletConfigInitParams到属性配置源头里
  @Override
  public void initPropertySources(@Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig) {
    WebApplicationContextUtils.initServletPropertySources(getPropertySources(), servletContext, servletConfig);
  }
}


注意:这里addFirst和addLast等关系这顺序,进而都关乎着配置最终的生效的。因此下面对比一下web环境和非web环境下属性源们的配置,各位要有感官上的一个认识~~~


非web环境:

image.png


web环境:

image.png


可见web相关配置的属性源的优先级是高于system相关的。

需要注意的是:若使用@PropertySource导入自定义配置,它会位于最底端(优先级最低

另外附上SpringBoot的属性源们:

访问:http://localhost:8080/env得到如下


image.png

相关文章
|
29天前
|
XML 存储 Java
Spring重要类解析
Spring重要类解析
20 0
|
27天前
|
安全 Java 数据安全/隐私保护
【深入浅出Spring原理及实战】「EL表达式开发系列」深入解析SpringEL表达式理论详解与实际应用
【深入浅出Spring原理及实战】「EL表达式开发系列」深入解析SpringEL表达式理论详解与实际应用
64 1
|
27天前
|
存储 XML 缓存
【深入浅出Spring原理及实战】「缓存Cache开发系列」带你深入分析Spring所提供的缓存Cache功能的开发实战指南(一)
【深入浅出Spring原理及实战】「缓存Cache开发系列」带你深入分析Spring所提供的缓存Cache功能的开发实战指南
65 0
|
13天前
|
XML Java 数据格式
Bean工厂探秘:解析Spring底层工厂体系BeanFactory的神奇之道
Bean工厂探秘:解析Spring底层工厂体系BeanFactory的神奇之道
19 0
Bean工厂探秘:解析Spring底层工厂体系BeanFactory的神奇之道
|
13天前
|
XML Java 数据格式
从入门到精通:Spring基础注解的全面解析
从入门到精通:Spring基础注解的全面解析
30 2
从入门到精通:Spring基础注解的全面解析
|
13天前
|
Java 数据库 Spring
切面编程的艺术:Spring动态代理解析与实战
切面编程的艺术:Spring动态代理解析与实战
26 0
切面编程的艺术:Spring动态代理解析与实战
|
13天前
|
Java 关系型数据库 MySQL
高级对象装配:解析Spring创建复杂对象的秘诀
高级对象装配:解析Spring创建复杂对象的秘诀
27 0
高级对象装配:解析Spring创建复杂对象的秘诀
|
22天前
|
存储 安全 Java
Spring Security应用讲解(Java案列演示)
Spring Security应用讲解(Java案列演示)
|
28天前
|
Prometheus 监控 Cloud Native
Spring Boot 应用可视化监控
Spring Boot 应用可视化监控
17 0
|
1月前
|
Cloud Native Java 开发者
Spring Boot 4.0:构建云原生Java应用的前沿工具
Spring Boot 4.0:构建云原生Java应用的前沿工具