下面的章节记录了 Spring 的 AnnotationConfigApplicationContext,它在 Spring 3.0 中引入。这个多功能的 ApplicationContext 实现不仅能够接受 @Configuration
类作为输入,还能够接受普通的@Component
类和用 JSR-330 元数据注解的类。
当 @Configuration 类被提供为输入时,@Configuration 类本身被注册为 Bean 定义,该类中所有声明的@Bean 方法也被注册为 Bean 定义。
当 @Component 和 JSR-330 类被提供时,它们被注册为 bean 定义,并且假定 DI 元数据如 @Autowired或 @Inject 在必要时被用于这些类。
简单结构
与实例化 ClassPathXmlApplicationContext 时使用 Spring XML 文件作为输入一样,你可以在实例化AnnotationConfigApplicationContext 时使用 @Configuration 类作为输入。这使得 Spring 容器的使用完全不需要 XML,正如下面的例子所示:
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
MyService myService = ctx.getBean(MyService.class);
myService.doStuff();
}
如前所述,AnnotationConfigApplicationContext 不限于只与 @Configuration 类一起工作。任何@Component 或 JSR-330 注释的类都可以作为输入提供给构造函数,正如下面的例子所示:
public static void main(String[] args) {
ApplicationContext ctx = new AnnotationConfigApplicationContext(MyServiceImpl.class, Dependency1.class, Dependency2.class);
MyService myService = ctx.getBean(MyService.class);
myService.doStuff();
}
前面的例子假设 MyServiceImpl、Dependency1 和 Dependency2 使用 Spring 的依赖注入注解,如 @Autowired。
使用编程方式构建容器:register(Class<?>…)
你可以通过使用无参数构造函数来实例化 AnnotationConfigApplicationContext,然后通过 register()
方法来配置它。这种方法在以编程方式构建 AnnotationConfigApplicationContext 时特别有用。下面的例子展示了如何做到这一点:
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();
}
启用组件扫描:scan(String…)
为了启用组件扫描,你可以对你的 @Configuration 类做如下注解:
@Configuration
@ComponentScan(basePackages = "com.acme")
public class AppConfig {
// ...
}
:::tips 有经验的 Spring 用户可能熟悉与 Spring 的 context: namespace 等价的 XML 声明,如下例所示:
:::
<beans>
<context:component-scan base-package="com.acme"/>
</beans>
在前面的例子中,com.acme 包被扫描以寻找任何 @Component 注解的类,这些类被注册为容器中的Spring Bean 定义。AnnotationConfigApplicationContext 暴露了 scan(String...)
方法,以实现同样的组件扫描功能,如下例所示:
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.scan("com.acme");
ctx.refresh();
MyService myService = ctx.getBean(MyService.class);
}
:::info
请记住,@Configuration 类是用 @Component 元注解 的,所以它们是组件扫描的候选者。在前面的例子中,假设 AppConfig 是在 com.acme 包(或下面的任何包)中声明的,它在调用 scan()
时被选中。在 refresh()
时,它的所有 @Bean 方法都被处理并注册为容器中的 bean 定义。
:::
对 Web 应用的支持:AnnotationConfigWebApplicationContext
AnnotationConfigApplicationContext 的一个 WebApplicationContext 变体可以用AnnotationConfigWebApplicationContext。你可以在配置 Spring ContextLoaderListener servlet 监听器、Spring MVC DispatcherServlet 等时使用这个实现。下面的 web.xm l片段配置了一个典型的 Spring MVC Web 应用(注意使用 contextClass 、context-param 和 init-param)。
<web-app>
<!-- 配置 ContextLoaderListener 以使用 AnnotationConfigWebApplicationContext
而不是默认的 XmlWebApplicationContext -->
<context-param>
<param-name>contextClass</param-name>
<param-value>
org.springframework.web.context.support.AnnotationConfigWebApplicationContext
</param-value>
</context-param>
<!-- 配置位置必须由一个或多个以逗号或空格分隔的
完全限定的 @Configuration 类。完全限定的包也可以被
指定用于组件扫描的 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>com.acme.AppConfig</param-value>
</context-param>
<!-- 像往常一样使用 ContextLoaderListener 引导根应用程序上下文。 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- 像往常一样声明一个 Spring MVC DispatcherServlet -->
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 配置 DispatcherServlet 以使用 AnnotationConfigWebApplicationContext
而不是默认的 XmlWebApplicationContext -->
<init-param>
<param-name>contextClass</param-name>
<param-value>
org.springframework.web.context.support.AnnotationConfigWebApplicationContext
</param-value>
</init-param>
<!-- 同样,配置位置必须由一个或多个以逗号或空格分隔的
和完全限定的 @Configuration 类。 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>com.acme.web.MvcConfig</param-value>
</init-param>
</servlet>
<!-- 将所有对 /app/* 的请求映射到 dispatcher servlet。-->
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/app/*</url-pattern>
</servlet-mapping>
</web-app>