Углубленный анализ Spring и контейнера Spring MVC

Java задняя часть Spring MVC

1 Весенняя веб-конфигурация MVC

Сама Spring Framework не имеет веб-возможностей,Spring MVC使用WebApplicationContext类扩展ApplicationContext, что делает его доступным для Интернета. Итак, как Spring MVC создает контейнер IoC в веб-среде? Какова структура контейнера IoC в веб-среде? Как запускается контейнер Spring IoC в веб-среде?

Взяв Tomcat в качестве примера, чтобы использовать Spirng MVC в веб-контейнере, необходимо выполнить четыре конфигурации:

  1. Измените web.xml и добавьте определение сервлета;
  2. Запишите конфигурацию servletname-servlet.xml (servletname — это значение servlet-name при настройке DispactherServlet в web.xm);
  3. параметры инициализации contextConfigLocation, настроить ContextLoaderListerner;

Web.xml настраивается следующим образом:

    <!-- servlet定义：前端处理器，接受的HTTP请求和转发请求的类 -->
    <servlet>
        <servlet-name>court</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <!-- court-servlet.xml：定义WebAppliactionContext上下文中的bean -->
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath*:court-servlet.xml</param-value>
        </init-param>
        <load-on-startup>0</load-on-startup>
    </servlet>
             
    <servlet-mapping>
        <servlet-name>court</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
 
    <!-- 配置contextConfigLocation初始化参数：指定Spring IoC容器需要读取的定义了非web层的Bean（DAO/Service）的XML文件路径 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/court-service.xml</param-value>
    </context-param>
 
    <!-- 配置ContextLoaderListerner：Spring MVC在Web容器中的启动类，负责Spring IoC容器在Web上下文中的初始化 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

В файле конфигурации web.xml есть две основные конфигурации:ContextLoaderListener和DispatcherServlet. Та же конфигурация, связанная с файлом конфигурации spring, также состоит из двух частей:context-param和DispatcherServlet中的init-param. Итак, в чем разница между конфигурацией этих двух частей? Какие у них обязанности?

В Spring MVC,Spring Context是以父子的继承结构存在的. В веб-среде существует корневой контекст, который является корневым контекстом всего приложения и родительским контекстом других контекстов. В то же время Spring MVC также содержит независимый контекст, который является подконтекстом контекста ROOT.

Как такая структура Context реализована в Spring MVC? Начнем с ROOT Context,ROOT Context是在ContextLoaderListener中配置的，ContextLoaderListener读取context-param中的contextConfigLocation指定的配置文件，创建ROOT Context.

Процесс запуска Spring MVC можно условно разделить на два процесса:

  1. ContextLoaderListener инициализирует, создает экземпляр контейнера IoC и регистрирует этот экземпляр контейнера в ServletContext;
  2. Инициализация DispatcherServlet;

2 Загрузка и инициализация корневого контекста Spring в веб-контейнере

Веб-контейнер вызывает метод contextInitialized для инициализации ContextLoaderListener.ContextLoaderListener通过调用继承自ContextLoader的initWebApplicationContext方法实例化Spring Ioc容器。

  1. Давайте сначала посмотрим, как WebApplicationContext расширяет ApplicationContext, добавляя поддержку веб-среды. Интерфейс WebApplicationContext определяется следующим образом:
    public interface WebApplicationContext extends ApplicationContext {
        //根上下文在ServletContext中的名称
        String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
        //取得web容器的ServletContext
        ServletContext getServletContext();
    }
  1. Давайте посмотрим на исходный код для создания контекста в ContextLoaderListener: ContextLoader.java
    public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
        //PS : ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE=WebApplicationContext.class.getName() + ".ROOT" 根上下文的名称
        //PS : 默认情况下，配置文件的位置和名称是： DEFAULT_CONFIG_LOCATION = "/WEB-INF/applicationContext.xml" 
        //在整个web应用中，只能有一个根上下文
        if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
            throw new IllegalStateException("Cannot initialize context because there is already a root application context present - " + "check whether you have multiple ContextLoader* definitions in your web.xml!");
        }

        Log logger = LogFactory.getLog(ContextLoader.class);
        servletContext.log("Initializing Spring root WebApplicationContext");
        if (logger.isInfoEnabled()) {
            logger.info("Root WebApplicationContext: initialization started");
        }
        long startTime = System.currentTimeMillis();

        try {
            // Store context in local instance variable, to guarantee that
            // it is available on ServletContext shutdown.
            if (this.context == null) {
                // 在这里执行了创建WebApplicationContext的操作
                this.context = createWebApplicationContext(servletContext);
            }
            if (this.context instanceof ConfigurableWebApplicationContext) {
                ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
                if (!cwac.isActive()) {
                    // The context has not yet been refreshed -> provide services such as
                    // setting the parent context, setting the application context id, etc
                    if (cwac.getParent() == null) {
                        // The context instance was injected without an explicit parent ->
                        // determine parent for root web application context, if any.
                        ApplicationContext parent = loadParentContext(servletContext);
                        cwac.setParent(parent);
                    }
                    configureAndRefreshWebApplicationContext(cwac, servletContext);
                }
            }
            // PS: 将根上下文放置在servletContext中
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

            ClassLoader ccl = Thread.currentThread().getContextClassLoader();
            if (ccl == ContextLoader.class.getClassLoader()) {
                currentContext = this.context;
            } else if (ccl != null) {
                currentContextPerThread.put(ccl, this.context);
            }

            if (logger.isDebugEnabled()) {
                logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
            }
            if (logger.isInfoEnabled()) {
                long elapsedTime = System.currentTimeMillis() - startTime;
                logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
            }

            return this.context;
        } catch (RuntimeException ex) {
            logger.error("Context initialization failed", ex);
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
            throw ex;
        } catch (Error err) {
            logger.error("Context initialization failed", err);
            servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
            throw err;
        }
    }
  1. Посмотрите, как создается объект WebApplicationContext: ContextLoader.java
    protected WebApplicationContext createWebApplicationContext(ServletContext sc, ApplicationContext parent) {
        //根据web.xml中的配置决定使用何种WebApplicationContext。默认情况下使用XmlWebApplicationContext
        //web.xml中相关的配置context-param的名称“contextClass”
        Class<?> contextClass = determineContextClass(sc);
        if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Custom context class [" + contextClass.getName() + "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
        }

        //实例化WebApplicationContext的实现类
        ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);

        // Assign the best possible id value.
        if (sc.getMajorVersion() == 2 && sc.getMinorVersion() < 5) {
	    // Servlet <= 2.4: resort to name specified in web.xml, if any.
            String servletContextName = sc.getServletContextName();
            if (servletContextName != null) {
                wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + servletContextName);
            } else {
		wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX);
            }
        } else {
            // Servlet 2.5's getContextPath available!
            wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + sc.getContextPath());
        }

        wac.setParent(parent);

        wac.setServletContext(sc);
        //设置spring的配置文件
        wac.setConfigLocation(sc.getInitParameter(CONFIG_LOCATION_PARAM));
        customizeContext(sc, wac);
        //spring容器初始化
        wac.refresh();
        return wac;
    }
  1. ContextLoaderListener строит диаграмму последовательности корневого контекста:

