标签分类
技术文章
当前位置:主页 > 计算机编程 > java > SpringBoot中如何启动Tomcat流程

SpringBoot中启动Tomcat的步骤流程

  • 发布时间:
  • 作者:码农之家原创
  • 点击:59

SpringBoot中如何启动Tomcat流程

这篇文章主要知识点是关于SpringBoot,启动,Tomcat,步骤流程,SpringBoot中如何启动Tomcat流程,SpringBoot应用部署于外置Tomcat容器的方法 的内容,如果大家想对相关知识点有系统深入的学习,可以参阅以下电子书

一步一步学Spring Boot 2
  • 类型:微服务项目实战大小:72.04 MB格式:PDF出版:清华大学出版社作者:黄文毅
立即下载

前面在一篇文章中介绍了 Spring 中的一些重要的 context。有一些在此文中提到的 context,可以参看上篇文章。

SpringBoot 项目之所以部署简单,其很大一部分原因就是因为不用自己折腾 Tomcat 相关配置,因为其本身内置了各种 Servlet 容器。一直好奇: SpringBoot 是怎么通过简单运行一个 main 函数,就能将容器启动起来,并将自身部署到其上 。此文想梳理清楚这个问题。

我们从SpringBoot的启动入口中分析:

Context 创建

// Create, load, refresh and run the ApplicationContext
context = createApplicationContext();

在SpringBoot 的 run 方法中,我们发现其中很重要的一步就是上面的一行代码。注释也写的很清楚:

创建、加载、刷新、运行 ApplicationContext。

继续往里面走。

protected ConfigurableApplicationContext createApplicationContext() {
  Class<?> contextClass = this.applicationContextClass;
  if (contextClass == null) {
    try {
     contextClass = Class.forName(this.webEnvironment
        ? DEFAULT_WEB_CONTEXT_CLASS : DEFAULT_CONTEXT_CLASS);
    }
    catch (ClassNotFoundException ex) {
     throw new IllegalStateException(
        "Unable create a default ApplicationContext, "
           + "please specify an ApplicationContextClass",
        ex);
   }
  }
  return (ConfigurableApplicationContext) BeanUtils.instantiate(contextClass);
}
 

逻辑很清楚:

先找到 context 类,然后利用工具方法将其实例化。

其中 第5行 有个判断:如果是 web 环境,则加载 DEFAULT _WEB_CONTEXT_CLASS类。参看成员变量定义,其类名为:

AnnotationConfigEmbeddedWebApplicationContext

此类的继承结构如图:

 

 
SpringBoot中如何启动Tomcat流程

 

直接继承 GenericWebApplicationContext。关于该类前文已有介绍,只要记得它是专门为 web application提供context 的就好。

refresh

在经历过 Context 的创建以及Context的一些列初始化之后,调用 Context 的 refresh 方法,真正的好戏才开始上演。

从前面我们可以看到AnnotationConfigEmbeddedWebApplicationContext的继承结构,调用该类的refresh方法,最终会由其直接父类:EmbeddedWebApplicationContext 来执行。

@Override
 protected void onRefresh() {
  super.onRefresh();
  try {
    createEmbeddedServletContainer();
  }
  catch (Throwable ex) {
    throw new ApplicationContextException("Unable to start embedded container",
       ex);
  }
}

我们重点看第5行。

private void createEmbeddedServletContainer() {
  EmbeddedServletContainer localContainer = this.embeddedServletContainer;
  ServletContext localServletContext = getServletContext();
  if (localContainer == null && localServletContext == null) {
    EmbeddedServletContainerFactory containerFactory = getEmbeddedServletContainerFactory();
    this.embeddedServletContainer = containerFactory
       .getEmbeddedServletContainer(getSelfInitializer());
  }
  else if (localServletContext != null) {
   try {
     getSelfInitializer().onStartup(localServletContext);
   }
   catch (ServletException ex) {
     throw new ApplicationContextException("Cannot initialize servlet context",
        ex);
   }
  }
  initPropertySources();
}

代码第5行,获取到了一个EmbeddedServletContainerFactory,顾名思义,其作用就是为了下一步创建一个嵌入式的 servlet 容器:EmbeddedServletContainer。

public interface EmbeddedServletContainerFactory {
 
  /**
   * 创建一个配置完全的但是目前还处于“pause”状态的实例.
   * 只有其 start 方法被调用后,Client 才能与其建立连接。
   */
  EmbeddedServletContainer getEmbeddedServletContainer(
     ServletContextInitializer... initializers);
 
}

