Как Tomcat запускается в SpringBoot

Java Tomcat

image

предисловие

Мы знаем, что SpringBoot принес нам новый опыт разработки. Мы можем напрямую конвертировать веб-программу в пакет jar и запускать ее напрямую. Это связано со встроенным контейнером SpringBoot, который можно запустить напрямую. Эта статья займет Tomcat в качестве примера, чтобы увидеть, как SpringBoot запускает Tomcat, а также начнет изучать исходный код Tomcat и понимать дизайн Tomcat.

Начните с основного метода

Любой, кто использовал SpringBoot, знает, что первое, что нужно сделать, это написать основной метод для запуска.

@SpringBootApplication
public class TomcatdebugApplication {

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

}

Мы напрямую нажимаем на исходный код метода запуска, отслеживаем его и выдаем окончательный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;
	}

Фактически, этот метод можно кратко обобщить в виде следующих шагов:

  1. свойства конфигурации
  2. Получите прослушиватель и опубликуйте событие запуска приложения
  3. Инициализировать входные параметры
  4. Настройте окружение и выведите баннер
  5. создать контекст
  6. контекст предварительной обработки
  7. обновить контекст
  8. обновить контекст
  9. Приложение публикации запустило событие
  10. Опубликовать событие завершения запуска приложения

Фактически, в приведенном выше коде, если вам нужно только проанализировать содержимое 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), отзывчивому веб-типу (РЕАКТИВНЫЙ) и не-веб-типу (по умолчанию).Мы создаем веб-тип, поэтому он должен быть создан. .DEFAULT_SERVLET_WEB_CONTEXT_CLASSуказанный класс, т.AnnotationConfigServletWebServerApplicationContextкласса, воспользуемся диаграммой, чтобы проиллюстрировать взаимосвязь этого класса

Из этой диаграммы классов мы можем знать, что этот класс наследует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()Является запуском веб-службы, но Tomcat на самом деле не запустился, так какwebServerчерезServletWebServerFactoryПриходите, давайте взглянем на истинное лицо этой фабрики.

Внутри Томкэт

По приведенному выше рисунку мы обнаружили, что фабричный класс — это интерфейс, а реализация каждого конкретного сервиса реализуется каждым подклассом, так что давайте посмотрим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;
    }

По приведенному выше исходнику мы выяснили, что движок является контейнером, продолжаем отслеживать исходник и находимContainerинтерфейс

На рисунке выше мы видим четыре подинтерфейса, а именно 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, поэтому отношения между этими четырьмя контейнерами являются отношениями родитель-потомок, то есть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, СерверTomcatэкземпляр, аTomcatОдинServer;пройти черезgetEngine()Мы можем знать, что на сервере есть службы, и их несколько.Служба представляет собой приложение, которое мы развертываем, и мы также можем знать, чтоEngineконтейнер, аserviceЕсть только один, по отношениям отца и сына мы видимsetHost()Исходный код может знать,hostИмеется несколько контейнеров; по той же причине мы находимaddContext()Согласно исходному коду,Contextтакже несколько;addServlet()показыватьWrapperТакже имеется несколько контейнеров, и этот код также подразумевает, что на самом делеWrapperиServletпредставляет собой смысловой слой. Кроме того, мыsetConnectorИсходник можно узнать, коннектор (Connector) устанавливается вservice, и можно установить несколько коннекторов (Connector).

На основании вышеприведенного анализа мы можем сделать вывод, что: Tomcat в основном включает два основных компонента, Connector и Container, которые представлены следующим образом:

ОдинTomcatЯвляетсяServer,ОдинServerесть несколькоservice, то есть мы разворачиваем несколько приложений, и под одним приложением несколько коннекторов (Connector) и контейнер (Container), в контейнере есть несколько подконтейнеров, и отношение представлено следующим образом:

Engineесть несколькоHostподконтейнер,Hostесть несколькоContextподконтейнер,Contextесть несколькоWrapperподконтейнер.

Суммировать

SpringBoot запускаетсяnew SpringApplication()Экземпляр запускается, и процесс запуска в основном выполняет следующие действия:

  1. свойства конфигурации
  2. Получите прослушиватель и опубликуйте событие запуска приложения
  3. Инициализировать входные параметры
  4. Настройте окружение и выведите баннер
  5. создать контекст
  6. контекст предварительной обработки
  7. обновить контекст
  8. обновить контекст
  9. Приложение публикации запустило событие
  10. Опубликовать событие завершения запуска приложения

И запуск Tomcat — это «обновление контекста» на шаге 7; запуск Tomcat — это в основном инициализация двух основных компонентов, соединителя и контейнера. Экземпляр Tomcat — это сервер, а сервер содержит несколько служб. То есть несколько приложений, каждая служба содержит несколько коннекторов (коннетор) и контейнер (контейнер), а также несколько подконтейнеров под контейнером.В соответствии с отношениями родитель-потомок это: Engine, Host, Context, Wrapper, кроме Engine. , остальные контейнеры могут иметь несколько.

Перспективы на следующий период

В этом выпуске подглядываем за внутренней структурой Tomcat через автозапуск SpringBoot В следующем выпуске разберем коннекторы в этой статье (Connetor) и роль контейнера (Container), так что следите за обновлениями.

Заявление об авторских правах: Оригинальная статья, пожалуйста, укажите источник для перепечатки.

Категории