ApplicationContext 的其他功能

正如章节介绍中所述，org.springframework.beans.factory 包提供了管理和操作 Bean 的基本功能，包括以编程方式。org.springframework.context 包添加了ApplicationContext 接口，该接口扩展了 BeanFactory 接口，并扩展了其他接口以提供更多面向应用程序框架的功能。许多人以完全声明的方式使用 ApplicationContext，甚至不以编程方式创建它，而是依赖于诸如 ContextLoader 之类的支持类，以在 Jakarta EE Web 应用程序的正常启动过程中自动实例化 ApplicationContext。

为了以更面向框架的方式增强 BeanFactory 功能，上下文包还提供了以下功能

  • 通过 MessageSource 接口访问 i18n 风格的消息。

  • 通过 ResourceLoader 接口访问资源，例如 URL 和文件。

  • 事件发布，即通过使用 ApplicationEventPublisher 接口发布到实现 ApplicationListener 接口的 Bean。

  • 加载多个（分层）上下文，让每个上下文专注于一个特定层，例如应用程序的 Web 层，通过 HierarchicalBeanFactory 接口。

使用 MessageSource 进行国际化

ApplicationContext 接口扩展了一个名为 MessageSource 的接口，因此提供了国际化（“i18n”）功能。Spring 还提供了 HierarchicalMessageSource 接口，它可以分层解析消息。这些接口共同为 Spring 实现消息解析奠定了基础。这些接口上定义的方法包括

  • String getMessage(String code, Object[] args, String default, Locale loc)：用于从 MessageSource 中检索消息的基本方法。当未找到指定区域设置的消息时，将使用默认消息。传递的任何参数都将成为替换值，使用标准库提供的 MessageFormat 功能。

  • String getMessage(String code, Object[] args, Locale loc)：与上一个方法基本相同，但有一个区别：不能指定默认消息。如果找不到消息，则会抛出 NoSuchMessageException。

  • String getMessage(MessageSourceResolvable resolvable, Locale locale)：前面方法中使用的所有属性也封装在一个名为 MessageSourceResolvable 的类中，您可以使用此方法。

当加载 ApplicationContext 时，它会自动搜索在上下文中定义的 MessageSource Bean。该 Bean 必须具有名称 messageSource。如果找到这样的 Bean，则对前面方法的所有调用都将委托给消息源。如果找不到消息源，ApplicationContext 将尝试找到包含具有相同名称的 Bean 的父级。如果找到，它将使用该 Bean 作为 MessageSource。如果 ApplicationContext 找不到任何消息源，则会实例化一个空的 DelegatingMessageSource 以便能够接受对上面定义的方法的调用。

Spring 提供了三种 MessageSource 实现：ResourceBundleMessageSource、ReloadableResourceBundleMessageSource 和 StaticMessageSource。它们都实现了 HierarchicalMessageSource 以进行嵌套消息传递。StaticMessageSource 很少使用，但提供了以编程方式将消息添加到源的方法。以下示例展示了 ResourceBundleMessageSource

<beans>
	<bean id="messageSource"
			class="org.springframework.context.support.ResourceBundleMessageSource">
		<property name="basenames">
			<list>
				<value>format</value>
				<value>exceptions</value>
				<value>windows</value>
			</list>
		</property>
	</bean>
</beans>

该示例假设您在类路径中定义了三个名为 format、exceptions 和 windows 的资源包。任何解析消息的请求都将通过 JDK 标准方式通过 ResourceBundle 对象解析消息来处理。为了便于说明，假设上面两个资源包文件的内容如下所示

# in format.properties
message=Alligators rock!
# in exceptions.properties
argument.required=The {0} argument is required.

下一个示例展示了一个运行 MessageSource 功能的程序。请记住，所有 ApplicationContext 实现也是 MessageSource 实现，因此可以转换为 MessageSource 接口。

  • Java

  • Kotlin

