Tomcat在SpringBoot中是如何啟動的

2019 年 10 月 8 日
筆記

轉載自：https://juejin.im/post/5d3f95ebf265da039e12959e

前言

我們知道SpringBoot給我們帶來了一個全新的開發體驗，我們可以直接把web程式達成jar包，直接啟動，這就得益於SpringBoot內置了容器，可以直接啟動，本文將以Tomcat為例，來看看SpringBoot是如何啟動Tomcat的，同時也將展開學習下Tomcat的源碼，了解Tomcat的設計。

從 Main 方法說起

用過SpringBoot的人都知道，首先要寫一個main方法來啟動

@SpringBootApplication  public class TomcatdebugApplication {        public static void main(String[] args) {          SpringApplication.run(TomcatdebugApplication.class, args);      }    }

我們直接點擊run方法的源碼，跟蹤下來，發下最終的run方法是調用ConfigurableApplicationContext方法，源碼如下：

public ConfigurableApplicationContext run(String... args) {  		StopWatch stopWatch = new StopWatch();  		stopWatch.start();  		ConfigurableApplicationContext context = null;  		Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();  		//設置系統屬性『java.awt.headless』，為true則啟用headless模式支援  		configureHeadlessProperty();  		//通過*SpringFactoriesLoader*檢索*META-INF/spring.factories*，         //找到聲明的所有SpringApplicationRunListener的實現類並將其實例化，         //之後逐個調用其started()方法，廣播SpringBoot要開始執行了  		SpringApplicationRunListeners listeners = getRunListeners(args);  		//發布應用開始啟動事件  		listeners.starting();  		try {  		//初始化參數  			ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);  			//創建並配置當前SpringBoot應用將要使用的Environment（包括配置要使用的PropertySource以及Profile）,          //並遍歷調用所有的SpringApplicationRunListener的environmentPrepared()方法，廣播Environment準備完畢。  			ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);  			configureIgnoreBeanInfo(environment);  			//列印banner  			Banner printedBanner = printBanner(environment);  			//創建應用上下文  			context = createApplicationContext();  			//通過*SpringFactoriesLoader*檢索*META-INF/spring.factories*，獲取並實例化異常分析器  			exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,  					new Class[] { ConfigurableApplicationContext.class }, context);  			//為ApplicationContext載入environment，之後逐個執行ApplicationContextInitializer的initialize()方法來進一步封裝ApplicationContext，          //並調用所有的SpringApplicationRunListener的contextPrepared()方法，【EventPublishingRunListener只提供了一個空的contextPrepared()方法】，          //之後初始化IoC容器，並調用SpringApplicationRunListener的contextLoaded()方法，廣播ApplicationContext的IoC載入完成，          //這裡就包括通過**@EnableAutoConfiguration**導入的各種自動配置類。  			prepareContext(context, environment, listeners, applicationArguments, printedBanner);  			//刷新上下文  			refreshContext(context);  			//再一次刷新上下文,其實是空方法，可能是為了後續擴展。  			afterRefresh(context, applicationArguments);  			stopWatch.stop();  			if (this.logStartupInfo) {  				new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);  			}  			//發布應用已經啟動的事件  			listeners.started(context);  			//遍歷所有註冊的ApplicationRunner和CommandLineRunner，並執行其run()方法。          //我們可以實現自己的ApplicationRunner或者CommandLineRunner，來對SpringBoot的啟動過程進行擴展。  			callRunners(context, applicationArguments);  		}  		catch (Throwable ex) {  			handleRunFailure(context, ex, exceptionReporters, listeners);  			throw new IllegalStateException(ex);  		}    		try {  		//應用已經啟動完成的監聽事件  			listeners.running(context);  		}  		catch (Throwable ex) {  			handleRunFailure(context, ex, exceptionReporters, null);  			throw new IllegalStateException(ex);  		}  		return context;  	}

其實這個方法我們可以簡單的總結下步驟為

配置屬性
獲取監聽器，發布應用開始啟動事件
初始化輸入參數
配置環境，輸出banner
創建上下文
預處理上下文
刷新上下文
再刷新上下文
發布應用已經啟動事件
發布應用啟動完成事件

其實上面這段程式碼，如果只要分析tomcat內容的話，只需要關注兩個內容即可，上下文是如何創建的，上下文是如何刷新的，分別對應的方法就是createApplicationContext() 和refreshContext(context)，接下來我們來看看這兩個方法做了什麼。

protected ConfigurableApplicationContext createApplicationContext() {  		Class<?> contextClass = this.applicationContextClass;  		if (contextClass == null) {  			try {  				switch (this.webApplicationType) {  				case SERVLET:  					contextClass = Class.forName(DEFAULT_SERVLET_WEB_CONTEXT_CLASS);  					break;  				case REACTIVE:  					contextClass = Class.forName(DEFAULT_REACTIVE_WEB_CONTEXT_CLASS);  					break;  				default:  					contextClass = Class.forName(DEFAULT_CONTEXT_CLASS);  				}  			}  			catch (ClassNotFoundException ex) {  				throw new IllegalStateException(  						"Unable create a default ApplicationContext, " + "please specify an ApplicationContextClass",  						ex);  			}  		}  		return (ConfigurableApplicationContext) BeanUtils.instantiateClass(contextClass);  	}

這裡就是根據我們的webApplicationType 來判斷創建哪種類型的Servlet,程式碼中分別對應著Web類型(SERVLET),響應式Web類型（REACTIVE),非Web類型（default),我們建立的是Web類型，所以肯定實例化 DEFAULT_SERVLET_WEB_CONTEXT_CLASS指定的類，也就是AnnotationConfigServletWebServerApplicationContext類，我們來用圖來說明下這個類的關係

