环境抽象

Environment 接口是集成在容器中的抽象，它对应用程序环境的两个关键方面进行建模：配置文件 和 属性。

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

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

Bean 定义配置文件

Bean 定义配置文件在核心容器中提供了一种机制，允许在不同的环境中注册不同的 Bean。对于不同的用户来说，“环境”一词可能意味着不同的含义，此功能可以帮助解决许多用例，包括

  • 在开发中使用内存中的数据源，而在质量保证或生产中从 JNDI 中查找相同的数据源。

  • 仅在将应用程序部署到性能环境时注册监控基础设施。

  • 为客户 A 与客户 B 部署注册 Bean 的自定义实现。

考虑第一个用例，在实际应用程序中需要一个 DataSource。在测试环境中，配置可能类似于以下内容

  • Java

  • Kotlin

@Bean
public DataSource dataSource() {
	return new EmbeddedDatabaseBuilder()
		.setType(EmbeddedDatabaseType.HSQL)
		.addScript("my-schema.sql")
		.addScript("my-test-data.sql")
		.build();
}
@Bean
fun dataSource(): DataSource {
	return EmbeddedDatabaseBuilder()
			.setType(EmbeddedDatabaseType.HSQL)
			.addScript("my-schema.sql")
			.addScript("my-test-data.sql")
			.build()
}

现在考虑如何将此应用程序部署到质量保证或生产环境中，假设应用程序的数据源已注册到生产应用程序服务器的 JNDI 目录中。我们的 dataSource Bean 现在看起来如下所示

  • Java

  • Kotlin

@Bean(destroyMethod = "")
public DataSource dataSource() throws Exception {
	Context ctx = new InitialContext();
	return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}
@Bean(destroyMethod = "")
fun dataSource(): DataSource {
	val ctx = InitialContext()
	return ctx.lookup("java:comp/env/jdbc/datasource") as DataSource
}

问题是如何根据当前环境在这两个变体之间进行切换。随着时间的推移，Spring 用户已经想出了许多方法来完成此操作，通常依赖于系统环境变量和 XML <import/> 语句的组合，其中包含 ${placeholder} 令牌，这些令牌根据环境变量的值解析为正确的配置文件路径。Bean 定义配置文件是一个核心容器功能，可为该问题提供解决方案。

如果我们概括前面环境特定 Bean 定义示例中显示的用例，我们最终需要在某些上下文中注册某些 Bean 定义，而在其他上下文中则不需要。你可以说，你希望在情况 A 中注册 Bean 定义的特定配置文件，在情况 B 中注册不同的配置文件。我们从更新配置开始，以反映此需求。

使用 @Profile

@Profile 注释让你可以指示当一个或多个指定配置文件处于活动状态时，组件有资格进行注册。使用我们前面的示例，我们可以将 dataSource 配置重写如下

  • Java

  • Kotlin

@Configuration
@Profile("development")
public class StandaloneDataConfig {

	@Bean
	public DataSource dataSource() {
		return new EmbeddedDatabaseBuilder()
			.setType(EmbeddedDatabaseType.HSQL)
			.addScript("classpath:com/bank/config/sql/schema.sql")
			.addScript("classpath:com/bank/config/sql/test-data.sql")
			.build();
	}
}
@Configuration
@Profile("development")
class StandaloneDataConfig {

	@Bean
	fun dataSource(): DataSource {
		return EmbeddedDatabaseBuilder()
				.setType(EmbeddedDatabaseType.HSQL)
				.addScript("classpath:com/bank/config/sql/schema.sql")
				.addScript("classpath:com/bank/config/sql/test-data.sql")
				.build()
	}
}

  • Java

  • Kotlin

@Configuration
@Profile("production")
public class JndiDataConfig {

	@Bean(destroyMethod = "") (1)
	public DataSource dataSource() throws Exception {
		Context ctx = new InitialContext();
		return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
	}
}
1 @Bean(destroyMethod = "") 禁用默认销毁方法推断。 
@Configuration
@Profile("production")
class JndiDataConfig {