public static void main(String[] args) {
	MessageSource resources = new ClassPathXmlApplicationContext("beans.xml");
	String message = resources.getMessage("message", null, "Default", Locale.ENGLISH);
	System.out.println(message);
}
fun main() {
	val resources = ClassPathXmlApplicationContext("beans.xml")
	val message = resources.getMessage("message", null, "Default", Locale.ENGLISH)
	println(message)
}

上面程序的输出结果如下所示

Alligators rock!

总而言之，MessageSource 定义在一个名为 beans.xml 的文件中，该文件位于您的类路径的根目录下。messageSource bean 定义通过其 basenames 属性引用多个资源包。传递给 basenames 属性列表中的三个文件作为文件存在于您的类路径的根目录下，分别称为 format.properties、exceptions.properties 和 windows.properties。

下一个示例展示了传递给消息查找的参数。这些参数将转换为 String 对象，并插入到查找消息中的占位符中。

<beans>

	<!-- this MessageSource is being used in a web application -->
	<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
		<property name="basename" value="exceptions"/>
	</bean>

	<!-- lets inject the above MessageSource into this POJO -->
	<bean id="example" class="com.something.Example">
		<property name="messages" ref="messageSource"/>
	</bean>

</beans>

  • Java

  • Kotlin

public class Example {

	private MessageSource messages;

	public void setMessages(MessageSource messages) {
		this.messages = messages;
	}

	public void execute() {
		String message = this.messages.getMessage("argument.required",
			new Object [] {"userDao"}, "Required", Locale.ENGLISH);
		System.out.println(message);
	}
}
	class Example {

	lateinit var messages: MessageSource

	fun execute() {
		val message = messages.getMessage("argument.required",
				arrayOf("userDao"), "Required", Locale.ENGLISH)
		println(message)
	}
}

调用 execute() 方法的输出结果如下所示

The userDao argument is required.

关于国际化（“i18n”），Spring 的各种 MessageSource 实现遵循与标准 JDK ResourceBundle 相同的区域设置解析和回退规则。简而言之，继续使用前面定义的示例 messageSource，如果您想针对英国（en-GB）区域设置解析消息，您将分别创建名为 format_en_GB.properties、exceptions_en_GB.properties 和 windows_en_GB.properties 的文件。

通常，区域设置解析由应用程序的周围环境管理。在以下示例中，手动指定了要解析（英国）消息的区域设置

# in exceptions_en_GB.properties
argument.required=Ebagum lad, the ''{0}'' argument is required, I say, required.

  • Java

  • Kotlin

public static void main(final String[] args) {
	MessageSource resources = new ClassPathXmlApplicationContext("beans.xml");
	String message = resources.getMessage("argument.required",
		new Object [] {"userDao"}, "Required", Locale.UK);
	System.out.println(message);
}
fun main() {
	val resources = ClassPathXmlApplicationContext("beans.xml")
	val message = resources.getMessage("argument.required",
			arrayOf("userDao"), "Required", Locale.UK)
	println(message)
}

运行上面程序的输出结果如下所示

Ebagum lad, the 'userDao' argument is required, I say, required.

您还可以使用 MessageSourceAware 接口获取对已定义的任何 MessageSource 的引用。在 ApplicationContext 中定义的任何实现 MessageSourceAware 接口的 bean 都将在 bean 创建和配置时注入应用程序上下文的 MessageSource。

由于 Spring 的 MessageSource 基于 Java 的 ResourceBundle，因此它不会合并具有相同基本名称的包，而只会使用找到的第一个包。具有相同基本名称的后续消息包将被忽略。
作为 ResourceBundleMessageSource 的替代方案，Spring 提供了 ReloadableResourceBundleMessageSource 类。此变体支持相同的捆绑文件格式，但比基于标准 JDK 的 ResourceBundleMessageSource 实现更灵活。特别是，它允许从任何 Spring 资源位置（不仅仅是从类路径）读取文件，并支持捆绑属性文件的热重载（同时在它们之间有效地缓存它们）。有关详细信息，请参阅 ReloadableResourceBundleMessageSource javadoc。