img

通過這個類圖我們可以知道，這個類繼承的是ServletWebServerApplicationContext,這就是我們真正的主角，而這個類最終是繼承了AbstractApplicationContext，了解完創建上下文的情況後，我們再來看看刷新上下文，相關程式碼如下：

//類：SpringApplication.java    private void refreshContext(ConfigurableApplicationContext context) {      //直接調用刷新方法  		refresh(context);  		if (this.registerShutdownHook) {  			try {  				context.registerShutdownHook();  			}  			catch (AccessControlException ex) {  				// Not allowed in some environments.  			}  		}  	}  //類：SpringApplication.java    protected void refresh(ApplicationContext applicationContext) {  		Assert.isInstanceOf(AbstractApplicationContext.class, applicationContext);  		((AbstractApplicationContext) applicationContext).refresh();  	}

這裡還是直接傳遞調用本類的refresh(context)方法，最後是強轉成父類AbstractApplicationContext調用其refresh()方法,該程式碼如下：

// 類：AbstractApplicationContext  public void refresh() throws BeansException, IllegalStateException {  		synchronized (this.startupShutdownMonitor) {  			// Prepare this context for refreshing.  			prepareRefresh();    			// Tell the subclass to refresh the internal bean factory.  			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();    			// Prepare the bean factory for use in this context.  			prepareBeanFactory(beanFactory);    			try {  				// Allows post-processing of the bean factory in context subclasses.  				postProcessBeanFactory(beanFactory);    				// Invoke factory processors registered as beans in the context.  				invokeBeanFactoryPostProcessors(beanFactory);    				// Register bean processors that intercept bean creation.  				registerBeanPostProcessors(beanFactory);    				// Initialize message source for this context.  				initMessageSource();    				// Initialize event multicaster for this context.  				initApplicationEventMulticaster();    				// Initialize other special beans in specific context subclasses.這裡的意思就是調用各個子類的onRefresh()  				onRefresh();    				// Check for listener beans and register them.  				registerListeners();    				// Instantiate all remaining (non-lazy-init) singletons.  				finishBeanFactoryInitialization(beanFactory);    				// Last step: publish corresponding event.  				finishRefresh();  			}    			catch (BeansException ex) {  				if (logger.isWarnEnabled()) {  					logger.warn("Exception encountered during context initialization - " +  							"cancelling refresh attempt: " + ex);  				}    				// Destroy already created singletons to avoid dangling resources.  				destroyBeans();    				// Reset 'active' flag.  				cancelRefresh(ex);    				// Propagate exception to caller.  				throw ex;  			}    			finally {  				// Reset common introspection caches in Spring's core, since we  				// might not ever need metadata for singleton beans anymore...  				resetCommonCaches();  			}  		}  	}

這裡我們看到onRefresh()方法是調用其子類的實現，根據我們上文的分析，我們這裡的子類是ServletWebServerApplicationContext。