	@Bean(destroyMethod = "") (1)
	fun dataSource(): DataSource {
		val ctx = InitialContext()
		return ctx.lookup("java:comp/env/jdbc/datasource") as DataSource
	}
}
1 @Bean(destroyMethod = "") 禁用默认销毁方法推断。
如前所述，对于 @Bean 方法，通常选择使用编程 JNDI 查找，方法是使用 Spring 的 JndiTemplate/JndiLocatorDelegate 帮助器或前面所示的直接 JNDI InitialContext 用法，但不能使用 JndiObjectFactoryBean 变体，这会强制您将返回类型声明为 FactoryBean 类型。

配置文件字符串可以包含一个简单的配置文件名称（例如，production）或一个配置文件表达式。配置文件表达式允许表达更复杂的配置文件逻辑（例如，production & us-east）。配置文件表达式中支持以下运算符

  • !：配置文件的逻辑 NOT

  • &：配置文件的逻辑 AND

  • |：配置文件的逻辑 OR

您不能在不使用括号的情况下混合使用 & 和 | 运算符。例如，production & us-east | eu-central 不是一个有效的表达式。它必须表示为 production & (us-east | eu-central)。

您可以将 @Profile 用作 元注释，目的是创建自定义复合注释。以下示例定义了一个自定义 @Production 注释，您可以将其用作 @Profile("production") 的直接替换

  • Java

  • Kotlin

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Profile("production")
public @interface Production {
}
@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
@Profile("production")
annotation class Production
如果一个 @Configuration 类用 @Profile 标记，则与该类关联的所有 @Bean 方法和 @Import 注释都会被绕过，除非一个或多个指定的配置文件处于活动状态。如果一个 @Component 或 @Configuration 类用 @Profile({"p1", "p2"}) 标记，则在配置文件 'p1' 或 'p2' 已激活之前，该类不会被注册或处理。如果给定的配置文件带有 NOT 运算符 (!) 前缀，则只有当配置文件不处于活动状态时，带注释的元素才会被注册。例如，给定 @Profile({"p1", "!p2"})，如果配置文件 'p1' 处于活动状态或配置文件 'p2' 不处于活动状态，则会进行注册。

@Profile 也可以在方法级别声明，以仅包含配置类的单个特定 bean（例如，对于特定 bean 的替代变体），如下例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean("dataSource")
	@Profile("development") (1)
	public DataSource standaloneDataSource() {
		return new EmbeddedDatabaseBuilder()
			.setType(EmbeddedDatabaseType.HSQL)
			.addScript("classpath:com/bank/config/sql/schema.sql")
			.addScript("classpath:com/bank/config/sql/test-data.sql")
			.build();
	}

	@Bean("dataSource")
	@Profile("production") (2)
	public DataSource jndiDataSource() throws Exception {
		Context ctx = new InitialContext();
		return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
	}
}
1 standaloneDataSource 方法仅在 development 配置文件中可用。
2 jndiDataSource 方法仅在 production 配置文件中可用。 
@Configuration
class AppConfig {

	@Bean("dataSource")
	@Profile("development") (1)
	fun standaloneDataSource(): DataSource {
		return EmbeddedDatabaseBuilder()
				.setType(EmbeddedDatabaseType.HSQL)
				.addScript("classpath:com/bank/config/sql/schema.sql")
				.addScript("classpath:com/bank/config/sql/test-data.sql")
				.build()
	}

	@Bean("dataSource")
	@Profile("production") (2)
	fun jndiDataSource() =
		InitialContext().lookup("java:comp/env/jdbc/datasource") as DataSource
}
1 standaloneDataSource 方法仅在 development 配置文件中可用。
2 jndiDataSource 方法仅在 production 配置文件中可用。

