Additional Capabilities of the ApplicationContext

  • 事件发布,通过 ApplicationEventPublisher 接口发布到实现 ApplicationListener 接口的 bean。

  • 通过 HierarchicalBeanFactory 加载多个(分层的)上下文。 Spring 提供了 Resource 接口,它可以透明地从各种来源获取低级资源。ApplicationContext 作为 ResourceLoader,允许 bean 访问这些资源。 Spring 应用程序上下文管理应用程序生命周期,包括组件关系图和启动阶段。ApplicationStartup 用来监控这些应用程序启动步骤,收集从应用程序上下文生命周期阶段中收集的数据。默认情况下,ApplicationStartup 是非操作的,但 Spring 提供了 FlightRecorderApplicationStartup 实现,可以使用 Java Flight Recorder 追踪启动步骤。 可以在 Web 应用程序中声明性创建 ApplicationContext,方法是使用 ContextLoader 和 ContextLoaderListener。此外,Spring ApplicationsContext 可以部署为 Jakarta EE RAR 文件,在该文件中,上下文及其所有必需的 bean 类和库 JAR 都封装在一个 Jakarta EE RAR 部署单元中。

如同 "@21" 中所讨论的,"@14" 包提供用于管理和操作 Bean 的基本功能,包括以编程的方式。"@15" 包添加 "@16" 接口,它扩展了 "@17" 接口,此外还扩展了其他接口,以便以更面向应用程序框架的方式提供附加功能。许多人以完全声明的方式使用 "@18",甚至不以编程方式创建它,而是依赖于诸如 "@19" 之类的支持类,以便在 Jakarta EE Web 应用程序的正常启动过程中自动实例化 "@20"。 为了以更面向框架的方式增强 BeanFactory 功能,contextpackage 还提供以下功能:

  • 通过 MessageSource 接口,以 i18n 样式访问消息。

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

  • 事件发布,即通过使用 ApplicationEventPublisher 接口,向实施 ApplicationListener 接口的 bean。

  • 加载多个(层次)上下文,让每一个都专注于某一特定层,例如通过 HierarchicalBeanFactory 接口,应用程序的 Web 层。

Internationalization using 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 实现,ResourceBundleMessageSourceReloadableResourceBundleMessageSourceStaticMessageSource。所有这些实现都实现了 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”的资源包。解决消息的任何请求均以通过 ResourceBundle 对象解决消息的 JDK 标准方式来处理。出于示例目的,假定以上两个资源包文件的内容如下:

# 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.propertiesexceptions.propertieswindows.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.propertiesexceptions_en_GB.propertieswindows_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 类。此变体支持相同的 bundle 文件格式,但比基于标准 JDK 的 ResourceBundleMessageSource 实现更灵活。特别是,它允许从任何 Spring 资源位置(不仅是类路径)读取文件,并且支持热重新加载 bundle 属性文件(同时有效地缓存它们)。请参阅 ReloadableResourceBundleMessageSource javadoc 了解更多详情。

Standard and Custom Events

ApplicationEvent”类和`ApplicationListener`接口在“ApplicationContext”中提供事件处理。如果实现`ApplicationListener`接口的bean被部署到上下文中,那么每次`ApplicationEvent`发布到“ApplicationContext”,这个bean都会收到通知。实际上,这是标准观察者设计模式。

从 Spring 4.2 开始,事件基础设施得到了显著改进,并提供 annotation-based model 以及发布任何任意事件(即,不一定要从 ApplicationEvent 扩展出来的对象)的能力。当发布这样的对象时,我们将其包装在事件中。

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

Table 1. Built-in Events
Event Explanation

ContextRefreshedEvent

ApplicationContext 初始化或刷新时发布(例如,通过在 ConfigurableApplicationContext 接口上使用 refresh() 方法)。此处,“initialized” 表示已加载所有 Bean,检测并激活了后置处理器 Bean,进行了 Singleton 的预实例化,并且已准备就绪供 ApplicationContext 对象使用。只要上下文尚未关闭,就可以多次触发刷新,前提是所选的 ApplicationContext 实际上支持此类 “hot” 刷新。例如,XmlWebApplicationContext 支持热刷新,但 GenericApplicationContext 不支持。

