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

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
简介: 关于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

相关文章
|
12天前
|
缓存 Kubernetes Docker
GitLab Runner 全面解析:Kubernetes 环境下的应用
GitLab Runner 是 GitLab CI/CD 的核心组件,负责执行由 `.gitlab-ci.yml` 定义的任务。它支持多种执行方式(如 Shell、Docker、Kubernetes),可在不同环境中运行作业。本文详细介绍了 GitLab Runner 的基本概念、功能特点及使用方法,重点探讨了流水线缓存(以 Python 项目为例)和构建镜像的应用,特别是在 Kubernetes 环境中的配置与优化。通过合理配置缓存和镜像构建,能够显著提升 CI/CD 流水线的效率和可靠性,助力开发团队实现持续集成与交付的目标。
|
1月前
|
机器学习/深度学习 人工智能 自然语言处理
AI技术深度解析:从基础到应用的全面介绍
人工智能(AI)技术的迅猛发展,正在深刻改变着我们的生活和工作方式。从自然语言处理(NLP)到机器学习,从神经网络到大型语言模型(LLM),AI技术的每一次进步都带来了前所未有的机遇和挑战。本文将从背景、历史、业务场景、Python代码示例、流程图以及如何上手等多个方面,对AI技术中的关键组件进行深度解析,为读者呈现一个全面而深入的AI技术世界。
147 10
|
9天前
|
供应链 搜索推荐 API
深度解析1688 API对电商的影响与实战应用
在全球电子商务迅猛发展的背景下,1688作为知名的B2B电商平台,为中小企业提供商品批发、分销、供应链管理等一站式服务,并通过开放的API接口,为开发者和电商企业提供数据资源和功能支持。本文将深入解析1688 API的功能(如商品搜索、详情、订单管理等)、应用场景(如商品展示、搜索优化、交易管理和用户行为分析)、收益分析(如流量增长、销售提升、库存优化和成本降低)及实际案例,帮助电商从业者提升运营效率和商业收益。
82 17
|
1天前
|
JSON 小程序 UED
微信小程序 app.json 配置文件解析与应用
本文介绍了微信小程序中 `app.json` 配置文件的详细
28 12
|
27天前
|
人工智能 前端开发 Java
Spring AI Alibaba + 通义千问,开发AI应用如此简单!!!
本文介绍了如何使用Spring AI Alibaba开发一个简单的AI对话应用。通过引入`spring-ai-alibaba-starter`依赖和配置API密钥,结合Spring Boot项目,只需几行代码即可实现与AI模型的交互。具体步骤包括创建Spring Boot项目、编写Controller处理对话请求以及前端页面展示对话内容。此外,文章还介绍了如何通过添加对话记忆功能,使AI能够理解上下文并进行连贯对话。最后,总结了Spring AI为Java开发者带来的便利,简化了AI应用的开发流程。
335 0
|
27天前
|
设计模式 XML Java
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
本文详细介绍了Spring框架的核心功能,并通过手写自定义Spring框架的方式,深入理解了Spring的IOC(控制反转)和DI(依赖注入)功能,并且学会实际运用设计模式到真实开发中。
【23种设计模式·全精解析 | 自定义Spring框架篇】Spring核心源码分析+自定义Spring的IOC功能,依赖注入功能
|
25天前
|
安全 API 数据安全/隐私保护
速卖通AliExpress商品详情API接口深度解析与实战应用
速卖通(AliExpress)作为全球化电商的重要平台,提供了丰富的商品资源和便捷的购物体验。为了提升用户体验和优化商品管理,速卖通开放了API接口,其中商品详情API尤为关键。本文介绍如何获取API密钥、调用商品详情API接口,并处理API响应数据,帮助开发者和商家高效利用这些工具。通过合理规划API调用策略和确保合法合规使用,开发者可以更好地获取商品信息,优化管理和营销策略。
|
1月前
|
XML Java 数据格式
Spring Core核心类库的功能与应用实践分析
【12月更文挑战第1天】大家好,今天我们来聊聊Spring Core这个强大的核心类库。Spring Core作为Spring框架的基础,提供了控制反转(IOC)和依赖注入(DI)等核心功能,以及企业级功能,如JNDI和定时任务等。通过本文,我们将从概述、功能点、背景、业务点、底层原理等多个方面深入剖析Spring Core,并通过多个Java示例展示其应用实践,同时指出对应实践的优缺点。
64 14
|
1月前
|
机器学习/深度学习 搜索推荐 API
淘宝/天猫按图搜索(拍立淘)API的深度解析与应用实践
在数字化时代,电商行业迅速发展,个性化、便捷性和高效性成为消费者新需求。淘宝/天猫推出的拍立淘API,利用图像识别技术,提供精准的购物搜索体验。本文深入探讨其原理、优势、应用场景及实现方法,助力电商技术和用户体验提升。
|
1月前
|
XML 前端开发 安全
Spring MVC:深入理解与应用实践
Spring MVC是Spring框架提供的一个用于构建Web应用程序的Model-View-Controller(MVC)实现。它通过分离业务逻辑、数据、显示来组织代码,使得Web应用程序的开发变得更加简洁和高效。本文将从概述、功能点、背景、业务点、底层原理等多个方面深入剖析Spring MVC,并通过多个Java示例展示其应用实践,同时指出对应实践的优缺点。
91 2

热门文章

最新文章

推荐镜像

更多