使用web.xml和SpringBoot打包可执行Jar运行时SpringMVC的加载流程

深藏阁楼爱情的钟 2023-09-25 21:23 14阅读 0赞

![format_png][]

> 本文使用的Spring版本为Spring6，SpringBoot版本为3，JDK为17，可能会和之前有细微不同，但整体流程差不太大。

### 部署到webapps目录启动 ###

> 如果部署应用到tomcat webapps目录下面启动，则需要在项目中配置web.xml文件

#### web.xml文件 ####

配置Spring应用上下文

<context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/application-context.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    复制代码

context-param

context-param标签是用于在Web应用程序的上下文范围内设置初始化参数。这些参数可以在整个Web应用程序中使用，并且可以通过ServletContext对象的getInitParameter()方法获取。

ContextLoaderListener

ContextLoaderListener实现了ServletContextListener接口，这个接口是tomcat留给应用程序初始化上下文环境的接口，用于在Web应用程序启动时加载ApplicationContext。

ServletContextListener有两个默认方法

// 在所有的servlet和filter初始化之前被调用
    default public void contextInitialized(ServletContextEvent sce) {
    }
    // 在所有的servlet和filter销毁之后被调用
    default public void contextDestroyed(ServletContextEvent sce) {
    }
    复制代码

ContextLoaderListener还继承了ContextLoader类，所有的context操作都在此类进行。

ContextLoaderListener实现contextInitialized方法，然后调用父类ContextLoader的initWebApplicationContext方法，把ServletContext传进去。

@Override
    public void contextInitialized(ServletContextEvent event) {
       initWebApplicationContext(event.getServletContext());
    }
    复制代码

初始化Spring Context。

initWebApplicationContext方法关键代码

...
    if (this.context == null) {
        // 创建ApplicationContext
        this.context = createWebApplicationContext(servletContext);
    }
    ...
    // 刷新ApplicationContext
    configureAndRefreshWebApplicationContext(cwac, servletContext);
    ...
    // 将当前ApplicationContext添加到ServletContext的属性中，后面有用再说
    // String ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE = WebApplicationContext.class.getName() + ".ROOT";
    servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
    ...
    复制代码

创建ApplicationContext

在createWebApplicationContext方法中，先调用determineContextClass方法确定使用哪个ApplicationContext，找到之后，实例化。

determineContextClass这个方法，主要是确定使用的ApplicationContext，首先从web.xml中加载，如果用户有定义，直接使用用户自定义的。

String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
    复制代码

web.xml中配置如下，

<context-param>
        <param-name>contextClass</param-name>
        <param-value>com.xxx.XxxContext</param-value>
    </context-param>
    复制代码

如果没有配置，则使用Spring默认的XmlWebApplicationContext类。

这个类在ContextLoader同路径包下面的ContextLoader.properties文件中定义。

org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext
    复制代码

配置和刷新ApplicationContext

configureAndRefreshWebApplicationContext关键代码

protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac,ServletContext sc) {
        // ...
        // 获取web.xml中配置的contextConfigLocation参数
        String configLocationParam = sc.getInitParameter(CONFIG_LOCATION_PARAM);
        if (configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }
        // ...
        // 刷新上下文
        wac.refresh();
    }
    复制代码

至此Tomcat已经启动Spring环境了，后续就是Spring的初始化流程，这里不再叙述。

初始化DispatcherServlet

<servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
           <param-name>contextConfigLocation</param-name>
           <param-value>/WEB-INF/spring/dispatcher-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    复制代码

此处的contextConfigLocation属于DispatcherServlet的父类FrameworkServlet，主要用来加载SpringMVC相关的配置，示例如下：

<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans 
            http://www.springframework.org/schema/beans/spring-beans-4.3.xsd
            http://www.springframework.org/schema/context 
            http://www.springframework.org/schema/context/spring-context-4.3.xsd
            http://www.springframework.org/schema/mvc 
            http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">
    
        
        <context:component-scan base-package="com.example.controller" />
    
        
        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/WEB-INF/views/" />
            <property name="suffix" value=".jsp" />
        </bean>
    
        
        <mvc:annotation-driven />
    
    </beans>
    复制代码

DispatcherServlet类图

![format_png 1][]

可以看到DispatcherServlet实现了Servlet接口，Servlet接口中有init方法，SpringMVC的配置就是在初始化的时候被加载的。

关键代码在HttpServletBean.init()和FrameworkServlet.initServletBean()方法中。

HttpServletBean.init()

public final void init() throws ServletException {
    
       // Set bean properties from init parameters.
       PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
       if (!pvs.isEmpty()) {
          try {
             BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
             ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
             bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
             initBeanWrapper(bw);
             bw.setPropertyValues(pvs, true);
          }
          catch (BeansException ex) {
             if (logger.isErrorEnabled()) {
                logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
             }
             throw ex;
          }
       }
    
       // Let subclasses do whatever initialization they like.
       initServletBean();
    }
    复制代码

[format_png]: https://img-blog.csdnimg.cn/img_convert/7166ae7eeddffa2dc5064e44909b1b0d.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/5cc77e0a29b66cb1c999e789f6443657.webp?x-oss-process=image/format,png