//類：ServletWebServerApplicationContext  protected void onRefresh() {  		super.onRefresh();  		try {  			createWebServer();  		}  		catch (Throwable ex) {  			throw new ApplicationContextException("Unable to start web server", ex);  		}  	}    private void createWebServer() {  		WebServer webServer = this.webServer;  		ServletContext servletContext = getServletContext();  		if (webServer == null && servletContext == null) {  			ServletWebServerFactory factory = getWebServerFactory();  			this.webServer = factory.getWebServer(getSelfInitializer());  		}  		else if (servletContext != null) {  			try {  				getSelfInitializer().onStartup(servletContext);  			}  			catch (ServletException ex) {  				throw new ApplicationContextException("Cannot initialize servlet context", ex);  			}  		}  		initPropertySources();  	}

到這裡，其實廬山真面目已經出來了，createWebServer()就是啟動web服務，但是還沒有真正啟動Tomcat，既然webServer是通過ServletWebServerFactory來獲取的，我們就來看看這個工廠的真面目。

img

走進Tomcat內部

根據上圖我們發現，工廠類是一個介面，各個具體服務的實現是由各個子類來實現的，所以我們就去看看TomcatServletWebServerFactory.getWebServer()的實現。

	@Override  	public WebServer getWebServer(ServletContextInitializer... initializers) {  		Tomcat tomcat = new Tomcat();  		File baseDir = (this.baseDirectory != null) ? this.baseDirectory : createTempDir("tomcat");  		tomcat.setBaseDir(baseDir.getAbsolutePath());  		Connector connector = new Connector(this.protocol);  		tomcat.getService().addConnector(connector);  		customizeConnector(connector);  		tomcat.setConnector(connector);  		tomcat.getHost().setAutoDeploy(false);  		configureEngine(tomcat.getEngine());  		for (Connector additionalConnector : this.additionalTomcatConnectors) {  			tomcat.getService().addConnector(additionalConnector);  		}  		prepareContext(tomcat.getHost(), initializers);  		return getTomcatWebServer(tomcat);  	}

根據上面的程式碼，我們發現其主要做了兩件事情，第一件事就是把Connnctor(我們稱之為連接器)對象添加到Tomcat中，第二件事就是configureEngine,這連接器我們勉強能理解（不理解後面會述說），那這個Engine是什麼呢？我們查看tomcat.getEngine()的源碼：

    public Engine getEngine() {          Service service = getServer().findServices()[0];          if (service.getContainer() != null) {              return service.getContainer();          }          Engine engine = new StandardEngine();          engine.setName( "Tomcat" );          engine.setDefaultHost(hostname);          engine.setRealm(createDefaultRealm());          service.setContainer(engine);          return engine;      }

根據上面的源碼，我們發現，原來這個Engine是容器，我們繼續跟蹤源碼，找到Container介面

img

