Некоторые важные контексты в Spring были представлены ранее в статье. В этой статье упоминаются некоторые контексты, см. предыдущую статью.
Большая часть причины, по которой проект SpringBoot легко развернуть, заключается в том, что вам не нужно самостоятельно выбрасывать конфигурацию, связанную с Tomcat, поскольку он имеет различные встроенные контейнеры сервлетов. Всегда любопытно:Как SpringBoot может запустить контейнер и развернуться в нем, просто запустив основную функцию. В этой статье мы хотим прояснить этот вопрос.
Мы анализируем из записи запуска SpringBoot:
Создание контекста
1// Create, load, refresh and run the ApplicationContext
2context = createApplicationContext();
В методе run SpringBoot мы обнаружили, что одним из наиболее важных шагов является приведенная выше строка кода. Комментарии тоже четко написаны:
Создайте, загрузите, обновите, запустите ApplicationContext.
Продолжайте идти внутрь.
1protected ConfigurableApplicationContext createApplicationContext() {
2 Class<?> contextClass = this.applicationContextClass;
3 if (contextClass == null) {
4 try {
5 contextClass = Class.forName(this.webEnvironment
6 ? DEFAULT_WEB_CONTEXT_CLASS : DEFAULT_CONTEXT_CLASS);
7 }
8 catch (ClassNotFoundException ex) {
9 throw new IllegalStateException(
10 "Unable create a default ApplicationContext, "
11 + "please specify an ApplicationContextClass",
12 ex);
13 }
14 }
15 return (ConfigurableApplicationContext) BeanUtils.instantiate(contextClass);
16}
Логика ясна:
Сначала найдите класс контекста и создайте его экземпляр с помощью служебного метода.
встрока 5Есть мнение: если это веб-окружение, загрузите класс DEFAULT _WEB_CONTEXT_CLASS. См. определение переменной-члена, имя класса которой:
1AnnotationConfigEmbeddedWebApplicationContext
Структура наследования этого класса показана на рисунке:
Непосредственно наследуйте GenericWebApplicationContext. Этот класс был представлен в предыдущей статье, просто помните, что он предоставляет контекст специально для веб-приложений.
refresh
После создания контекста и инициализации некоторых столбцов контекста вызывается метод обновления контекста, и начинается настоящая драма.
Спереди мы можем видеть структуру наследования AnnotationConfigEmbeddedWebApplicationContext, вызов метода обновления этого класса в конечном итоге будет выполняться его прямым родительским классом: EmbeddedWebApplicationContext.
1@Override
2protected void onRefresh() {
3 super.onRefresh();
4 try {
5 createEmbeddedServletContainer();
6 }
7 catch (Throwable ex) {
8 throw new ApplicationContextException("Unable to start embedded container",
9 ex);
10 }
11}
Сосредоточимся на строке 5.
1private void createEmbeddedServletContainer() {
2 EmbeddedServletContainer localContainer = this.embeddedServletContainer;
3 ServletContext localServletContext = getServletContext();
4 if (localContainer == null && localServletContext == null) {
5 EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory();
6 this.embeddedServletContainer = containerFactory
7 .getEmbeddedServletContainer(getSelfInitializer());
8 }
9 else if (localServletContext != null) {
10 try {
11 getSelfInitializer().onStartup(localServletContext);
12 }
13 catch (ServletException ex) {
14 throw new ApplicationContextException("Cannot initialize servlet context",
15 ex);
16 }
17 }
18 initPropertySources();
19}
В строке 5 кода получается EmbeddedServletContainerFactory. Как следует из названия, его функция заключается в создании встроенного контейнера сервлетов на следующем шаге: EmbeddedServletContainer.
1public interface EmbeddedServletContainerFactory {
2
3 /**
4 * 创建一个配置完全的但是目前还处于“pause”状态的实例.
5 * 只有其 start 方法被调用后，Client 才能与其建立连接。
6 */
7 EmbeddedServletContainer getEmbeddedServletContainer(
8 ServletContextInitializer... initializers);
9
10}
Строки 6 и 7, когда containerFactory получает EmbeddedServletContainer, параметр является результатом выполнения функции getSelfInitializer. Независимо от его внутреннего механизма на данный момент, просто знайте, что он вернет объект ServletContextInitializer для инициализации контейнера, и мы продолжим смотреть вниз.
Поскольку EmbeddedServletContainerFactory является абстрактной фабрикой, разные контейнеры имеют разные реализации.Поскольку SpringBoot по умолчанию использует Tomcat, он анализируется с помощью класса реализации фабрики Tomcat TomcatEmbeddedServletContainerFactory:
1@Override
2public EmbeddedServletContainer getEmbeddedServletContainer(
3 ServletContextInitializer... initializers) {
4 Tomcat tomcat = new Tomcat();
5 File baseDir = (this.baseDirectory != null ? this.baseDirectory
6 : createTempDir("tomcat"));
7 tomcat.setBaseDir(baseDir.getAbsolutePath());
8 Connector connector = new Connector(this.protocol);
9 tomcat.getService().addConnector(connector);
10 customizeConnector(connector);
11 tomcat.setConnector(connector);
12 tomcat.getHost().setAutoDeploy(false);
13 tomcat.getEngine().setBackgroundProcessorDelay(-1);
14 for (Connector additionalConnector : this.additionalTomcatConnectors) {
15 tomcat.getService().addConnector(additionalConnector);
16 }
17 prepareContext(tomcat.getHost(), initializers);
18 return getTomcatEmbeddedServletContainer(tomcat);
19}
Со строки 8 по строку 16 добавление коннектора tomcat завершено. Коннектор в tomcat в основном отвечает за обработку HTTP-запросов.Конкретный принцип можно найти в исходном коде Tomcat, который здесь не упоминается.
Метод в строке 17 немного длинноват, поэтому давайте сосредоточимся на нескольких строках:
1if (isRegisterDefaultServlet()) {
2 addDefaultServlet(context);
3}
4if (isRegisterJspServlet() && ClassUtils.isPresent(getJspServletClassName(),
5 getClass().getClassLoader())) {
6 addJspServlet(context);
7 addJasperInitializer(context);
8 context.addLifecycleListener(new StoreMergedWebXmlListener());
9}
10ServletContextInitializer[] initializersToUse = mergeInitializers(initializers);
11configureContext(context, initializersToUse);
Первые две ветви определяют добавление класса сервлета по умолчанию и класса сервлета, связанного с jsp.
После слияния всех ServletContextInitializers используйте объединенный класс инициализации для настройки контекста.
В строке 18 перейдите по методу и официально запустите Tomcat.
1private synchronized void initialize() throws EmbeddedServletContainerException {
2 TomcatEmbeddedServletContainer.logger
3 .info("Tomcat initialized with port(s): " + getPortsDescription(false));
4 try {
5 addInstanceIdToEngineName();
6
7 // Remove service connectors to that protocol binding doesn't happen yet
8 removeServiceConnectors();
9
10 // Start the server to trigger initialization listeners
11 this.tomcat.start();
12
13 // We can re-throw failure exception directly in the main thread
14 rethrowDeferredStartupExceptions();
15
16 // Unlike Jetty, all Tomcat threads are daemon threads. We create a
17 // blocking non-daemon to stop immediate shutdown
18 startDaemonAwaitThread();
19 }
20 catch (Exception ex) {
21 throw new EmbeddedServletContainerException("Unable to start embedded Tomcat",
22 ex);
23 }
24}
Строка 11 официально запускает tomcat.
Теперь вернемся и посмотрим на предыдущий метод getSelfInitializer:
1private ServletContextInitializer getSelfInitializer() {
2 return new ServletContextInitializer() {
3 @Override
4 public void onStartup(ServletContext servletContext) throws ServletException {
5 selfInitialize(servletContext);
6 }
7 };
8}
1private void selfInitialize(ServletContext servletContext) throws ServletException {
2 prepareEmbeddedWebApplicationContext(servletContext);
3 ConfigurableListableBeanFactory beanFactory = getBeanFactory();
4 ExistingWebApplicationScopes existingScopes = new ExistingWebApplicationScopes(
5 beanFactory);
6 WebApplicationContextUtils.registerWebApplicationScopes(beanFactory,
7 getServletContext());
8 existingScopes.restore();
9 WebApplicationContextUtils.registerEnvironmentBeans(beanFactory,
10 getServletContext());
11 for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
12 beans.onStartup(servletContext);
13 }
14}
В методе prepareEmbeddedWebApplicationContext в строке 2 EmbeddedWebApplicationContext в основном устанавливается в значение rootContext.
Строка 4 позволяет пользователю сохранить пользовательскую область.
Строка 6 в основном используется для регистрации веб-области в BeanFactory, например («запрос», «сессия», «глобальная сессия», «приложение»).
Строка 9 регистрирует специфичный для Интернета компонент среды (например, ("contextParameters", "contextAttributes")) с данным BeanFactory.
Строки 11 и 12 более важны и в основном используются для настройки сервлета, фильтров, слушателей, параметров контекста и некоторых необходимых свойств во время инициализации.
Возьмем пример его реализации класса ServletContextInitializer:
1@Override
2public void onStartup(ServletContext servletContext) throws ServletException {
3 Assert.notNull(this.servlet, "Servlet must not be null");
4 String name = getServletName();
5 if (!isEnabled()) {
6 logger.info("Servlet " + name + " was not registered (disabled)");
7 return;
8 }
9 logger.info("Mapping servlet: '" + name + "' to " + this.urlMappings);
10 Dynamic added = servletContext.addServlet(name, this.servlet);
11 if (added == null) {
12 logger.info("Servlet " + name + " was not registered "
13 + "(possibly already registered?)");
14 return;
15 }
16 configure(added);
17}
Вы можете увидеть печать в строке 9:Именно здесь реализовано сопоставление сервлета с URLMapping.
Суммировать
В этой статье выясняется, почему не нужно самостоятельно настраивать Tomcat в SpringBoot из основного анализа контекста, и как запускается встроенный контейнер.Кстати, в процессе анализа мы нашли реализацию нашего часто используемого urlMapping картографический сервлет.