标准和自定义事件

ApplicationContext 中的事件处理通过 ApplicationEvent 类和 ApplicationListener 接口提供。如果将实现 ApplicationListener 接口的 bean 部署到上下文中，则每次将 ApplicationEvent 发布到 ApplicationContext 时，都会通知该 bean。本质上，这是标准的观察者设计模式。

从 Spring 4.2 开始，事件基础设施已得到显著改进，并提供了一种 基于注释的模型 以及发布任何任意事件（即不一定扩展自 ApplicationEvent 的对象）的能力。当发布此类对象时，我们会将其包装在一个事件中。

下表描述了 Spring 提供的标准事件

表 1. 内置事件
事件 解释

ContextRefreshedEvent

当 ApplicationContext 初始化或刷新时发布（例如，通过使用 ConfigurableApplicationContext 接口上的 refresh() 方法）。这里，“初始化”意味着所有 bean 都已加载，后处理器 bean 已被检测到并激活，单例已预先实例化，并且 ApplicationContext 对象已准备好使用。只要上下文尚未关闭，就可以多次触发刷新，前提是所选的 ApplicationContext 实际上支持这种“热”刷新。例如，XmlWebApplicationContext 支持热刷新，但 GenericApplicationContext 不支持。

ContextStartedEvent

当使用ConfigurableApplicationContext接口上的start()方法启动ApplicationContext时发布。这里，“启动”意味着所有Lifecycle bean都收到显式的启动信号。通常，此信号用于在显式停止后重新启动 bean，但它也可以用于启动未配置为自动启动的组件（例如，尚未在初始化时启动的组件）。

ContextStoppedEvent

当使用ConfigurableApplicationContext接口上的stop()方法停止ApplicationContext时发布。这里，“停止”意味着所有Lifecycle bean都收到显式的停止信号。停止的上下文可以通过start()调用重新启动。

ContextClosedEvent

当使用ConfigurableApplicationContext接口上的close()方法或通过 JVM 关闭钩子关闭ApplicationContext时发布。这里，“关闭”意味着所有单例 bean 都将被销毁。一旦上下文关闭，它就达到了生命周期的终点，无法刷新或重新启动。

RequestHandledEvent

一个特定于 Web 的事件，告诉所有 bean HTTP 请求已完成服务。此事件在请求完成后发布。此事件仅适用于使用 Spring 的DispatcherServlet的 Web 应用程序。

ServletRequestHandledEvent

RequestHandledEvent的子类，添加了特定于 Servlet 的上下文信息。

您还可以创建和发布自己的自定义事件。以下示例显示了一个扩展 Spring 的ApplicationEvent基类的简单类

  • Java

  • Kotlin

public class BlockedListEvent extends ApplicationEvent {

	private final String address;
	private final String content;

	public BlockedListEvent(Object source, String address, String content) {
		super(source);
		this.address = address;
		this.content = content;
	}

	// accessor and other methods...
}
class BlockedListEvent(source: Any,
					val address: String,
					val content: String) : ApplicationEvent(source)

要发布自定义ApplicationEvent，请在ApplicationEventPublisher上调用publishEvent()方法。通常，这是通过创建一个实现ApplicationEventPublisherAware并将其注册为 Spring bean 的类来完成的。以下示例显示了这样的类

  • Java

  • Kotlin

public class EmailService implements ApplicationEventPublisherAware {

	private List<String> blockedList;
	private ApplicationEventPublisher publisher;

	public void setBlockedList(List<String> blockedList) {
		this.blockedList = blockedList;
	}

	public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
		this.publisher = publisher;
	}

	public void sendEmail(String address, String content) {
		if (blockedList.contains(address)) {
			publisher.publishEvent(new BlockedListEvent(this, address, content));
			return;
		}
		// send email...
	}
}
class EmailService : ApplicationEventPublisherAware {

