Tomcat在SpringBoot中是如何啟動(dòng)的
前言
我們知道SpringBoot給我們帶來(lái)了一個(gè)全新的開(kāi)發(fā)體驗(yàn)，我們可以直接把web程序達(dá)成jar包，直接啟動(dòng)，這就得益于SpringBoot內(nèi)置了容器，可以直接啟動(dòng)，本文將以Tomcat為例，來(lái)看看SpringBoot是如何啟動(dòng)Tomcat的，同時(shí)也將展開(kāi)學(xué)習(xí)下Tomcat的源碼，了解Tomcat的設(shè)計(jì)。
從 Main 方法說(shuō)起
用過(guò)SpringBoot的人都知道，首先要寫一個(gè)main方法來(lái)啟動(dòng)
- @SpringBootApplication
- public class TomcatdebugApplication {
- public static void main(String[] args) {
- SpringApplication.run(TomcatdebugApplication.class, args);
- }
- }
我們直接點(diǎn)擊run方法的源碼，跟蹤下來(lái)，發(fā)下最終 的run方法是調(diào)用ConfigurableApplicationContext方法，源碼如下：
- public ConfigurableApplicationContext run(String... args) {
- StopWatch stopWatch = new StopWatch();
- stopWatch.start();
- ConfigurableApplicationContext context = null;
- Collection<springbootexceptionreporter> exceptionReporters = new ArrayList<>();
- //設(shè)置系統(tǒng)屬性『java.awt.headless』，為true則啟用headless模式支持
- configureHeadlessProperty();
- //通過(guò)*SpringFactoriesLoader*檢索*META-INF/spring.factories*，
- //找到聲明的所有SpringApplicationRunListener的實(shí)現(xiàn)類并將其實(shí)例化，
- //之后逐個(gè)調(diào)用其started()方法，廣播SpringBoot要開(kāi)始執(zhí)行了
- SpringApplicationRunListeners listeners = getRunListeners(args);
- //發(fā)布應(yīng)用開(kāi)始啟動(dòng)事件
- listeners.starting();
- try {
- //初始化參數(shù)
- ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
- //創(chuàng)建并配置當(dāng)前SpringBoot應(yīng)用將要使用的Environment（包括配置要使用的PropertySource以及Profile）,
- //并遍歷調(diào)用所有的SpringApplicationRunListener的environmentPrepared()方法，廣播Environment準(zhǔn)備完畢。
- ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
- configureIgnoreBeanInfo(environment);
- //打印banner
- Banner printedBanner = printBanner(environment);
- //創(chuàng)建應(yīng)用上下文
- context = createApplicationContext();
- //通過(guò)*SpringFactoriesLoader*檢索*META-INF/spring.factories*，獲取并實(shí)例化異常分析器
- exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,
- new Class[] { ConfigurableApplicationContext.class }, context);
- //為ApplicationContext加載environment，之后逐個(gè)執(zhí)行ApplicationContextInitializer的initialize()方法來(lái)進(jìn)一步封裝ApplicationContext，
- //并調(diào)用所有的SpringApplicationRunListener的contextPrepared()方法，【EventPublishingRunListener只提供了一個(gè)空的contextPrepared()方法】，
- //之后初始化IoC容器，并調(diào)用SpringApplicationRunListener的contextLoaded()方法，廣播ApplicationContext的IoC加載完成，
- //這里就包括通過(guò)**@EnableAutoConfiguration**導(dǎo)入的各種自動(dòng)配置類。
- prepareContext(context, environment, listeners, applicationArguments, printedBanner);
- //刷新上下文
- refreshContext(context);
- //再一次刷新上下文,其實(shí)是空方法，可能是為了后續(xù)擴(kuò)展。
- afterRefresh(context, applicationArguments);
- stopWatch.stop();
- if (this.logStartupInfo) {
- new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
- }
- //發(fā)布應(yīng)用已經(jīng)啟動(dòng)的事件
- listeners.started(context);
- //遍歷所有注冊(cè)的ApplicationRunner和CommandLineRunner，并執(zhí)行其run()方法。
- //我們可以實(shí)現(xiàn)自己的ApplicationRunner或者CommandLineRunner，來(lái)對(duì)SpringBoot的啟動(dòng)過(guò)程進(jìn)行擴(kuò)展。
- callRunners(context, applicationArguments);
- }
- catch (Throwable ex) {
- handleRunFailure(context, ex, exceptionReporters, listeners);
- throw new IllegalStateException(ex);
- }
- try {
- //應(yīng)用已經(jīng)啟動(dòng)完成的監(jiān)聽(tīng)事件
- listeners.running(context);
- }
- catch (Throwable ex) {
- handleRunFailure(context, ex, exceptionReporters, null);
- throw new IllegalStateException(ex);
- }
- return context;
- }
其實(shí)這個(gè)方法我們可以簡(jiǎn)單的總結(jié)下步驟為 > 1. 配置屬性 > 2. 獲取監(jiān)聽(tīng)器，發(fā)布應(yīng)用開(kāi)始啟動(dòng)事件 > 3. 初始化輸入?yún)?shù) > 4. 配置環(huán)境，輸出banner > 5. 創(chuàng)建上下文 > 6. 預(yù)處理上下文 > 7. 刷新上下文 > 8. 再刷新上下文 > 9. 發(fā)布應(yīng)用已經(jīng)啟動(dòng)事件 > 10. 發(fā)布應(yīng)用啟動(dòng)完成事件
其實(shí)上面這段代碼，如果只要分析tomcat內(nèi)容的話，只需要關(guān)注兩個(gè)內(nèi)容即可，上下文是如何創(chuàng)建的，上下文是如何刷新的，分別對(duì)應(yīng)的方法就是createApplicationContext() 和refreshContext(context)，接下來(lái)我們來(lái)看看這兩個(gè)方法做了什么。
- 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);
- }
這里就是根據(jù)我們的webApplicationType 來(lái)判斷創(chuàng)建哪種類型的Servlet,代碼中分別對(duì)應(yīng)著Web類型(SERVLET),響應(yīng)式Web類型（REACTIVE),非Web類型（default),我們建立的是Web類型，所以肯定實(shí)例化 DEFAULT_SERVLET_WEB_CONTEXT_CLASS指定的類，也就是AnnotationConfigServletWebServerApplicationContext類，我們來(lái)用圖來(lái)說(shuō)明下這個(gè)類的關(guān)系
通過(guò)這個(gè)類圖我們可以知道，這個(gè)類繼承的是ServletWebServerApplicationContext,這就是我們真正的主角，而這個(gè)類最終是繼承了AbstractApplicationContext，了解完創(chuàng)建上下文的情況后，我們?cè)賮?lái)看看刷新上下文，相關(guān)代碼如下：
- //類：SpringApplication.java
- private void refreshContext(ConfigurableApplicationContext context) {
- //直接調(diào)用刷新方法
- 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();
- }
這里還是直接傳遞調(diào)用本類的refresh(context)方法，最后是強(qiáng)轉(zhuǎn)成父類AbstractApplicationContext調(diào)用其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.這里的意思就是調(diào)用各個(gè)子類的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()方法是調(diào)用其子類的實(shí)現(xiàn)，根據(jù)我們上文的分析，我們這里的子類是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();
- }
到這里，其實(shí)廬山真面目已經(jīng)出來(lái)了，createWebServer()就是啟動(dòng)web服務(wù)，但是還沒(méi)有真正啟動(dòng)Tomcat，既然webServer是通過(guò)ServletWebServerFactory來(lái)獲取的，我們就來(lái)看看這個(gè)工廠的真面目。
走進(jìn)Tomcat內(nèi)部
根據(jù)上圖我們發(fā)現(xiàn)，工廠類是一個(gè)接口，各個(gè)具體服務(wù)的實(shí)現(xiàn)是由各個(gè)子類來(lái)實(shí)現(xiàn)的，所以我們就去看看TomcatServletWebServerFactory.getWebServer()的實(shí)現(xiàn)。
- @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);
- }
根據(jù)上面的代碼，我們發(fā)現(xiàn)其主要做了兩件事情，第一件事就是把Connnctor(我們稱之為連接器)對(duì)象添加到Tomcat中，第二件事就是configureEngine,這連接器我們勉強(qiáng)能理解（不理解后面會(huì)述說(shuō)），那這個(gè)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;
- }
根據(jù)上面的源碼，我們發(fā)現(xiàn)，原來(lái)這個(gè)Engine是容器，我們繼續(xù)跟蹤源碼，找到Container接口
上圖中，我們看到了4個(gè)子接口，分別是Engine,Host,Context,Wrapper。我們從繼承關(guān)系上可以知道他們都是容器，那么他們到底有啥區(qū)別呢？我看看他們的注釋是怎么說(shuō)的。
- /**
- 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><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><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><p>
- * The child containers attached to a Context are generally implementations
- * of Wrapper (representing individual servlet definitions).
- * </p><p>
- *
- * @author Craig R. McClanahan
- */
- public interface Context extends Container, ContextBind {
- //省略代碼
- }
- /**</p><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><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 {
- //省略代碼
- }
上面的注釋翻譯過(guò)來(lái)就是，Engine是最高級(jí)別的容器，其子容器是Host,Host的子容器是Context,Wrapper是Context的子容器，所以這4個(gè)容器的關(guān)系就是父子關(guān)系，也就是Engine>Host>Context>Wrapper。 我們?cè)倏纯碩omcat類的源碼:
- //部分源碼，其余部分省略。
- public class Tomcat {
- //設(shè)置連接器
- 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];
- }
- //設(shè)置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的實(shí)例，一個(gè)Tomcat一個(gè)Server;通過(guò)getEngine()我們可以了解到Server下面是Service，而且是多個(gè)，一個(gè)Service代表我們部署的一個(gè)應(yīng)用，而且我們還可以知道，Engine容器，一個(gè)service只有一個(gè)；根據(jù)父子關(guān)系，我們看setHost()源碼可以知道，host容器有多個(gè)；同理，我們發(fā)現(xiàn)addContext()源碼下，Context也是多個(gè)；addServlet()表明Wrapper容器也是多個(gè)，而且這段代碼也暗示了，其實(shí)Wrapper和Servlet是一層意思。另外我們根據(jù)setConnector源碼可以知道，連接器(Connector)是設(shè)置在service下的，而且是可以設(shè)置多個(gè)連接器(Connector)。
根據(jù)上面分析，我們可以小結(jié)下： Tomcat主要包含了2個(gè)核心組件，連接器(Connector)和容器(Container),用圖表示如下：
一個(gè)Tomcat是一個(gè)Server,一個(gè)Server下有多個(gè)service，也就是我們部署的多個(gè)應(yīng)用，一個(gè)應(yīng)用下有多個(gè)連接器(Connector)和一個(gè)容器（Container）,容器下有多個(gè)子容器，關(guān)系用圖表示如下：
Engine下有多個(gè)Host子容器，Host下有多個(gè)Context子容器，Context下有多個(gè)Wrapper子容器。
總結(jié)
SpringBoot的啟動(dòng)是通過(guò)new SpringApplication()實(shí)例來(lái)啟動(dòng)的，啟動(dòng)過(guò)程主要做如下幾件事情： > 1. 配置屬性 > 2. 獲取監(jiān)聽(tīng)器，發(fā)布應(yīng)用開(kāi)始啟動(dòng)事件 > 3. 初始化輸入?yún)?shù) > 4. 配置環(huán)境，輸出banner > 5. 創(chuàng)建上下文 > 6. 預(yù)處理上下文 > 7. 刷新上下文 > 8. 再刷新上下文 > 9. 發(fā)布應(yīng)用已經(jīng)啟動(dòng)事件 > 10. 發(fā)布應(yīng)用啟動(dòng)完成事件
而啟動(dòng)Tomcat就是在第7步中“刷新上下文”；Tomcat的啟動(dòng)主要是初始化2個(gè)核心組件，連接器(Connector)和容器（Container），一個(gè)Tomcat實(shí)例就是一個(gè)Server，一個(gè)Server包含多個(gè)Service，也就是多個(gè)應(yīng)用程序，每個(gè)Service包含多個(gè)連接器（Connetor）和一個(gè)容器（Container),而容器下又有多個(gè)子容器，按照父子關(guān)系分別為：Engine,Host,Context,Wrapper，其中除了Engine外，其余的容器都是可以有多個(gè)。
下期展望
本期文章通過(guò)SpringBoot的啟動(dòng)來(lái)窺探了Tomcat的內(nèi)部結(jié)構(gòu)，下一期，我們來(lái)分析下本次文章中的連接器(Connetor)和容器(Container)的作用，敬請(qǐng)期待。
