容器概述

org.springframework.context.ApplicationContext 接口代表 Spring IoC 容器,负责实例化、配置和组装 Bean。容器通过读取配置元数据来获取有关要实例化、配置和组装的组件的指令。配置元数据可以表示为带注解的组件类、带有工厂方法的配置类或外部 XML 文件或 Groovy 脚本。无论使用哪种格式,您都可以组合您的应用程序以及这些组件之间丰富的相互依赖关系。

Spring 核心包含多个 ApplicationContext 接口的实现。在独立应用程序中,通常会创建 AnnotationConfigApplicationContextClassPathXmlApplicationContext 的实例。

在大多数应用程序场景中,不需要显式用户代码来实例化一个或多个 Spring IoC 容器实例。例如,在普通 Web 应用程序场景中,应用程序的 web.xml 文件中的一个简单的样板 Web 描述符 XML 就足够了(参见 Web 应用程序的便捷 ApplicationContext 实例化)。在 Spring Boot 场景中,应用程序上下文会根据常见的设置约定隐式地为你引导。

下图显示了 Spring 工作原理的高级视图。您的应用程序类与配置元数据相结合,因此在创建和初始化 ApplicationContext 后,您将拥有一个完全配置且可执行的系统或应用程序。

container magic
图 1. Spring IoC 容器

配置元数据

如上图所示,Spring IoC 容器使用某种形式的配置元数据。此配置元数据表示您作为应用程序开发人员如何告诉 Spring 容器实例化、配置和组装应用程序中的组件。

Spring IoC 容器本身与实际写入此配置元数据的格式完全解耦。如今,许多开发人员为其 Spring 应用程序选择 基于 Java 的配置

Spring 配置至少包含一个,通常包含多个 bean 定义,容器必须管理这些定义。Java 配置通常在 @Configuration 类中使用 @Bean 注释的方法,每个方法对应一个 bean 定义。

这些 Bean 定义对应于构成应用程序的实际对象。通常,您定义服务层对象、持久层对象(如存储库或数据访问对象 (DAO))、表示层对象(如 Web 控制器)、基础设施对象(如 JPA EntityManagerFactory、JMS 队列)等等。通常,人们不会在容器中配置细粒度的域对象,因为创建和加载域对象通常是存储库和业务逻辑的责任。

XML 作为外部配置 DSL

基于 XML 的配置元数据将这些 Bean 配置为顶级 <beans/> 元素内的 <bean/> 元素。以下示例显示了基于 XML 的配置元数据的基本结构

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd">

	<bean id="..." class="..."> (1) (2)
		<!-- collaborators and configuration for this bean go here -->
	</bean>

	<bean id="..." class="...">
		<!-- collaborators and configuration for this bean go here -->
	</bean>

	<!-- more bean definitions go here -->

</beans>
1 id 属性是一个字符串,用于标识单个 Bean 定义。
2 class 属性定义 Bean 的类型,并使用完全限定的类名。

id 属性的值可用于引用协作对象。此示例中未显示引用协作对象的 XML。有关更多信息,请参见 依赖项

要实例化容器,需要将 XML 资源文件的路径提供给 ClassPathXmlApplicationContext 构造函数,该构造函数允许容器从各种外部资源(如本地文件系统、Java CLASSPATH 等)加载配置元数据。

  • Java

  • Kotlin

ApplicationContext context = new ClassPathXmlApplicationContext("services.xml", "daos.xml");
val context = ClassPathXmlApplicationContext("services.xml", "daos.xml")

在您了解了 Spring 的 IoC 容器之后,您可能希望了解更多关于 Spring 的 Resource 抽象(如 资源 中所述),它提供了一种方便的机制,用于从 URI 语法中定义的位置读取 InputStream。特别是,Resource 路径用于构造应用程序上下文,如 应用程序上下文和资源路径 中所述。

以下示例显示了服务层对象 (services.xml) 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd">

	<!-- services -->

	<bean id="petStore" class="org.springframework.samples.jpetstore.services.PetStoreServiceImpl">
		<property name="accountDao" ref="accountDao"/>
		<property name="itemDao" ref="itemDao"/>
		<!-- additional collaborators and configuration for this bean go here -->
	</bean>

	<!-- more bean definitions for services go here -->

</beans>

以下示例显示了数据访问对象 daos.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd">

	<bean id="accountDao"
		class="org.springframework.samples.jpetstore.dao.jpa.JpaAccountDao">
		<!-- additional collaborators and configuration for this bean go here -->
	</bean>

	<bean id="itemDao" class="org.springframework.samples.jpetstore.dao.jpa.JpaItemDao">
		<!-- additional collaborators and configuration for this bean go here -->
	</bean>

	<!-- more bean definitions for data access objects go here -->

</beans>

在前面的示例中,服务层由PetStoreServiceImpl类和两个数据访问对象组成,类型分别为JpaAccountDaoJpaItemDao(基于JPA对象关系映射标准)。property name元素指的是JavaBean属性的名称,而ref元素指的是另一个bean定义的名称。idref元素之间的这种关联表达了协作对象之间的依赖关系。有关配置对象依赖关系的详细信息,请参见依赖关系

组合基于XML的配置元数据

将bean定义跨多个XML文件可能很有用。通常,每个单独的XML配置文件代表您架构中的逻辑层或模块。

您可以使用ClassPathXmlApplicationContext构造函数从XML片段加载bean定义。此构造函数接受多个Resource位置,如上一节所示。或者,使用一个或多个<import/>元素来从另一个文件或多个文件中加载bean定义。以下示例展示了如何执行此操作