ContextStartedEvent

在通过 ConfigurableApplicationContext 界面上的 start() 方法启动 ApplicationContext 时发布。此处,“started” 表示所有 Lifecycle bean 都接收一个显式启动信号。此信号通常用于在显式停止后重新启动 bean,但也可用于启动尚未配置自动启动的组件(例如,在初始化时尚未启动的组件)。

ContextStoppedEvent

在通过 ConfigurableApplicationContext 界面上的 stop() 方法停止 ApplicationContext 时发布。此处,“stopped” 表示所有 Lifecycle bean 都接收一个显式停止信号。可以通过 start() 调用重新启动已停止的上下文。

ContextClosedEvent

在通过 ConfigurableApplicationContext 界面上的 close() 方法或通过 JVM 停机钩关闭 ApplicationContext 时发布。其中,“关闭”表示所有单例 bean 都将被销毁。一旦关闭上下文,它将达到使用寿命终点并且无法刷新或重新启动。

RequestHandledEvent

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

ServletRequestHandledEvent

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

您还可以创建并发布您自己的自定义事件。以下示例演示了一个扩展 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...
	}
}

请注意,"@22" 使用自定义事件的类型 (@23,在前一个示例中) 进行了泛型参数化。这意味着 "@24" 方法可以保持类型安全,避免任何向下转换的需要。你可以随意注册任意数量的事件侦听器,但需要注意的是,默认情况下,事件侦听器会同步接收事件。这意味着,"@25" 方法会阻塞,直到所有侦听器完成对事件的处理。这种同步单线程方法的一个优点是,当侦听器接收事件时,它会在发布者的事务上下文中操作,如果事务上下文可用的话。如果需要采用另一种事件发布策略,例如默认异步事件处理,请参阅 Spring 的 @26" 接口和 @27" 实现的 javadoc 文档,了解可应用于自定义 "applicationEventMulticaster" Bean 定义的配置选项。在这些情况下,不会为事件处理传播 ThreadLocal 和日志上下文。请参阅 "@29",了解有关可观察性问题的详细信息。

下面的示例显示了用于注册和配置以上每个类的 Bean 定义:

<bean id="emailService" class="example.EmailService">
	<property name="blockedList">
		<list>
			<value>known.spammer@example.org</value>
			<value>known.hacker@example.org</value>
			<value>john.doe@example.org</value>
		</list>
	</property>
</bean>

<bean id="blockedListNotifier" class="example.BlockedListNotifier">
	<property name="notificationAddress" value="blockedlist@example.org"/>
</bean>

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

综上所述,当 bean emailServicesendEmail() 方法被调用时,若有应被拦截的邮件信息,则会发布 BlockedListEvent 类型的特定事件。 bean blockedListNotifier 注册为 ApplicationListener 并接收 BlockedListEvent,而后可以通知相关方。

Spring 的事件机制旨在用于同一应用程序上下文中 Spring bean 之间的简单通信。但是,对于更复杂的企业集成需求,单独维护的 Spring Integration 项目完全支持构建基于众所周知的 Spring 编程模型的轻量级、 pattern-oriented 事件驱动的体系结构。

Annotation-based Event Listeners

你可以使用 @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 expression 的注解的 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 表达式都是针对专用上下文进行计算。下表列出了提供给上下文的项目,以便你可以使用它们进行条件事件处理:

Table 2. Event SpEL available metadata
Name Location Description Example

Event

root object

The actual ApplicationEvent.

#root.event or event

Arguments array

root object

用于调用方法的参数(作为对象数组)。

#root.args`或 `args;`args[0]`访问第一个参数等。

Argument name

evaluation context

任何方法参数的名称。如果由于某些原因(例如编译的字节码中没有调试信息)而无法使用名称,则还可以使用 #a&lt;#arg&gt; 语法访问各个参数,其中 &lt;#arg&gt; 表示参数索引(从 0 开始)。

#blEvent#a0(您还可以将 #p0#p&lt;#arg&gt; 参数符号用作别名)

请注意,#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...
}

asynchronous listeners 不支持此功能。

handleBlockedListEvent() 方法为其处理的每个 BlockedListEvent 发布一个新的 ListUpdateEvent。如果你需要发布多个事件,则可以返回一个 Collection 或一系列事件。