	private lateinit var blockedList: List<String>
	private lateinit var publisher: ApplicationEventPublisher

	fun setBlockedList(blockedList: List<String>) {
		this.blockedList = blockedList
	}

	override fun setApplicationEventPublisher(publisher: ApplicationEventPublisher) {
		this.publisher = publisher
	}

	fun sendEmail(address: String, content: String) {
		if (blockedList!!.contains(address)) {
			publisher!!.publishEvent(BlockedListEvent(this, address, content))
			return
		}
		// send email...
	}
}

在配置时，Spring 容器检测到EmailService实现了ApplicationEventPublisherAware，并自动调用setApplicationEventPublisher()。实际上，传入的参数是 Spring 容器本身。您通过其ApplicationEventPublisher接口与应用程序上下文进行交互。

要接收自定义ApplicationEvent，您可以创建一个实现ApplicationListener并将其注册为 Spring bean 的类。以下示例显示了这样的类

  • Java

  • Kotlin

public class BlockedListNotifier implements ApplicationListener<BlockedListEvent> {

	private String notificationAddress;

	public void setNotificationAddress(String notificationAddress) {
		this.notificationAddress = notificationAddress;
	}

	public void onApplicationEvent(BlockedListEvent event) {
		// notify appropriate parties via notificationAddress...
	}
}
class BlockedListNotifier : ApplicationListener<BlockedListEvent> {

	lateinit var notificationAddress: String

	override fun onApplicationEvent(event: BlockedListEvent) {
		// notify appropriate parties via notificationAddress...
	}
}

请注意，ApplicationListener 使用您的自定义事件类型（在前面的示例中为 BlockedListEvent）进行泛型参数化。这意味着 onApplicationEvent() 方法可以保持类型安全，避免任何向下转换的需要。您可以注册任意数量的事件监听器，但请注意，默认情况下，事件监听器会同步接收事件。这意味着 publishEvent() 方法会阻塞，直到所有监听器完成事件处理。这种同步和单线程方法的一个优点是，当监听器接收到事件时，如果存在事务上下文，它将在发布者的事务上下文中运行。如果需要其他事件发布策略，例如默认情况下异步事件处理，请参阅 Spring 的 ApplicationEventMulticaster 接口和 SimpleApplicationEventMulticaster 实现，了解可以应用于自定义“applicationEventMulticaster”bean 定义的配置选项。在这些情况下，ThreadLocals 和日志上下文不会传播到事件处理。有关可观察性问题的更多信息，请参阅 @EventListener 可观察性部分。

以下示例显示了用于注册和配置上述每个类的 bean 定义。

<bean id="emailService" class="example.EmailService">
	<property name="blockedList">
		<list>
			<value>[email protected]</value>
			<value>[email protected]</value>
			<value>[email protected]</value>
		</list>
	</property>
</bean>

<bean id="blockedListNotifier" class="example.BlockedListNotifier">
	<property name="notificationAddress" value="[email protected]"/>
</bean>

   <!-- optional: a custom ApplicationEventMulticaster definition -->
<bean id="applicationEventMulticaster" class="org.springframework.context.event.SimpleApplicationEventMulticaster">
	<property name="taskExecutor" ref="..."/>
	<property name="errorHandler" ref="..."/>
</bean>

将所有内容整合在一起，当调用 emailService bean 的 sendEmail() 方法时，如果存在任何应被阻止的电子邮件消息，则会发布类型为 BlockedListEvent 的自定义事件。blockedListNotifier bean 注册为 ApplicationListener 并接收 BlockedListEvent，此时它可以通知相关方。

Spring 的事件机制旨在用于同一应用程序上下文内 Spring bean 之间的简单通信。但是，对于更复杂的企业集成需求，单独维护的 Spring Integration 项目提供了对构建轻量级、面向模式、事件驱动的架构的完整支持，这些架构建立在众所周知的 Spring 编程模型之上。