第6、7行,在 containerFactory 获取EmbeddedServletContainer的时候,参数为 getSelfInitializer 函数的执行结果。暂时不管其内部机制如何,只要知道它会返回一个 ServletContextInitializer 用于容器初始化的对象即可,我们继续往下看。

由于 EmbeddedServletContainerFactory 是个抽象工厂,不同的容器有不同的实现,因为SpringBoot默认使用Tomcat,所以就以 Tomcat 的工厂实现类 TomcatEmbeddedServletContainerFactory 进行分析:

 @Override
 public EmbeddedServletContainer getEmbeddedServletContainer(
    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);
  tomcat.getEngine().setBackgroundProcessorDelay(-);
  for (Connector additionalConnector : this.additionalTomcatConnectors) {
   tomcat.getService().addConnector(additionalConnector);
  }
  prepareContext(tomcat.getHost(), initializers);
  return getTomcatEmbeddedServletContainer(tomcat);
}

从第8行一直到第16行完成了 tomcat 的 connector 的添加。tomcat 中的 connector 主要负责用来处理 http 请求,具体原理可以参看 Tomcat 的源码,此处暂且不提。

第17行的 方法有点长,重点看其中的几行:

 if (isRegisterDefaultServlet()) {
  addDefaultServlet(context);
 }
 if (isRegisterJspServlet() && ClassUtils.isPresent(getJspServletClassName(),
    getClass().getClassLoader())) {
  addJspServlet(context);
  addJasperInitializer(context);
  context.addLifecycleListener(new StoreMergedWebXmlListener());
 }
ServletContextInitializer[] initializersToUse = mergeInitializers(initializers);
configureContext(context, initializersToUse);

前面两个分支判断添加了默认的 servlet类和与 jsp 相关的 servlet 类。

对所有的 ServletContextInitializer 进行合并后,利用合并后的初始化类对 context 进行配置。

第 18 行,顺着方法一直往下走,开始正式启动 Tomcat。

private synchronized void initialize() throws EmbeddedServletContainerException {
  TomcatEmbeddedServletContainer.logger
     .info("Tomcat initialized with port(s): " + getPortsDescription(false));
  try {
    addInstanceIdToEngineName();
 
    // Remove service connectors to that protocol binding doesn't happen yet
    removeServiceConnectors();
 
   // Start the server to trigger initialization listeners
   this.tomcat.start();

   // We can re-throw failure exception directly in the main thread
   rethrowDeferredStartupExceptions();

   // Unlike Jetty, all Tomcat threads are daemon threads. We create a
   // blocking non-daemon to stop immediate shutdown
   startDaemonAwaitThread();
  }
  catch (Exception ex) {
   throw new EmbeddedServletContainerException("Unable to start embedded Tomcat",
      ex);
  }
}

第11行正式启动 tomcat。

现在我们回过来看看之前的那个 getSelfInitializer 方法:

private ServletContextInitializer getSelfInitializer() {
  return new ServletContextInitializer() {
   @Override
   public void onStartup(ServletContext servletContext) throws ServletException {
     selfInitialize(servletContext);
   }
  };
}
private void selfInitialize(ServletContext servletContext) throws ServletException {
  prepareEmbeddedWebApplicationContext(servletContext);
  ConfigurableListableBeanFactory beanFactory = getBeanFactory();
  ExistingWebApplicationScopes existingScopes = new ExistingWebApplicationScopes(
     beanFactory);
  WebApplicationContextUtils.registerWebApplicationScopes(beanFactory,
     getServletContext());
  existingScopes.restore();
  WebApplicationContextUtils.registerEnvironmentBeans(beanFactory,
     getServletContext());
  for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
   beans.onStartup(servletContext);
  }
}

在第2行的prepareEmbeddedWebApplicationContext方法中主要是将 EmbeddedWebApplicationContext 设置为rootContext。

第4行允许用户存储自定义的 scope。

第6行主要是用来将web专用的scope注册到BeanFactory中,比如("request", "session", "globalSession", "application")。

第9行注册web专用的environment bean(比如 ("contextParameters", "contextAttributes"))到给定的 BeanFactory 中。

第11和12行,比较重要,主要用来配置 servlet、filters、listeners、context-param和一些初始化时的必要属性。

以其一个实现类ServletContextInitializer试举一例:

@Override
 public void onStartup(ServletContext servletContext) throws ServletException {
  Assert.notNull(this.servlet, "Servlet must not be null");
  String name = getServletName();
  if (!isEnabled()) {
    logger.info("Servlet " + name + " was not registered (disabled)");
    return;
  }
  logger.info("Mapping servlet: '" + name + "' to " + this.urlMappings);
  Dynamic added = servletContext.addServlet(name, this.servlet);
  if (added == null) {
   logger.info("Servlet " + name + " was not registered "
      + "(possibly already registered?)");
   return;
  }
  configure(added);
}