3 Контекстная загрузка и инициализация, соответствующие Spring MVC

Spring MVC中核心的类是DispatcherServlet, В этом классе завершена загрузка и создание контекста Spring, и запрос может быть распределен по каждому классу контроллера в соответствии с содержимым контекста Spring.DispatcherServlet继承自HttpServlet, загрузка конфигурационного файла и создание Spring Context находится вinit()方法中进行的，主要的调用顺序是init-->initServletBean-->initWebApplicationContext.

  1. Давайте посмотрим на реализацию initWebApplicationContext: FrameworkServlet.java
    protected WebApplicationContext initWebApplicationContext() {
        //先从web容器的ServletContext中查找WebApplicationContext
        WebApplicationContext wac = findWebApplicationContext();
        if (wac == null) {
            // No fixed context defined for this servlet - create a local one.
            //从ServletContext中取得根上下文
            WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(getServletContext());
            //创建Spring MVC的上下文，并将根上下文作为起双亲上下文
            wac = createWebApplicationContext(parent);
        }

        if (!this.refreshEventReceived) {
            // Apparently not a ConfigurableApplicationContext with refresh support:
            // triggering initial onRefresh manually here.
            onRefresh(wac);
        }

        if (this.publishContext) {
            // Publish the context as a servlet context attribute.
            // 取得context在ServletContext中的名称
            String attrName = getServletContextAttributeName();
            //将Spring MVC的Context放置到ServletContext中
            getServletContext().setAttribute(attrName, wac);
            if (this.logger.isDebugEnabled()) {
                this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() + "' as ServletContext attribute with name [" + attrName + "]");
            }
        }
            return wac;
    }

Через вызов метода initWebApplicationContext,创建了DispatcherServlet对应的context，并将其放置到ServletContext中, тем самым завершив процесс создания веб-контейнеровоза Spring IoC.

  1. DispatcherServlet создает диаграмму контекстной последовательности:

  1. Общий процесс инициализации DispatcherServlet:

  1. Диаграмма классов и отношения наследования контроллера DispatcherServlet:

4 Связь между DispacherServlet, WebApplicationContext и ServletContext в Spring

Чтобы понять взаимосвязь между этими тремя контекстами, вам нужно знать, как Spring запускается в веб-контейнере.Spring的启动过程其实就是其IOC容器的启动过程，对于web程序，IOC容器启动过程即是建立上下文的过程。