基于注解的事件监听器

您可以使用 @EventListener 注解在托管 bean 的任何方法上注册事件监听器。BlockedListNotifier 可以改写如下

  • Java

  • Kotlin

public class BlockedListNotifier {

	private String notificationAddress;

	public void setNotificationAddress(String notificationAddress) {
		this.notificationAddress = notificationAddress;
	}

	@EventListener
	public void processBlockedListEvent(BlockedListEvent event) {
		// notify appropriate parties via notificationAddress...
	}
}
class BlockedListNotifier {

	lateinit var notificationAddress: String

	@EventListener
	fun processBlockedListEvent(event: BlockedListEvent) {
		// notify appropriate parties via notificationAddress...
	}
}

方法签名再次声明了它监听的事件类型，但这次使用了一个灵活的名称，并且没有实现特定的监听器接口。只要实际的事件类型在其实现层次结构中解析您的泛型参数，事件类型也可以通过泛型进行缩小。

如果您的方法应该监听多个事件，或者您想将其定义为没有参数，则事件类型也可以在注释本身中指定。以下示例展示了如何做到这一点。

  • Java

  • Kotlin

@EventListener({ContextStartedEvent.class, ContextRefreshedEvent.class})
public void handleContextStart() {
	// ...
}
@EventListener(ContextStartedEvent::class, ContextRefreshedEvent::class)
fun handleContextStart() {
	// ...
}

还可以通过使用定义 SpEL 表达式 的注释的 condition 属性来添加额外的运行时过滤，该表达式应该匹配以实际为特定事件调用方法。

以下示例展示了如何重写我们的通知器，使其仅在事件的 content 属性等于 my-event 时才被调用。

  • Java

  • Kotlin

@EventListener(condition = "#blEvent.content == 'my-event'")
public void processBlockedListEvent(BlockedListEvent blEvent) {
	// notify appropriate parties via notificationAddress...
}
@EventListener(condition = "#blEvent.content == 'my-event'")
fun processBlockedListEvent(blEvent: BlockedListEvent) {
	// notify appropriate parties via notificationAddress...
}

每个 SpEL 表达式都针对一个专用上下文进行评估。下表列出了提供给上下文的项目，以便您可以将它们用于条件事件处理。

表 2. 事件 SpEL 可用元数据
名称 位置 描述 示例

事件

根对象

实际的 ApplicationEvent。

#root.event 或 event

参数数组

根对象

用于调用方法的参数（作为对象数组）。

#root.args 或 args；args[0] 用于访问第一个参数，等等。

参数名称

评估上下文

任何方法参数的名称。如果由于某种原因，名称不可用（例如，因为编译后的字节码中没有调试信息），则可以使用 #a<#arg> 语法访问单个参数，其中 <#arg> 代表参数索引（从 0 开始）。

#blEvent 或 #a0（您也可以使用 #p0 或 #p<#arg> 参数表示法作为别名）

请注意，即使您的方法签名实际上引用了发布的任意对象，#root.event 也可以让您访问底层事件。

如果您需要在处理另一个事件的结果中发布事件，您可以更改方法签名以返回应发布的事件，如下例所示

  • Java

  • Kotlin

@EventListener
public ListUpdateEvent handleBlockedListEvent(BlockedListEvent event) {
	// notify appropriate parties via notificationAddress and
	// then publish a ListUpdateEvent...
}
@EventListener
fun handleBlockedListEvent(event: BlockedListEvent): ListUpdateEvent {
	// notify appropriate parties via notificationAddress and
	// then publish a ListUpdateEvent...
}
此功能不支持 异步监听器。

handleBlockedListEvent() 方法为它处理的每个 BlockedListEvent 发布一个新的 ListUpdateEvent。如果您需要发布多个事件，您可以返回一个 Collection 或一个事件数组。

异步监听器

如果您希望某个监听器异步处理事件，您可以重用 常规的 @Async 支持。以下示例展示了如何做到这一点

  • Java

  • Kotlin

