Spring IoC контейнер: Java конфигурация, создание контейнера Spring с помощью AnnotationConfigApplicationContext

В этом посте описывается Spring AnnotationConfigApplicationContext, представленный в Spring 3.0. Эта универсальная реализация ApplicationContext способна принимать в качестве входных данных не только классы @Configuration, но и простые классы @Component и классы, аннотированные метаданными JSR-330.

Когда классы @Configuration предоставляются в качестве входных данных, сам класс @Configuration регистрируется как определение компонента, и все объявленные методы @Bean в классе также регистрируются как определения компонента.

Когда предоставляются классы @Component и JSR-330, они регистрируются как определения bean-компонентов, и предполагается, что метаданные внедрения зависимостей, такие как @Autowired или @Inject, используются в этих классах, где это необходимо.

Простая конструкция

Аналогично тому, как XML-файлы Spring используются в качестве входных данных при создании экземпляра ClassPathXmlApplicationContext, вы можете использовать классы @Configuration в качестве входных данных при создании экземпляра AnnotationConfigApplicationContext. Это позволяет полностью использовать XML-контейнер Spring, как показано в следующем примере:

Java

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

Kotlin

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

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

Kotlin

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

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();
}

Kotlin

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

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

Kotlin

@Configuration
@ComponentScan(basePackages = ["com.acme"]) 
class AppConfig  {
    // ...
}

Опытные пользователи Spring могут быть знакомы с объявлением XML, эквивалентным из пространства имен Spring context:, показанного в следующем примере:

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

В предыдущем примере пакет com.acme сканируется на наличие каких-либо аннотированных классов @Component, и эти классы регистрируются как определения bean-компонентов Spring в контейнере. AnnotationConfigApplicationContext предоставляет метод scan(String…​) для обеспечения тех же функций сканирования компонентов, как показано в следующем примере:

Java

public static void main(String[] args) {
    AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
    ctx.scan("com.acme");
    ctx.refresh();
    MyService myService = ctx.getBean(MyService.class);
}

Kotlin

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

Вариант AnnotationConfigApplicationContext WebApplicationContext доступен с помощью AnnotationConfigWebApplicationContext. Эту реализацию можно использовать при настройке прослушивателя сервлета Spring ContextLoaderListener, Spring MVC DispatcherServlet и т. д. Следующий фрагмент web.xml настраивает типичное веб-приложение Spring MVC (обратите внимание на использование 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/* на сервлет диспетчера -->
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/app/*</url-pattern>
    </servlet-mapping>
</web-app>

---

Читайте также:

• Spring IoC контейнер: Java конфигурация, @Bean и @Configuration
• Spring IoC контейнер: аннотации JSR 330, @Named и @ManagedBean - стандартные эквиваленты аннотации @Component
• Spring IoC контейнер: ограничения стандартных аннотаций JSR 330