Asynchronous Listeners

如果您希望特定监听器异步处理事件,可以重复使用xref:integration/scheduling.adoc#scheduling-annotation-support-async[regular @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 以手动发布事件。

  • 事件处理默认不会传播 ThreadLocal 和日志记录上下文。有关可观察性方面的更多信息,请参阅 the @EventListener Observability section

Ordering Listeners

如果你需要在另一个前一个侦听器之前调用一个侦听器,则可以将 @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...
}

Generic Events

还可以使用泛型进一步定义事件的结构。考虑使用 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;
}

Convenient Access to Low-level Resources

针对应用程序上下文的最佳使用和理解,你应该熟悉 Spring 的 "@30" 抽象,如 "@31" 中所述。

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

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

提供给 ApplicationContext 构造函数的位置路径实际是资源字符串,并且在简单形式中,会根据特定的上下文实现进行适当处理。例如,ClassPathXmlApplicationContext 会将一个简单的位置路径视为类路径位置。你还可以将位置路径(资源字符串)与特殊前缀一起使用,以强制从类路径或 URL 加载定义,而不用考虑实际的上下文类型。

Application Startup Tracking

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

利用具体度量追踪应用程序启动步骤可以帮助了解在启动阶段花费时间的地方,但也可以用来更好地了解整个上下文生命周期。

AbstractApplicationContext(及其子类)会用一个`ApplicationStartup`进行监控,它会收集`StartupStep`数据,这些数据来自各个启动阶段:

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

  • bean 生命周期(实例化、智能初始化、后处理)

  • application events processing

以下是`AnnotationConfigApplicationContext`中的一个监控示例:

  • 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()

应用程序上下文已经使用多步骤检测。记录后,这些启动步骤可以使用特定工具收集、显示和分析。有关现有启动步骤的完整列表,您可以查看 dedicated appendix section

默认的`ApplicationStartup`实现是一种无操作变体,开销最小。这意味着默认情况下不会在应用程序启动期间收集任何指标。Spring Framework 提供了一个用于使用 Java Flight Recorder 追踪启动步骤的实现:FlightRecorderApplicationStartup。若要使用此变体,必须将其实例配置到`ApplicationContext`,只要该实例已被创建。

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

ApplicationStartup 仅用于应用程序启动期间和核心容器中; 决不会替代 Java 分析器或像 Micrometer 这样的指标库。

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

开发人员在创建自定义启动步骤时不应使用 "spring.*" 命名空间。此命名空间专用于 Spring 内部使用且如有更改,恕不另行通知。

Convenient ApplicationContext Instantiation for Web Applications

可以使用`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`,并使用这些值作为搜索应用程序上下文的位置。还支持 Ant 样式的路径模式。示例包括`/WEB-INF/Context.xml`(针对所有名称以`Context.xml`结尾且驻留在`WEB-INF`目录中的文件)和`/WEB-INF/*/*Context.xml`(针对`WEB-INF`的任何子目录中的所有此类文件)。

Deploying a Spring ApplicationContext as a Jakarta EE RAR File

可以将 Spring ApplicationContext`部署为 RAR 文件,封装上下文及其所有必需的 bean 类和库 JAR,这些文件都封装在一个 Jakarta EE RAR 部署单元中。这相当于引导独立的`ApplicationContext(仅托管在 Jakarta EE 环境中),该`ApplicationContext`能够访问 Jakarta EE 服务器设施。RAR 部署是无头 WAR 文件部署场景的更自然替代方案,事实上,它是一个没有任何 HTTP 入口点的 WAR 文件,仅用于在 Jakarta EE 环境中引导 Spring ApplicationContext

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

参阅https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/jca/context/SpringContextResourceAdapter.html[SpringContextResourceAdapter]类的 javadoc 以了解 RAR 部署中涉及的配置详情。

若要简单部署 Spring ApplicationContext 作为 Jakarta EE RAR 文件:

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

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

  3. 添加 META-INF/ra.xml 部署描述符(如 javadoc for SpringContextResourceAdapter 所示)和相应的 Spring XML bean 定义文件(通常为 META-INF/applicationContext.xml)。

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

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