@EventListener
@Async
public void processBlockedListEvent(BlockedListEvent event) {
	// BlockedListEvent is processed in a separate thread
}
@EventListener
@Async
fun processBlockedListEvent(event: BlockedListEvent) {
	// BlockedListEvent is processed in a separate thread
}

在使用异步事件时，请注意以下限制

  • 如果异步事件监听器抛出 Exception，它不会传播到调用者。有关更多详细信息，请参阅 AsyncUncaughtExceptionHandler。

  • 异步事件监听器方法不能通过返回值来发布后续事件。如果您需要在处理结果中发布另一个事件，请注入一个 ApplicationEventPublisher 以手动发布事件。

  • 默认情况下，ThreadLocals 和日志记录上下文不会传播到事件处理。有关可观察性问题的更多信息，请参阅 @EventListener 可观察性部分。

排序监听器

如果您需要一个监听器在另一个监听器之前被调用，您可以在方法声明中添加 @Order 注解，如下例所示

  • Java

  • Kotlin

@EventListener
@Order(42)
public void processBlockedListEvent(BlockedListEvent event) {
	// notify appropriate parties via notificationAddress...
}
@EventListener
@Order(42)
fun processBlockedListEvent(event: BlockedListEvent) {
	// notify appropriate parties via notificationAddress...
}

泛型事件

您也可以使用泛型来进一步定义事件的结构。考虑使用 EntityCreatedEvent<T>，其中 T 是创建的实际实体的类型。例如，您可以创建以下监听器定义以仅接收 Person 的 EntityCreatedEvent

  • Java

  • Kotlin

@EventListener
public void onPersonCreated(EntityCreatedEvent<Person> event) {
	// ...
}
@EventListener
fun onPersonCreated(event: EntityCreatedEvent<Person>) {
	// ...
}

由于类型擦除，这仅在触发的事件解析了事件监听器过滤的泛型参数时才有效（即，类似于 class PersonCreatedEvent extends EntityCreatedEvent<Person> { …​ }）。

在某些情况下，如果所有事件都遵循相同的结构（如前面的示例中的事件应该那样），这可能会变得相当繁琐。在这种情况下，您可以实现 ResolvableTypeProvider 来引导框架超越运行时环境提供的功能。以下事件展示了如何做到这一点

  • Java

  • Kotlin

public class EntityCreatedEvent<T> extends ApplicationEvent implements ResolvableTypeProvider {

	public EntityCreatedEvent(T entity) {
		super(entity);
	}

	@Override
	public ResolvableType getResolvableType() {
		return ResolvableType.forClassWithGenerics(getClass(), ResolvableType.forInstance(getSource()));
	}
}
class EntityCreatedEvent<T>(entity: T) : ApplicationEvent(entity), ResolvableTypeProvider {

	override fun getResolvableType(): ResolvableType? {
		return ResolvableType.forClassWithGenerics(javaClass, ResolvableType.forInstance(getSource()))
	}
}
这不仅适用于 ApplicationEvent，还适用于您作为事件发送的任何任意对象。

最后，与经典的 ApplicationListener 实现一样，实际的多播是在运行时通过上下文范围内的 ApplicationEventMulticaster 完成的。默认情况下，这是一个在调用者线程中进行同步事件发布的 SimpleApplicationEventMulticaster。可以通过“applicationEventMulticaster”bean 定义来替换/自定义它，例如，异步处理所有事件和/或处理监听器异常。

@Bean
ApplicationEventMulticaster applicationEventMulticaster() {
	SimpleApplicationEventMulticaster multicaster = new SimpleApplicationEventMulticaster();
	multicaster.setTaskExecutor(...);
	multicaster.setErrorHandler(...);
	return multicaster;
}

方便访问底层资源

为了最佳使用和理解应用程序上下文，您应该熟悉 Spring 的 Resource 抽象，如 资源 中所述。