对于 @Bean 方法上的 @Profile，可能适用特殊情况：对于具有相同 Java 方法名称的重载 @Bean 方法（类似于构造函数重载），需要在所有重载方法上始终如一地声明 @Profile 条件。如果条件不一致，则仅重载方法中第一个声明的条件有效。因此，不能使用 @Profile 来选择具有特定参数签名的重载方法，而不是另一个方法。对于同一 bean 的所有工厂方法之间的解析在创建时遵循 Spring 的构造函数解析算法。

如果要使用不同的配置文件条件定义替代 bean，请使用不同的 Java 方法名称，这些名称通过使用 @Bean 名称属性指向同一 bean 名称，如前一个示例所示。如果参数签名都相同（例如，所有变体都没有参数的工厂方法），则这是在有效的 Java 类中表示此类安排的唯一方法（因为特定名称和参数签名的方法只能有一个）。

XML Bean 定义配置文件

XML 对应项是 <beans> 元素的 profile 属性。我们的前一个示例配置可以重写为两个 XML 文件，如下所示

<beans profile="development"
	xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jdbc="http://www.springframework.org/schema/jdbc"
	xsi:schemaLocation="...">

	<jdbc:embedded-database id="dataSource">
		<jdbc:script location="classpath:com/bank/config/sql/schema.sql"/>
		<jdbc:script location="classpath:com/bank/config/sql/test-data.sql"/>
	</jdbc:embedded-database>
</beans>
<beans profile="production"
	xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jee="http://www.springframework.org/schema/jee"
	xsi:schemaLocation="...">

	<jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
</beans>

也可以避免拆分并在同一文件中嵌套 <beans/> 元素，如下例所示

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jdbc="http://www.springframework.org/schema/jdbc"
	xmlns:jee="http://www.springframework.org/schema/jee"
	xsi:schemaLocation="...">

	<!-- other bean definitions -->

	<beans profile="development">
		<jdbc:embedded-database id="dataSource">
			<jdbc:script location="classpath:com/bank/config/sql/schema.sql"/>
			<jdbc:script location="classpath:com/bank/config/sql/test-data.sql"/>
		</jdbc:embedded-database>
	</beans>

	<beans profile="production">
		<jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
	</beans>
</beans>

spring-bean.xsd 已被限制为仅允许此类元素作为文件中的最后一个元素。这有助于提供灵活性，而不会导致 XML 文件杂乱无章。

XML 对应项不支持前面描述的配置文件表达式。但是，可以使用 ! 运算符来否定配置文件。还可以通过嵌套配置文件来应用逻辑“与”，如下例所示

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jdbc="http://www.springframework.org/schema/jdbc"
	xmlns:jee="http://www.springframework.org/schema/jee"
	xsi:schemaLocation="...">

	<!-- other bean definitions -->

	<beans profile="production">
		<beans profile="us-east">
			<jee:jndi-lookup id="dataSource" jndi-name="java:comp/env/jdbc/datasource"/>
		</beans>
	</beans>
</beans>

在前面的示例中，如果 production 和 us-east 配置文件都处于活动状态，则会显示 dataSource bean。

激活配置文件

现在我们已经更新了配置，但仍需要指示 Spring 哪个配置文件处于活动状态。如果我们现在启动示例应用程序，我们将看到抛出 NoSuchBeanDefinitionException，因为容器找不到名为 dataSource 的 Spring bean。

激活配置文件有几种方法，但最直接的方法是针对 Environment API 以编程方式进行激活，该 API 可通过 ApplicationContext 获得。以下示例演示了如何执行此操作

  • Java

  • Kotlin

AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.getEnvironment().setActiveProfiles("development");
ctx.register(SomeConfig.class, StandaloneDataConfig.class, JndiDataConfig.class);
ctx.refresh();
val ctx = AnnotationConfigApplicationContext().apply {
	environment.setActiveProfiles("development")
	register(SomeConfig::class.java, StandaloneDataConfig::class.java, JndiDataConfig::class.java)
	refresh()
}