<beans>
	<import resource="services.xml"/>
	<import resource="resources/messageSource.xml"/>
	<import resource="/resources/themeSource.xml"/>

	<bean id="bean1" class="..."/>
	<bean id="bean2" class="..."/>
</beans>

在前面的示例中,外部bean定义从三个文件加载:services.xmlmessageSource.xmlthemeSource.xml。所有位置路径都是相对于执行导入的定义文件的,因此services.xml必须与执行导入的文件位于同一目录或类路径位置,而messageSource.xmlthemeSource.xml必须位于导入文件位置下的resources位置。如您所见,前导斜杠将被忽略。但是,鉴于这些路径是相对的,最好不要使用斜杠。根据Spring Schema,被导入的文件的内容(包括顶层<beans/>元素)必须是有效的XML bean定义。

可以使用相对路径“../”引用父目录中的文件,但这样做不建议。这样做会创建对当前应用程序外部文件的依赖关系。特别是,不建议将此引用用于classpath: URL(例如,classpath:../services.xml),其中运行时解析过程会选择“最近”的类路径根,然后查看其父目录。类路径配置更改可能会导致选择不同的、不正确的目录。

您可以始终使用完全限定的资源位置而不是相对路径:例如,file:C:/config/services.xmlclasspath:/config/services.xml。但是,请注意,您正在将应用程序的配置与特定的绝对位置耦合。通常,最好为这些绝对位置保留一个间接层——例如,通过在运行时针对JVM系统属性解析的“${…​}”占位符。

命名空间本身提供了导入指令功能。除了简单的 bean 定义之外,Spring 提供的各种 XML 命名空间中还提供了其他配置功能,例如 contextutil 命名空间。

Groovy Bean 定义 DSL

作为外部化配置元数据的另一个示例,bean 定义也可以用 Spring 的 Groovy Bean 定义 DSL 表达,如 Grails 框架中所知。通常,此类配置位于具有以下示例所示结构的“.groovy”文件中

beans {
	dataSource(BasicDataSource) {
		driverClassName = "org.hsqldb.jdbcDriver"
		url = "jdbc:hsqldb:mem:grailsDB"
		username = "sa"
		password = ""
		settings = [mynew:"setting"]
	}
	sessionFactory(SessionFactory) {
		dataSource = dataSource
	}
	myService(MyService) {
		nestedBean = { AnotherBean bean ->
			dataSource = dataSource
		}
	}
}

这种配置风格在很大程度上等同于 XML bean 定义,甚至支持 Spring 的 XML 配置命名空间。它还允许通过 importBeans 指令导入 XML bean 定义文件。

使用容器

ApplicationContext 是一个高级工厂的接口,它能够维护不同 bean 及其依赖项的注册表。通过使用 T getBean(String name, Class<T> requiredType) 方法,您可以检索 bean 的实例。

ApplicationContext 允许您读取 bean 定义并访问它们,如下面的示例所示

  • Java

  • Kotlin

// create and configure beans
ApplicationContext context = new ClassPathXmlApplicationContext("services.xml", "daos.xml");

// retrieve configured instance
PetStoreService service = context.getBean("petStore", PetStoreService.class);

// use configured instance
List<String> userList = service.getUsernameList();
   import org.springframework.beans.factory.getBean

// create and configure beans
   val context = ClassPathXmlApplicationContext("services.xml", "daos.xml")

   // retrieve configured instance
   val service = context.getBean<PetStoreService>("petStore")

   // use configured instance
   var userList = service.getUsernameList()

使用 Groovy 配置,引导过程看起来非常相似。它有一个不同的上下文实现类,该类支持 Groovy(但也理解 XML bean 定义)。以下示例显示了 Groovy 配置

  • Java

  • Kotlin

ApplicationContext context = new GenericGroovyApplicationContext("services.groovy", "daos.groovy");
val context = GenericGroovyApplicationContext("services.groovy", "daos.groovy")

最灵活的变体是 GenericApplicationContext 与读取器委托相结合,例如,使用 XmlBeanDefinitionReader 读取 XML 文件,如下面的示例所示

  • Java

  • Kotlin

GenericApplicationContext context = new GenericApplicationContext();
new XmlBeanDefinitionReader(context).loadBeanDefinitions("services.xml", "daos.xml");
context.refresh();
val context = GenericApplicationContext()
XmlBeanDefinitionReader(context).loadBeanDefinitions("services.xml", "daos.xml")
context.refresh()

您也可以使用 GroovyBeanDefinitionReader 读取 Groovy 文件,如下面的示例所示

  • Java

  • Kotlin

GenericApplicationContext context = new GenericApplicationContext();
new GroovyBeanDefinitionReader(context).loadBeanDefinitions("services.groovy", "daos.groovy");
context.refresh();
val context = GenericApplicationContext()
GroovyBeanDefinitionReader(context).loadBeanDefinitions("services.groovy", "daos.groovy")
context.refresh()

您可以在同一个 ApplicationContext 上混合和匹配这些读取器委托,从不同的配置源读取 bean 定义。

然后,您可以使用 getBean 来检索 bean 的实例。ApplicationContext 接口还有一些其他方法用于检索 bean,但理想情况下,您的应用程序代码不应该使用它们。实际上,您的应用程序代码根本不应该调用 getBean() 方法,因此也不应该依赖于 Spring API。例如,Spring 与 Web 框架的集成为各种 Web 框架组件(如控制器和 JSF 托管 bean)提供了依赖注入,让您能够通过元数据(如自动装配注释)声明对特定 bean 的依赖关系。