可以看第9行的打印: 正是在这里实现了 servlet 到 URLMapping的映射。

总结

这篇文章从主干脉络分析找到了为什么在SpringBoot中不用自己配置Tomcat,内置的容器是怎么启动起来的,顺便在分析的过程中找到了我们常用的 urlMapping 映射 Servlet 的实现。

SpringBoot应用部署于外置Tomcat容器的方法

0x01. 概述

SpringBoot平时我们用的爽歪歪,爽到它自己连Tomcat都自集成了,我们可以直接编写SBT启动类,然后一键开启内置的Tomcat容器服务,确实是很好上手。但考虑到实际的情形中,我们的Tomcat服务器一般是另外部署好了的,有专门的维护方式。此时我们需要剥离掉SBT应用内置的Tomcat服务器,进而将应用发布并部署到外置的Tomcat容器之中,本文就实践一下这个。

0x02. 修改打包方式

修改项目的pom.xml配置,我们修改其打包方式为war方式,如:

<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>

0x03. 移除SBT自带的嵌入式Tomcat

修改pom.xml,从maven的pom中移除springboot自带的的嵌入式tomcat插件

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
 <!-- 移除嵌入式tomcat插件 -->
 <exclusions>
  <exclusion>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-tomcat</artifactId>
  </exclusion>
 </exclusions>
</dependency>

0x04. 添加servlet-api依赖

修改pom.xml,在maven的pom中添加servlet-api的依赖

<dependency>
 <groupId>javax.servlet</groupId>
 <artifactId>javax.servlet-api</artifactId>
 <version>3.1.0</version>
 <scope>provided</scope>
</dependency>

0x05. 修改启动类,并重写初始化方法

在SpringBoot中我们平常用main方法启动的方式,都有一个SpringBootApplication的启动类,类似代码如下:

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

而我们现在需要类似于web.xml的配置方式来启动spring应用,为此,我们在Application类的同级添加一个SpringBootStartApplication类,其代码如下:

// 修改启动类,继承 SpringBootServletInitializer 并重写 configure 方法
public class SpringBootStartApplication extends SpringBootServletInitializer {
 @Override
 protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
  // 注意这里一定要指向原先用main方法执行的Application启动类
  return builder.sources(Application.class);
 }
}

0x06. 部署到外部的Tomcat容器并验证

在项目根目录下(即包含pom.xml的目录)记性maven打包操作:

mvn clean package

等待打包完成,出现 [INFO] BUILD SUCCESS 即为打包成功

然后我们把target目录下生成的war包放到tomcat的webapps目录下,启动tomcat,即可自动解压部署。

最后在浏览器中验证:

http://YOUR_IP:[端口号]/[打包项目名]

SpringBoot应用部署于外置Tomcat容器的方法

也可以直接将项目命名为ROOT,这样访问根目录即可访问tomcat中的SpringBoot应用

http://YOUR_IP:[端口号]

SpringBoot应用部署于外置Tomcat容器的方法

SpringBoot应用部署于外置Tomcat容器的方法

总结

以上所述是小编给大家介绍的SpringBoot应用部署于外置Tomcat容器,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对码农之家网站的支持!

以上就是本次给大家分享的全部知识点内容总结,大家还可以在下方相关文章里找到等java文章进一步学习,感谢大家的阅读和支持。

上一篇:java泛型的本质(非类型擦除)知识点详解

下一篇:java实现的密码强度检测功能的方法和代码

展开 +

收起 -

学习笔记
网友NO.928451

spring boot项目打包成war在tomcat运行的全步骤

前言 使用maven创建的springboot项目,默认是jar包,springboot还有自己带的tomcat。现在需要将项目打包,并部署到服务器tomcat下面。 下面就让我们来一起把spring-boot项目按照平常的web项目一样发布到tomcat容器下,下面话不多说了,来一起看看详细的介绍吧 一、修改打包形式 在pom.xml里设置 packagingwar/packaging 二、移除嵌入式tomcat插件 在pom.xml里找到spring-boot-starter-web依赖节点,在其中添加如下代码, dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId !-- 移除嵌入式tomcat插件 -- exclusions exclusion groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-tomcat/artifactId /exclusion /exclusions/dependency 三、添加servlet-api的依赖 下面两种方式都可以,任选其一 dependency groupIdjavax.servlet/groupId artifactIdjavax.servlet-api/artifactId version3.1.0/version scopeprovided/scope/dependency dependency groupIdorg.apache.tomcat/groupId artifactIdtomcat-servlet-api/artifactId version8.0.36/version scopeprovided/scope/dependency 四、修改启动类,并重写初始化方法 我们平常用main方法启动的方式,都有一个App的启动类,代码如下: @SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }} 我们需要类似于web.xml的配置方式来启动spring上下文了,在Applica……