此外，你还可以通过 spring.profiles.active 属性以声明方式激活配置文件，该属性可以通过系统环境变量、JVM 系统属性、web.xml 中的 servlet 上下文参数，甚至作为 JNDI 中的条目来指定（请参阅 PropertySource 抽象）。在集成测试中，可以使用 spring-test 模块中的 @ActiveProfiles 注释来声明活动配置文件（请参阅 使用环境配置文件进行上下文配置 ）。

请注意，配置文件不是“要么-要么”的命题。你可以一次激活多个配置文件。以编程方式，你可以向 setActiveProfiles() 方法提供多个配置文件名称，该方法接受 String…​ 可变参数。以下示例激活多个配置文件

  • Java

  • Kotlin

ctx.getEnvironment().setActiveProfiles("profile1", "profile2");
ctx.getEnvironment().setActiveProfiles("profile1", "profile2")

以声明方式，spring.profiles.active 可以接受以逗号分隔的配置文件名称列表，如下例所示

-Dspring.profiles.active="profile1,profile2"

默认配置文件

默认配置文件表示在没有活动配置文件时启用的配置文件。请考虑以下示例

  • Java

  • Kotlin

@Configuration
@Profile("default")
public class DefaultDataConfig {

	@Bean
	public DataSource dataSource() {
		return new EmbeddedDatabaseBuilder()
			.setType(EmbeddedDatabaseType.HSQL)
			.addScript("classpath:com/bank/config/sql/schema.sql")
			.build();
	}
}
@Configuration
@Profile("default")
class DefaultDataConfig {

	@Bean
	fun dataSource(): DataSource {
		return EmbeddedDatabaseBuilder()
				.setType(EmbeddedDatabaseType.HSQL)
				.addScript("classpath:com/bank/config/sql/schema.sql")
				.build()
	}
}

如果 没有活动配置文件，则会创建 dataSource。你可以将此视为为一个或多个 bean 提供默认定义的一种方式。如果启用了任何配置文件，则默认配置文件不适用。

默认配置文件的名称为 default。你可以使用 Environment 上的 setDefaultProfiles() 或以声明方式使用 spring.profiles.default 属性来更改默认配置文件的名称。

PropertySource 抽象

Spring 的 Environment 抽象提供了对可配置的属性源层次结构的搜索操作。请考虑以下清单

  • Java

  • Kotlin

ApplicationContext ctx = new GenericApplicationContext();
Environment env = ctx.getEnvironment();
boolean containsMyProperty = env.containsProperty("my-property");
System.out.println("Does my environment contain the 'my-property' property? " + containsMyProperty);
val ctx = GenericApplicationContext()
val env = ctx.environment
val containsMyProperty = env.containsProperty("my-property")
println("Does my environment contain the 'my-property' property? $containsMyProperty")

在前面的代码段中，我们看到了一种高级方法，用于询问 Spring 当前环境是否定义了 my-property 属性。为了回答这个问题，Environment 对象会在一组 PropertySource 对象上执行搜索。PropertySource 是对任何键值对源的简单抽象，Spring 的 StandardEnvironment 配置了两个 PropertySource 对象——一个表示 JVM 系统属性集（System.getProperties()），另一个表示系统环境变量集（System.getenv()）。

这些默认属性源适用于 StandardEnvironment，用于独立应用程序中。 StandardServletEnvironment 填充了其他默认属性源，包括 servlet 配置、servlet 上下文参数和 JndiPropertySource（如果 JNDI 可用）。

具体而言，当你使用 StandardEnvironment 时，如果在运行时存在 my-property 系统属性或 my-property 环境变量，则对 env.containsProperty("my-property") 的调用将返回 true。

执行的分层搜索。默认情况下，系统属性优先于环境变量。因此，如果在调用 env.getProperty("my-property") 期间碰巧在两个位置都设置了 my-property 属性，则系统属性值“获胜”并被返回。请注意，属性值不会合并，而是完全被前面的条目覆盖。