应用程序上下文是一个 ResourceLoader，它可以用来加载 Resource 对象。Resource 本质上是 JDK java.net.URL 类的一个功能更丰富的版本。事实上，Resource 的实现封装了 java.net.URL 的实例，在适当的情况下。Resource 可以以透明的方式从几乎任何位置获取底层资源，包括类路径、文件系统位置、任何可以用标准 URL 描述的位置，以及其他一些变体。如果资源位置字符串是一个没有特殊前缀的简单路径，那么这些资源来自哪里是特定于实际应用程序上下文类型的。

您可以配置部署到应用程序上下文中的 bean 来实现特殊的回调接口 ResourceLoaderAware，以便在初始化时自动回调，并将应用程序上下文本身作为 ResourceLoader 传递进来。您还可以公开类型为 Resource 的属性，用于访问静态资源。它们像任何其他属性一样被注入到其中。您可以将这些 Resource 属性指定为简单的 String 路径，并在 bean 部署时依赖于从这些文本字符串到实际 Resource 对象的自动转换。

提供给 ApplicationContext 构造函数的位置路径或路径实际上是资源字符串，并且在简单形式下，根据特定的上下文实现进行适当的处理。例如，ClassPathXmlApplicationContext 将简单位置路径视为类路径位置。您还可以使用带有特殊前缀的位置路径（资源字符串）来强制从类路径或 URL 加载定义，而不管实际的上下文类型。

应用程序启动跟踪

ApplicationContext 管理 Spring 应用程序的生命周期，并提供围绕组件的丰富编程模型。因此，复杂的应用程序可能具有同样复杂的组件图和启动阶段。

使用特定指标跟踪应用程序启动步骤可以帮助理解启动阶段的时间消耗情况，但它也可以作为一种方式来更好地理解整个上下文生命周期。

AbstractApplicationContext（及其子类）使用 ApplicationStartup 进行 instrumentation，它收集有关各种启动阶段的 StartupStep 数据。

  • 应用程序上下文生命周期（基本包扫描、配置类管理）

  • Bean 生命周期（实例化、智能初始化、后处理）

  • 应用程序事件处理

以下是在 AnnotationConfigApplicationContext 中进行 instrumentation 的示例。

  • Java

  • Kotlin

// create a startup step and start recording
StartupStep scanPackages = getApplicationStartup().start("spring.context.base-packages.scan");
// add tagging information to the current step
scanPackages.tag("packages", () -> Arrays.toString(basePackages));
// perform the actual phase we're instrumenting
this.scanner.scan(basePackages);
// end the current step
scanPackages.end();
// create a startup step and start recording
val scanPackages = getApplicationStartup().start("spring.context.base-packages.scan")
// add tagging information to the current step
scanPackages.tag("packages", () -> Arrays.toString(basePackages))
// perform the actual phase we're instrumenting
this.scanner.scan(basePackages)
// end the current step
scanPackages.end()

应用程序上下文已经使用多个步骤进行 instrumentation。记录后，这些启动步骤可以使用特定工具进行收集、显示和分析。有关现有启动步骤的完整列表，请查看 专用附录部分。

默认的 ApplicationStartup 实现是一个无操作变体，用于最小化开销。这意味着默认情况下，应用程序启动期间不会收集任何指标。Spring Framework 附带了一个用于使用 Java Flight Recorder 跟踪启动步骤的实现：FlightRecorderApplicationStartup。要使用此变体，您必须在创建 ApplicationContext 后立即将其实例配置到 ApplicationContext 中。

开发人员也可以使用 ApplicationStartup 基础设施，如果他们提供自己的 AbstractApplicationContext 子类，或者如果他们希望收集更精确的数据。

ApplicationStartup 仅用于应用程序启动和核心容器；这绝不是 Java 分析器或指标库（如 Micrometer）的替代品。