上圖中，我們看到了4個子介面，分別是Engine,Host,Context,Wrapper。我們從繼承關係上可以知道他們都是容器，那麼他們到底有啥區別呢？我看看他們的注釋是怎麼說的。

 /**   If used, an Engine is always the top level Container in a Catalina   * hierarchy. Therefore, the implementation's <code>setParent()</code> method   * should throw <code>IllegalArgumentException</code>.   *   * @author Craig R. McClanahan   */  public interface Engine extends Container {      //省略程式碼  }  /**   * <p>   * The parent Container attached to a Host is generally an Engine, but may   * be some other implementation, or may be omitted if it is not necessary.   * <p>   * The child containers attached to a Host are generally implementations   * of Context (representing an individual servlet context).   *   * @author Craig R. McClanahan   */  public interface Host extends Container {  //省略程式碼    }  /*** <p>   * The parent Container attached to a Context is generally a Host, but may   * be some other implementation, or may be omitted if it is not necessary.   * <p>   * The child containers attached to a Context are generally implementations   * of Wrapper (representing individual servlet definitions).   * <p>   *   * @author Craig R. McClanahan   */  public interface Context extends Container, ContextBind {      //省略程式碼  }  /**<p>   * The parent Container attached to a Wrapper will generally be an   * implementation of Context, representing the servlet context (and   * therefore the web application) within which this servlet executes.   * <p>   * Child Containers are not allowed on Wrapper implementations, so the   * <code>addChild()</code> method should throw an   * <code>IllegalArgumentException</code>.   *   * @author Craig R. McClanahan   */  public interface Wrapper extends Container {        //省略程式碼  }

上面的注釋翻譯過來就是，Engine是最高級別的容器，其子容器是Host,Host的子容器是Context,Wrapper是Context的子容器，所以這4個容器的關係就是父子關係，也就是Engine>Host>Context>Wrapper。我們再看看Tomcat類的源碼:

//部分源碼，其餘部分省略。  public class Tomcat {  //設置連接器       public void setConnector(Connector connector) {          Service service = getService();          boolean found = false;          for (Connector serviceConnector : service.findConnectors()) {              if (connector == serviceConnector) {                  found = true;              }          }          if (!found) {              service.addConnector(connector);          }      }      //獲取service         public Service getService() {          return getServer().findServices()[0];      }      //設置Host容器       public void setHost(Host host) {          Engine engine = getEngine();          boolean found = false;          for (Container engineHost : engine.findChildren()) {              if (engineHost == host) {                  found = true;              }          }          if (!found) {              engine.addChild(host);          }      }      //獲取Engine容器       public Engine getEngine() {          Service service = getServer().findServices()[0];          if (service.getContainer() != null) {              return service.getContainer();          }          Engine engine = new StandardEngine();          engine.setName( "Tomcat" );          engine.setDefaultHost(hostname);          engine.setRealm(createDefaultRealm());          service.setContainer(engine);          return engine;      }      //獲取server         public Server getServer() {            if (server != null) {              return server;          }            System.setProperty("catalina.useNaming", "false");            server = new StandardServer();            initBaseDir();            // Set configuration source          ConfigFileLoader.setSource(new CatalinaBaseConfigurationSource(new File(basedir), null));            server.setPort( -1 );            Service service = new StandardService();          service.setName("Tomcat");          server.addService(service);          return server;      }        //添加Context容器        public Context addContext(Host host, String contextPath, String contextName,              String dir) {          silence(host, contextName);          Context ctx = createContext(host, contextPath);          ctx.setName(contextName);          ctx.setPath(contextPath);          ctx.setDocBase(dir);          ctx.addLifecycleListener(new FixContextListener());            if (host == null) {              getHost().addChild(ctx);          } else {              host.addChild(ctx);          }        //添加Wrapper容器           public static Wrapper addServlet(Context ctx,                                        String servletName,                                        Servlet servlet) {          // will do class for name and set init params          Wrapper sw = new ExistingStandardWrapper(servlet);          sw.setName(servletName);          ctx.addChild(sw);            return sw;      }    }

閱讀Tomcat的getServer()我們可以知道，Tomcat的最頂層是Server,Server就是Tomcat的實例，一個Tomcat一個Server;通過getEngine()我們可以了解到Server下面是Service，而且是多個，一個Service代表我們部署的一個應用，而且我們還可以知道，Engine容器，一個service只有一個；根據父子關係，我們看setHost()源碼可以知道，host容器有多個；同理，我們發現addContext()源碼下，Context也是多個；addServlet()表明Wrapper容器也是多個，而且這段程式碼也暗示了，其實Wrapper和Servlet是一層意思。另外我們根據setConnector源碼可以知道，連接器(Connector)是設置在service下的，而且是可以設置多個連接器(Connector)。

根據上面分析，我們可以小結下： Tomcat主要包含了2個核心組件，連接器(Connector)和容器(Container),用圖表示如下：

img

一個Tomcat是一個Server,一個Server下有多個service，也就是我們部署的多個應用，一個應用下有多個連接器(Connector)和一個容器（Container）,容器下有多個子容器，關係用圖表示如下：

img

Engine下有多個Host子容器，Host下有多個Context子容器，Context下有多個Wrapper子容器。

總結

SpringBoot的啟動是通過new SpringApplication()實例來啟動的，啟動過程主要做如下幾件事情：

配置屬性
獲取監聽器，發布應用開始啟動事件
初始化輸入參數
配置環境，輸出banner
創建上下文
預處理上下文
刷新上下文
再刷新上下文
發布應用已經啟動事件
發布應用啟動完成事件

而啟動Tomcat就是在第7步中「刷新上下文」；Tomcat的啟動主要是初始化2個核心組件，連接器(Connector)和容器（Container），一個Tomcat實例就是一個Server，一個Server包含多個Service，也就是多個應用程式，每個Service包含多個連接器（Connetor）和一個容器（Container),而容器下又有多個子容器，按照父子關係分別為：Engine,Host,Context,Wrapper，其中除了Engine外，其餘的容器都是可以有多個。