使用 AnnotationConfigApplicationContext 实例化 Spring 容器

以下部分记录了 Spring 在 3.0 版本中引入的 AnnotationConfigApplicationContext。这个多功能的 ApplicationContext 实现不仅能够接受 @Configuration 类作为输入，还可以接受普通的 @Component 类以及使用 JSR-330 元数据注释的类。

当提供 @Configuration 类作为输入时，@Configuration 类本身会被注册为一个 Bean 定义，并且类中声明的所有 @Bean 方法也会被注册为 Bean 定义。

当提供 @Component 和 JSR-330 类时，它们会被注册为 Bean 定义，并且假设在这些类中根据需要使用了 DI 元数据，例如 @Autowired 或 @Inject。

简单构造

与使用 Spring XML 文件作为输入实例化 ClassPathXmlApplicationContext 的方式类似，您可以在实例化 AnnotationConfigApplicationContext 时使用 @Configuration 类作为输入。这允许完全无 XML 地使用 Spring 容器，如下例所示

  • Java

  • Kotlin

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}
import org.springframework.beans.factory.getBean

fun main() {
	val ctx = AnnotationConfigApplicationContext(AppConfig::class.java)
	val myService = ctx.getBean<MyService>()
	myService.doStuff()
}

如前所述，AnnotationConfigApplicationContext 不仅限于仅与 @Configuration 类一起使用。任何 @Component 或 JSR-330 注释的类都可以作为输入提供给构造函数，如下例所示

  • Java

  • Kotlin

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(MyServiceImpl.class, Dependency1.class, Dependency2.class);
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}
import org.springframework.beans.factory.getBean

fun main() {
	val ctx = AnnotationConfigApplicationContext(MyServiceImpl::class.java, Dependency1::class.java, Dependency2::class.java)
	val myService = ctx.getBean<MyService>()
	myService.doStuff()
}

前面的示例假设 MyServiceImpl、Dependency1 和 Dependency2 使用 Spring 依赖注入注解，例如 @Autowired。

使用 register(Class<?>…​) 以编程方式构建容器

您可以使用无参数构造函数实例化 AnnotationConfigApplicationContext，然后使用 register() 方法对其进行配置。这种方法在以编程方式构建 AnnotationConfigApplicationContext 时特别有用。以下示例展示了如何操作

  • Java

  • Kotlin

public static void main(String[] args) {
	AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
	ctx.register(AppConfig.class, OtherConfig.class);
	ctx.register(AdditionalConfig.class);
	ctx.refresh();
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}
import org.springframework.beans.factory.getBean

fun main() {
	val ctx = AnnotationConfigApplicationContext()
	ctx.register(AppConfig::class.java, OtherConfig::class.java)
	ctx.register(AdditionalConfig::class.java)
	ctx.refresh()
	val myService = ctx.getBean<MyService>()
	myService.doStuff()
}

使用 scan(String…​) 启用组件扫描

要启用组件扫描，您可以像下面这样注释您的 @Configuration 类

  • Java

  • Kotlin

@Configuration
@ComponentScan(basePackages = "com.acme") (1)
public class AppConfig  {
	// ...
}
1 此注解启用组件扫描。 
@Configuration
@ComponentScan(basePackages = ["com.acme"]) (1)
class AppConfig  {
	// ...
}
1 此注解启用组件扫描。

经验丰富的 Spring 用户可能熟悉来自 Spring 的 context: 命名空间的等效 XML 声明，如下例所示

<beans>
	<context:component-scan base-package="com.acme"/>
</beans>

在前面的示例中，com.acme 包会被扫描以查找任何 @Component 注释的类，并且这些类会被注册为容器内的 Spring Bean 定义。AnnotationConfigApplicationContext 公开了 scan(String…​) 方法以允许相同组件扫描功能，如下例所示

  • Java

  • Kotlin

public static void main(String[] args) {
	AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
	ctx.scan("com.acme");
	ctx.refresh();
	MyService myService = ctx.getBean(MyService.class);
}
fun main() {
	val ctx = AnnotationConfigApplicationContext()
	ctx.scan("com.acme")
	ctx.refresh()
	val myService = ctx.getBean<MyService>()
}
请记住，@Configuration 类使用 @Component 进行元注释，因此它们是组件扫描的候选对象。在前面的示例中，假设 AppConfig 声明在 com.acme 包（或其任何子包）中，它会在调用 scan() 期间被拾取。在 refresh() 后，其所有 @Bean 方法都会被处理并注册为容器内的 Bean 定义。

使用 AnnotationConfigWebApplicationContext 支持 Web 应用程序

AnnotationConfigApplicationContext 的 WebApplicationContext 变体可通过 AnnotationConfigWebApplicationContext 获得。在配置 Spring ContextLoaderListener servlet 监听器、Spring MVC DispatcherServlet 等时可以使用此实现。以下 web.xml 代码片段配置了一个典型的 Spring MVC Web 应用程序（请注意 contextClass 上下文参数和初始化参数的使用）

<web-app>
	<!-- Configure ContextLoaderListener to use AnnotationConfigWebApplicationContext
		instead of the default XmlWebApplicationContext -->
	<context-param>
		<param-name>contextClass</param-name>
		<param-value>
			org.springframework.web.context.support.AnnotationConfigWebApplicationContext
		</param-value>
	</context-param>

	<!-- Configuration locations must consist of one or more comma- or space-delimited
		fully-qualified @Configuration classes. Fully-qualified packages may also be
		specified for component-scanning -->
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>com.acme.AppConfig</param-value>
	</context-param>

	<!-- Bootstrap the root application context as usual using ContextLoaderListener -->
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

	<!-- Declare a Spring MVC DispatcherServlet as usual -->
	<servlet>
		<servlet-name>dispatcher</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<!-- Configure DispatcherServlet to use AnnotationConfigWebApplicationContext
			instead of the default XmlWebApplicationContext -->
		<init-param>
			<param-name>contextClass</param-name>
			<param-value>
				org.springframework.web.context.support.AnnotationConfigWebApplicationContext
			</param-value>
		</init-param>
		<!-- Again, config locations must consist of one or more comma- or space-delimited
			and fully-qualified @Configuration classes -->
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>com.acme.web.MvcConfig</param-value>
		</init-param>
	</servlet>

	<!-- map all requests for /app/* to the dispatcher servlet -->
	<servlet-mapping>
		<servlet-name>dispatcher</servlet-name>
		<url-pattern>/app/*</url-pattern>
	</servlet-mapping>
</web-app>
对于编程用例，GenericWebApplicationContext 可以用作 AnnotationConfigWebApplicationContext 的替代方案。有关详细信息，请参阅GenericWebApplicationContext javadoc。