要开始收集自定义 StartupStep，组件可以从应用程序上下文中直接获取 ApplicationStartup 实例，使其组件实现 ApplicationStartupAware，或在任何注入点请求 ApplicationStartup 类型。

开发人员在创建自定义启动步骤时不应使用 "spring.*" 命名空间。此命名空间保留用于 Spring 内部使用，可能会发生更改。

用于 Web 应用程序的便捷 ApplicationContext 实例化

您可以使用 ContextLoader 等方式声明式地创建 ApplicationContext 实例。当然，您也可以使用 ApplicationContext 实现之一以编程方式创建 ApplicationContext 实例。

您可以使用 ContextLoaderListener 注册 ApplicationContext，如下例所示。

<context-param>
	<param-name>contextConfigLocation</param-name>
	<param-value>/WEB-INF/daoContext.xml /WEB-INF/applicationContext.xml</param-value>
</context-param>

<listener>
	<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

侦听器检查 contextConfigLocation 参数。如果参数不存在，侦听器将使用 /WEB-INF/applicationContext.xml 作为默认值。当参数存在时，侦听器使用预定义的分隔符（逗号、分号和空格）将 String 分隔，并将值用作搜索应用程序上下文的 location。也支持 Ant 风格的路径模式。例如，/WEB-INF/*Context.xml（对于所有以 Context.xml 结尾且位于 WEB-INF 目录中的文件）和 /WEB-INF/**/*Context.xml（对于 WEB-INF 的任何子目录中的所有此类文件）。

将 Spring ApplicationContext 部署为 Jakarta EE RAR 文件

可以将 Spring ApplicationContext 部署为 RAR 文件，将上下文及其所有必需的 Bean 类和库 JAR 封装在 Jakarta EE RAR 部署单元中。这相当于引导一个独立的 ApplicationContext（仅在 Jakarta EE 环境中托管），能够访问 Jakarta EE 服务器的功能。RAR 部署是部署无头 WAR 文件（实际上是一个没有 HTTP 入口点的 WAR 文件，仅用于在 Jakarta EE 环境中引导 Spring ApplicationContext）的更自然替代方案。

RAR 部署非常适合不需要 HTTP 入口点，而是仅包含消息端点和计划作业的应用程序上下文。此类上下文中的 Bean 可以使用应用程序服务器资源，例如 JTA 事务管理器和 JNDI 绑定 JDBC DataSource 实例和 JMS ConnectionFactory 实例，还可以注册到平台的 JMX 服务器 - 所有这些都通过 Spring 的标准事务管理以及 JNDI 和 JMX 支持设施实现。应用程序组件还可以通过 Spring 的 TaskExecutor 抽象与应用程序服务器的 JCA WorkManager 进行交互。

有关 RAR 部署中涉及的配置详细信息，请参阅 SpringContextResourceAdapter 类的 javadoc。

要将 Spring ApplicationContext 作为 Jakarta EE RAR 文件进行简单部署，请执行以下操作：

  1. 将所有应用程序类打包到 RAR 文件中（这是一个具有不同文件扩展名的标准 JAR 文件）。

  2. 将所有必需的库 JAR 添加到 RAR 存档的根目录中。

  3. 添加一个 META-INF/ra.xml 部署描述符（如 SpringContextResourceAdapter 的 javadoc 中所示）以及相应的 Spring XML Bean 定义文件（通常为 META-INF/applicationContext.xml）。

  4. 将生成的 RAR 文件放到应用程序服务器的部署目录中。

此类 RAR 部署单元通常是自包含的。它们不会将组件暴露给外部世界，甚至不会暴露给同一应用程序的其他模块。与基于 RAR 的 ApplicationContext 的交互通常通过它与其他模块共享的 JMS 目标进行。基于 RAR 的 ApplicationContext 还可以（例如）安排一些作业或对文件系统（或类似系统）中的新文件做出反应。如果它需要允许来自外部的同步访问，它可以（例如）导出 RMI 端点，这些端点可以被同一台机器上的其他应用程序模块使用。