springboot 是如何幫咱們省去web.xml配置的

概述

最開始使用原生的springmvc時，老是免不了有以下xml配置

<!-- Spring MVC配置 -->
<!-- ====================================== -->
<servlet>
    <servlet-name>spring</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring-servlet.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>spring</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>
  

<!-- Spring配置 -->
<!-- ====================================== -->
<listener>
   <listenerclass>
 org.springframework.web.context.ContextLoaderListener
   </listener-class>
</listener>
  

<!-- 指定Spring Bean的配置文件所在目錄。默認配置在WEB-INF目錄下 -->
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:config/applicationContext.xml</param-value>
</context-param>

可是，切換到springboot以後，web.xml之類的繁瑣的配置基本上都不見了。出於好奇研究了下springboot究竟幫咱們作了什麼，咱們能夠免於這樣的繁瑣配置。

Servlet3.0規範

首先研究的第一點，爲何web.xml不見了。剛開始使用原生servlet（不使用web框架），web.xml就是很是重要的一個配置，不管是servlet、filter、listener都須要在web.xml裏面配置下。

可是在servlet3.0裏，這個配置獲得了簡化。能夠經過java配置（註解等）省去web.xml配置。

具體servlet3.0的規範這裏就不討論了，說下其中一個很是重要的類。javax.servlet.ServletContainerInitializer

這個類會在web容器啓動階段被回調，能夠在onStartup方法裏作一些servlet、filter、listener的註冊等操做。

/**
Interface which allows a library/runtime to be notified of a web application's startup phase and perform any required programmatic registration of servlets, filters, and listeners in response to it.
*/
public interface ServletContainerInitializer {

    public void onStartup(Set<Class<?>> c, ServletContext ctx)
        throws ServletException; 
}

springboot的實現

首先spring在META-INF/services下配置了這個類，讓整個web容器啓動後能夠找到並啓動這個類

ServletContainerInitializer配置

SpringServletContainerInitializer

/**
* @HandlesTypes這個註解標明瞭該ServletContainerInitializer須要在啓動時候處理哪些類，
而後服務器會把找到的這些類傳到onStartup的第一個參數裏

注意這裏的類包括所配置類的子類，好比這裏配置WebApplicationInitializer，
啓動以後，就會把這個WebApplicationInitializer的子類都傳進去
*/
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
        
    @Override
    public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
            throws ServletException {

        List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();

        //.... 省略容錯的一些代碼
        initializers.add((WebApplicationInitializer) waiClass.newInstance());
        //.... 
    AnnotationAwareOrderComparator.sort(initializers);
        for (WebApplicationInitializer initializer : initializers) {
            initializer.onStartup(servletContext);
        }
    }

}

startup的邏輯很簡單，web容器啓動後，調用全部WebApplicationInitializer的onStartup方法。

WebApplicationInitializer 的實現SpringBootServletInitializer

@Override
public void onStartup(ServletContext servletContext) throws ServletException {
   //....
    WebApplicationContext rootAppContext = createRootApplicationContext(
            servletContext);
   //...
}

protected WebApplicationContext createRootApplicationContext(
        ServletContext servletContext) {
    //...
    return run(application);
}

通常使用Springboot的時候，都會繼承一個類SpringBootServletInitializer，在這個類的onStartup方法中，啓動了整個Spring容器。

本地啓動springboot時，咱們通常會寫一個相似於這樣的main方法。

 

上述分析也解釋了爲啥把springboot應用部署到機器上，tomcat可以找到springboot的入口，並啓動它。

DispatcherServlet的配置

關於springboot如何加載類並啓動的這裏就不介紹了。
這裏說明下究竟Springboot如何配置DispatcherServlet的

 

1）當類路徑下存在DispatcherServlet時候，該配置生效。
2）這個配置會在DispatcherServletAutoConfiguration配置完以後再配置。

DispatcherServletAutoConfiguration配置

看到這裏就是咱們很是熟悉的springboot的使用了。springboot在DispatcherServletConfiguration這個類裏對DispatcherServlet進行了配置以及註冊。

總結

服務器如tomcat在web應用啓動後，加載並啓動springboot，springboot經過@AutoConfiguration、@Bean、@Conditional等註解自動配置了DispatcherServlet。

做者：端吉 連接：https://www.jianshu.com/p/3c94d7e76998 來源：簡書 簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。