网友NO.386166

Spring Boot使用Thymeleaf + Gradle构建war到Tomcat

Spring Boot 以Jar的方式部署启动,这个不用介绍了, 之前也介绍了关于 Spring Boot + thymeleaf 的简单使用 ,但是今天遇到一个问题, 我先描述下问题的场景: 由于运维部门的需求,项目需要以 war 的形式放到 tomcat 运行,而不是原定的 jar 的方式运行 配置了一下午,也查了一下午的资料,以 war 的方式在 Tomcat 能运行,并且能访问 Controller ,但是在返回html视图时,找不到视图模板。最终发现问题在 Thymeleaf 的配置,话不多说,具体看操作步骤: 1、Spring boot 容器配置需要继承SpringBootServletInitializer 这里我继承的是 web.suport 下面的 SpringBootServletInitializer 。 @SpringBootApplicationpublic class Application extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { return application.sources(Application.class); } public static void main(String[] args) throws Exception { SpringApplication.run(Application.class, args); }} 2、更新你的Maven or Gradle 打包方式配置 下一步是更新你的构建配置,这样你的项目将产生一个war包而不是jar包。如果你使用 Maven ,并使用 spring-boot-starter-parent (为了配置Maven的war插件),所有你需要做的就是更改 pom.xml 的 packaging 为 war : packagingwar/packaging 如果你使用 Gradle ,你需要修改 build.gradle 来将 war 插件应用到项目上: ……

网友NO.546154

spring boot tomcat jdbc pool的属性绑定

下面看下spring boot tomcat jdbc pool的属性绑定代码,具体代码如下所示: spring: datasource: type: org.apache.tomcat.jdbc.pool.DataSource driver-class-name: org.postgresql.Driver url: jdbc:postgresql://192.168.99.100:5432/postgres?connectTimeout=6000gt; min-idle, poolSweeper will start to close min-idle: 1 使用如上配置,最后发现initial-size,max-active,max-idle,min-idle等配置均无效,生成的tomcat jdbc datasource还是使用的默认的配置 正确配置 spring: datasource: type: org.apache.tomcat.jdbc.pool.DataSource driver-class-name: org.postgresql.Driver url: jdbc:postgresql://192.168.99.100:5432/postgres?connectTimeout=6000gt; min-idle, poolSweeper will start to close min-idle: 1 注意,这里把具体tomcat数据库连接池的配置属性放到了spring.datasource.tomcat属性下面,这样才可以生效。 源码解析 spring-boot-autoconfigure-1.5.9.RELEASE-sources.jar!/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java@Configuration @Conditional(PooledDataSourceCondition.class) @ConditionalOnMissingBean({ DataSource.class, XADataSource.class }) @Import({ DataSourceConfiguration.Tomcat.class, DataSourceConfiguration.Hikari.class, DataSourceConfiguration.Dbcp.class, DataSourceConfiguration.Dbcp2.class, DataSourceConfiguration.Generic.class }) @SuppressWarnings("deprecation") protected static class PooledDataSourceConfiguration { } DataSourceConfiguration.Tomcat spring-boot-autoconfigure-1.5.9.RE……

网友NO.106454

SpringBoot部署在tomcat容器中运行的部署方法

部署在tomcat容器中首先需要添加一些新的包和启动程序 1.在pom.xml文件中packaging便签下 jar 改为 war packagingwar/packaging 2.在pom.xml文件中添加新的依赖包 dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-tomcat/artifactId scopeprovided/scope /dependency 3.在spring-boot启动类的目录下添加一个新的启动类 package com.erxi.ms;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;import org.springframework.boot.builder.SpringApplicationBuilder;import org.springframework.boot.web.support.SpringBootServletInitializer;@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class})public class SpringBootStartApplication extends SpringBootServletInitializer { @Override protected SpringApplicationBuilder configure( SpringApplicationBuilder builder) { // 注意这里要指向原先用main方法执行的MainApplication启动类 return builder.sources(MainApplication.class); }} 总结 以上所述是小编给大家介绍的SpringBoot部署在tomcat容器中运行的部署方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对码农之家网站的支持! ……

<
1
>

Copyright 2018-2019 xz577.com 码农之家

版权责任说明