Процесс запуска Spring:

  1. Во-первых, для веб-приложения, развернутого в веб-контейнере,web容器提供其一个全局的上下文环境，这个上下文就是ServletContext, который обеспечивает хост-среду для последующего контейнера Spring IoC;

  2. Второй,在web.xml中会提供有contextLoaderListener. При старте веб-контейнера будет запущено событие инициализации контейнера, в это время contextLoaderListener прослушает это событие и будет вызван его метод contextInitialized.在这个方法中，spring会初始化一个启动上下文，这个上下文被称为根上下文，即WebApplicationContext，这是一个接口类，确切的说，其实际的实现类是XmlWebApplicationContext。Это контейнер IoC Spring, и конфигурация его соответствующего определения bean-компонента задается тегом context-param в файле web.xml. После инициализации контейнера IoC Spring начинается сWebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTEДля атрибута Key сохраните его в ServletContext для быстрого доступа;

  3. Еще раз, после инициализации прослушивателя contextLoaderListener, он начинает инициализировать сервлет, настроенный в web.xml.Этот сервлет может быть настроен с несколькими.В качестве примера возьмем наиболее распространенный DispatcherServlet, этот сервлет на самом деле является стандартным интерфейсным контроллером. для пересылки, сопоставления и обработки каждого запроса сервлета.DispatcherServlet上下文在初始化的时候会建立自己的IoC上下文，用以持有spring mvc相关的bean. При установке собственного контекста IoC DispatcherServlet будет использоватьWebApplicationContext.ROOTWEBAPPLICATIONCONTEXTATTRIBUTEСначала получите предыдущий корневой контекст (т.е. WebApplicationContext) из ServletContext в качестве родительского контекста своего собственного контекста. Получив этот родительский контекст, инициализируйте его. Работа этого DispatcherServlet по инициализации собственного контекста можно увидеть в его методе initStrategies.Общая работа заключается в инициализации отображения процессора, разрешения представления и т. д.这个servlet自己持有的上下文默认实现类也是XmlWebApplicationContext。初始化完毕后，spring以与servlet的名字相关(此处不是简单的以servlet名为Key，而是通过一些转换，具体可自行查看源码)的属性为属性Key，也将其存到ServletContext中，以便后续使用。这样每个servlet就持有自己的上下文，即拥有自己独立的bean空间，同时各个servlet共享相同的bean，即根上下文(第2步中初始化的上下文)定义的那些bean。

При настройке Spring в веб-контейнере (например, Tomcat) вы, возможно, уже привыкли к следующему коду конфигурации в файле web.xml:

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/applicationContext.xml</param-value>
    </context-param>
                                                                                                                                             
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>
                                                                                                                                             
    <servlet>
        <servlet-name>mvc-dispatcher</servlet-name>
        <servlet-class>
            org.springframework.web.servlet.DispatcherServlet
        </servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
                                                                                                                                         
    <servlet-mapping>
        <servlet-name>mvc-dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping></span>

Вышеупомянутая конфигурация首先会在ContextLoaderListener中通过<context-param>中的applicationContext.xml创建一个ApplicationContext, а затем подключите этот ApplicationContext к ServletContext и добейтесь этого с помощью метода setAttribute ServletContext.В исходном коде ContextLoaderListener мы можем увидеть этот код:

servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

ApplicationContext, созданный с помощью ContextLoaderListener выше, используется совместно со всем веб-приложением, и вы, возможно, уже знаете, чтоDispatcherServlet会维持一个自己的ApplicationContext，默认会读取/WEB-INFO/<dispatcherServletName>-servlet.xml文件, который также можно перенастроить:

    <servlet>  
        <servlet-name>  
           customConfiguredDispacherServlet  
        </servlet-name>  
        <servlet-class>  
            org.springframework.web.servlet.DispatcherServlet  
        </servlet-class>  
        <init-param>  
            <param-name>  
                contextConfigLocation  
            </param-name>  
            <param-value>  
                /WEB-INF/dispacherServletContext.xml  
            </param-value>  
        </init-param>  
        <load-on-startup>1</load-on-startup>  
    </servlet>

Вопрос в том, какова связь между двумя вышеупомянутыми ApplicationContexts, каковы их области действия и каково их использование?

ContextLoaderListener中创建ApplicationContext主要用于整个Web应用程序需要共享的一些组件, такие как DAO, ConnectionFactory базы данных и т. д. и由DispatcherServlet创建的ApplicationContext主要用于和该Servlet相关的一些组件, такие как Controller, ViewResovler и т. д.

Для масштаба,在DispatcherServlet中可以引用由ContextLoaderListener所创建的ApplicationContext, но не наоборот.

В конкретной реализации Spring два ApplicationContext помещаются в ServletContext через метод setAttribute ServletContext. но,ContextLoaderListener会先于DispatcherServlet创建ApplicationContext，DispatcherServlet在创建ApplicationContext时会先找到由ContextLoaderListener所创建的ApplicationContext，再将后者的ApplicationContext作为参数传给DispatcherServlet的ApplicationContext的setParent()方法, в исходном коде Spring вы можете найти следующий код в FrameServlet.java:

wac.setParent(parent);

в,wac即为由DisptcherServlet创建的ApplicationContext，而parent则为有ContextLoaderListener创建的ApplicationContext. После этого фреймворк вызовет метод setAttribute() ServletContext, чтобы добавить wac в ServletContext.

Когда Spring выполняет getBean ApplicationContext,如果在自己context中找不到对应的bean，则会在父ApplicationContext中去找. Это также объясняет, почему мы можем получить bean-компоненты в ApplicationContext, соответствующие ContextLoaderListener в DispatcherServlet.

Категории