对于常见的 StandardServletEnvironment，完整的层次结构如下，优先级最高的条目在顶部

  1. ServletConfig 参数（如果适用——例如，在 DispatcherServlet 上下文中）

  2. ServletContext 参数（web.xml context-param 条目）

  3. JNDI 环境变量（java:comp/env/ 条目）

  4. JVM 系统属性（-D 命令行参数）

  5. JVM 系统环境（操作系统环境变量）

最重要的是，整个机制是可配置的。也许你有一个自定义属性源，你想将其集成到此搜索中。为此，实现并实例化你自己的 PropertySource，并将其添加到当前 Environment 的 PropertySources 集中。以下示例展示了如何执行此操作

  • Java

  • Kotlin

ConfigurableApplicationContext ctx = new GenericApplicationContext();
MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
sources.addFirst(new MyPropertySource());
val ctx = GenericApplicationContext()
val sources = ctx.environment.propertySources
sources.addFirst(MyPropertySource())

在前面的代码中，MyPropertySource 已在搜索中添加了最高优先级。如果它包含 my-property 属性，则会检测到该属性并返回该属性，而不是任何其他 PropertySource 中的任何 my-property 属性。 MutablePropertySources API 公开了许多方法，这些方法允许对属性源集进行精确操作。

使用 @PropertySource

@PropertySource 注解提供了一种方便且声明式的机制，用于将 PropertySource 添加到 Spring 的 Environment 中。

给定一个名为 app.properties 的文件，其中包含键值对 testbean.name=myTestBean，以下 @Configuration 类以一种方式使用 @PropertySource，使得对 testBean.getName() 的调用返回 myTestBean

  • Java

  • Kotlin

@Configuration
@PropertySource("classpath:/com/myco/app.properties")
public class AppConfig {

 @Autowired
 Environment env;

 @Bean
 public TestBean testBean() {
  TestBean testBean = new TestBean();
  testBean.setName(env.getProperty("testbean.name"));
  return testBean;
 }
}
@Configuration
@PropertySource("classpath:/com/myco/app.properties")
class AppConfig {

	@Autowired
	private lateinit var env: Environment

	@Bean
	fun testBean() = TestBean().apply {
		name = env.getProperty("testbean.name")!!
	}
}

@PropertySource 资源位置中存在的任何 ${…​} 占位符都将针对已在环境中注册的属性源集进行解析，如下例所示

  • Java

  • Kotlin

@Configuration
@PropertySource("classpath:/com/${my.placeholder:default/path}/app.properties")
public class AppConfig {

 @Autowired
 Environment env;

 @Bean
 public TestBean testBean() {
  TestBean testBean = new TestBean();
  testBean.setName(env.getProperty("testbean.name"));
  return testBean;
 }
}
@Configuration
@PropertySource("classpath:/com/\${my.placeholder:default/path}/app.properties")
class AppConfig {

	@Autowired
	private lateinit var env: Environment

	@Bean
	fun testBean() = TestBean().apply {
		name = env.getProperty("testbean.name")!!
	}
}

假设 my.placeholder 存在于已注册的属性源之一中（例如，系统属性或环境变量），则占位符将解析为相应的值。如果没有，则 default/path 将用作默认值。如果未指定默认值且无法解析属性，则会抛出 IllegalArgumentException。

@PropertySource 可用作可重复注解。@PropertySource 还可以用作元注解来创建具有属性覆盖的自定义复合注解。

语句中的占位符解析

从历史上看，元素中占位符的值只能针对 JVM 系统属性或环境变量进行解析。现在不再是这样了。由于 Environment 抽象已集成到整个容器中，因此很容易通过它来路由占位符的解析。这意味着您可以根据需要配置解析过程。您可以更改通过系统属性和环境变量进行搜索的优先级，或完全删除它们。您还可以根据需要将自己的属性源添加到组合中。

具体来说，以下语句可以正常工作，无论 customer 属性在何处定义，只要它在 Environment 中可用即可

<beans>
	<import resource="com/bank/service/${customer}-config.xml"/>
</beans>