同步操作将从 xuchengsheng/spring-reading 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
✒️ 作者 - Lex 📝 博客 - 掘金 📚 源码地址 - github
PropertyResolver
ConfigurablePropertyResolver
Environment
接口是 Spring 框架中的一个核心部分,它提供了一个统一的方式来访问各种外部化的配置数据,例如环境变量、JVM 系统属性、命令行参数、以及应用程序配置文件(如 properties 或 YAML 文件)。这个接口允许我们在运行时方便地获取和操作这些配置数据,同时也支持配置文件(Profiles)的概念,这使得在不同环境(如开发、测试、生产)下进行条件性的配置变得简单。通过 Environment
,我们可以查询和操作属性值,检查属性的存在,以及处理多个属性源。
属性访问
属性源管理
Environment
抽象支持多个属性源,并按优先级顺序检索属性。这意味着可以从多个地方(如不同的配置文件和环境变量)加载属性,并根据需要覆盖它们。配置文件(Profiles)
属性存在性检查
类型安全的属性访问
Environment
还提供了类型安全的方法,允许直接将属性值转换为期望的类型。必需属性的访问
Environment
接口是 Spring 应用程序环境的主要表现形式,重点关注两个方面:配置文件(profiles)和属性(properties)。配置文件是对一组逻辑分组的 Bean 定义的命名,只有在相应的配置文件被激活时才会注册这些 Bean。属性则是来自多种来源的配置数据,如文件、环境变量等。Environment
提供了一系列方法来激活和管理这些配置文件,以及方便地访问和解析这些属性。
/**
* 代表当前应用程序运行环境的接口。
* 模型化应用环境的两个关键方面:<em>配置文件(profiles)</em> 和 <em>属性(properties)</em>。
* 与属性访问相关的方法通过 {@link PropertyResolver} 超接口暴露。
*
* <p>一个 <em>配置文件</em> 是一组命名的、逻辑分组的 bean 定义,只有在给定的配置文件处于 <em>活跃</em> 状态时才会被容器注册。
* 无论是在 XML 中定义还是通过注解定义,Beans 都可以被分配到一个配置文件中;
* 有关语法细节,请参阅 spring-beans 3.1 schema 或 {@link org.springframework.context.annotation.Profile @Profile} 注解。
* {@code Environment} 对象与配置文件相关的角色在于确定哪些配置文件(如果有的话)当前是 {@linkplain #getActiveProfiles 活跃的},
* 以及哪些配置文件(如果有的话)应该默认是活跃的。
*
* <p><em>属性</em> 在几乎所有应用程序中都扮演重要角色,可能来自多种来源:属性文件、JVM 系统属性、系统环境变量、JNDI、
* servlet 上下文参数、临时 Properties 对象、Maps 等。环境对象与属性相关的角色在于为用户提供一个方便的服务接口,
* 用于配置属性源并从中解析属性。
*
* <p>在 {@code ApplicationContext} 中管理的 Beans 可以注册为 {@link org.springframework.context.EnvironmentAware EnvironmentAware}
* 或 {@code @Inject} {@code Environment},以查询配置文件状态或直接解析属性。
*
* <p>然而,在大多数情况下,应用程序级别的 Beans 不应该直接与 {@code Environment} 交互,
* 而应该通过像 {@link org.springframework.context.support.PropertySourcesPlaceholderConfigurer
* PropertySourcesPlaceholderConfigurer} 这样的属性占位符配置器来替换 {@code ${...}} 属性值,
* 这个配置器本身是 {@code EnvironmentAware},并且从 Spring 3.1 开始,使用 {@code <context:property-placeholder/>} 时默认会注册。
*
* <p>必须通过 {@code ConfigurableEnvironment} 接口对环境对象进行配置,所有
* {@code AbstractApplicationContext} 子类的 {@code getEnvironment()} 方法都返回此接口。
* 请参阅 {@link ConfigurableEnvironment} Javadoc,了解在应用程序上下文 {@code refresh()} 之前操作属性源的示例。
*
* @author Chris Beams
* @since 3.1
* @see PropertyResolver
* @see EnvironmentCapable
* @see ConfigurableEnvironment
* @see AbstractEnvironment
* @see StandardEnvironment
* @see org.springframework.context.EnvironmentAware
* @see org.springframework.context.ConfigurableApplicationContext#getEnvironment
* @see org.springframework.context.ConfigurableApplicationContext#setEnvironment
* @see org.springframework.context.support.AbstractApplicationContext#createEnvironment
*/
public interface Environment extends PropertyResolver {
/**
* 返回为此环境显式激活的配置文件集。配置文件用于有条件地注册 bean 定义,例如基于部署环境创建逻辑分组。
* 通过设置系统属性 {@linkplain AbstractEnvironment#ACTIVE_PROFILES_PROPERTY_NAME
* "spring.profiles.active"} 或调用 {@link ConfigurableEnvironment#setActiveProfiles(String...)} 来激活配置文件。
* <p>如果没有明确指定活跃的配置文件,则任何 {@linkplain #getDefaultProfiles() 默认配置文件} 将自动激活。
* @see #getDefaultProfiles
* @see ConfigurableEnvironment#setActiveProfiles
* @see AbstractEnvironment#ACTIVE_PROFILES_PROPERTY_NAME
*/
String[] getActiveProfiles();
/**
* 当没有明确设置活跃配置文件时,默认激活的配置文件集。
* @see #getActiveProfiles
* @see ConfigurableEnvironment#setDefaultProfiles
* @see AbstractEnvironment#DEFAULT_PROFILES_PROPERTY_NAME
*/
String[] getDefaultProfiles();
/**
* 返回一个或多个给定配置文件是否活跃,或者在没有明确活跃配置文件的情况下,给定配置文件是否包含在默认配置文件集中。
* 如果配置文件以 '!' 开头,则逻辑被反转,即如果给定的配置文件 <em>不</em> 活跃,则方法将返回 {@code true}。
* 例如,{@code env.acceptsProfiles("p1", "!p2")} 将在 'p1' 配置文件活跃或 'p2' 配置文件不活跃时返回 {@code true}。
* @throws IllegalArgumentException 如果调用时没有参数,或者任何配置文件是 {@code null}、空的或只有空格
* @see #getActiveProfiles
* @see #getDefaultProfiles
* @see #acceptsProfiles(Profiles)
* @deprecated 从 5.1 版本开始,建议使用 {@link #acceptsProfiles(Profiles)}
*/
@Deprecated
boolean acceptsProfiles(String... profiles);
/**
* 返回 {@linkplain #getActiveProfiles() 活跃配置文件} 是否匹配给定的 {@link Profiles} 谓词。
*/
boolean acceptsProfiles(Profiles profiles);
}
AbstractEnvironment
Environment
接口的抽象基类,提供了共通的实现机制,供其他具体实现类继承。StandardEnvironment
StandardServletEnvironment
使用 Spring 的 StandardEnvironment
在 Java 程序中模拟配置文件的激活和属性访问。它设置并展示了激活的配置文件("test"),默认配置文件("dev"),并检查了特定配置文件("test")的激活状态,以及获取并打印了系统的 Java 版本。
public class EnvironmentDemo {
public static void main(String[] args) {
// 设置系统属性以模拟 Spring 的配置文件功能
System.setProperty("spring.profiles.default", "dev");
System.setProperty("spring.profiles.active", "test");
// 创建 StandardEnvironment 实例,用于访问属性和配置文件信息
Environment environment = new StandardEnvironment();
// 使用 getProperty 方法获取系统属性。这里获取了 Java 版本
String javaVersion = environment.getProperty("java.version");
System.out.println("java.version: " + javaVersion);
// 获取当前激活的配置文件(profiles)
String[] activeProfiles = environment.getActiveProfiles();
System.out.println("activeProfiles = " + String.join(",", activeProfiles));
// 获取默认配置文件(当没有激活的配置文件时使用)
String[] defaultProfiles = environment.getDefaultProfiles();
System.out.println("defaultProfiles = " + String.join(",", defaultProfiles));
// 检查是否激活了指定的配置文件。这里检查的是 'test' 配置文件
boolean isDevProfileActive = environment.acceptsProfiles("test");
System.out.println("acceptsProfiles('test'): " + isDevProfileActive);
}
}
运行结果发现, StandardEnvironment
在模拟和管理 Spring 配置文件以及访问系统属性方面的有效性,特别是在不依赖于完整 Spring 应用程序上下文的场景中。
java.version: 11
activeProfiles = test
defaultProfiles = dev
acceptsProfiles('test'): true
ApplicationContext
ApplicationContext
(Spring 容器)在启动时会创建和使用 Environment
实例来加载和处理配置文件(profiles)和属性(properties)。它提供了对 Environment
的访问和定制的接口,例如,可以通过 ApplicationContext
获取或替换默认的 Environment
实例。PropertySourcesPlaceholderConfigurer
BeanFactoryPostProcessor
,用于解析属性占位符(例如 ${property.name}
)。它与 Environment
一起工作,从 Environment
管理的属性源中解析属性值。@PropertySource 和 PropertySources
@PropertySource
注解和 PropertySources
类用于声明属性源(如 .properties 或 .yml 文件)。这些属性源被添加到 Environment
中,以便从中读取配置属性。@ConfigurationProperties
@ConfigurationProperties
类可以利用 Environment
来获取所需的属性值,并将它们映射到类的字段上。属性值未找到
null
或抛出异常。为解决这个问题,确保属性名称正确,并检查该属性是否已在正确的属性源中定义。配置文件未正确激活
@Profile
注解是否正确应用于相应的 Beans。属性类型转换错误
占位符未解析
${property.name}
)在应用程序中未被替换为实际的属性值时,检查 PropertySourcesPlaceholderConfigurer
或类似机制是否已正确配置在 Spring 上下文中。属性源优先级问题
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。