跳到主要内容

使用 AnnotationConfigApplicationContext 实例化 Spring 容器

DeepSeek V3 中英对照 Instantiating the Spring Container by Using AnnotationConfigApplicationContext Instantiating the Spring Container by Using AnnotationConfigApplicationContext

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

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

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

简单构造​

与在实例化 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();
}
java

如前所述，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();
}
java

前面的示例假设 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();
}
java

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

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

@Configuration
@ComponentScan(basePackages = "com.acme") 1
public class AppConfig  {
    // ...
}
java

  • 该注解启用了组件扫描。

提示

有经验的 Spring 用户可能熟悉 Spring 的 context: 命名空间中的 XML 声明等效项，如下例所示：

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

在前面的示例中，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);
}
java
备注

请记住，@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 context-param 和 init-param 的使用）：

<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>
xml
备注

对于编程使用场景，可以使用 GenericWebApplicationContext 作为 AnnotationConfigWebApplicationContext 的替代方案。详情请参阅 GenericWebApplicationContext 的 javadoc。