Springboot 2使用外部Tomcat源碼分析

更新時(shí)間：2019年08月17日 10:30:12 作者：O''Neal

這篇文章主要介紹了Springboot 2使用外部Tomcat源碼分析，本文給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

Springboot 使用外部 Tomcat

1.修改 pom.xml，改為打 war 包

<packaging>war</packaging>

2.將 Springboot 內(nèi)置 tomcat 作用域改為provided

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-tomcat</artifactId>
  <scope>provided</scope>
</dependency>

3.重寫(xiě) SpringBootServletInitializer

@SpringBootApplication
public class Bootstrap extends SpringBootServletInitializer {
 public static void main(String[] args) {
  SpringApplication.run(Bootstrap.class, args);
 }
 @Override
 protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
  return builder.sources(Bootstrap.class);
 }
}

4.maven 打包出 war 包后，放到 tomcat 的 webapps 目錄下即可。

如果要訪(fǎng)問(wèn)該 war 包的接口，默認(rèn)需要在 url 加項(xiàng)目名作為前綴，例如：http://localhost:8080/{項(xiàng)目名}/users/123456

原理分析

ServletContainerInitializer

Servlet 容器啟動(dòng)時(shí)，會(huì)掃描當(dāng)前應(yīng)用每個(gè) jar 包路徑META-INF\services下的文件javax.servlet.ServletContainerInitializer，其文件內(nèi)容就是 ServletContainerInitializer 的實(shí)現(xiàn)類(lèi)全類(lèi)名，并調(diào)用其 onStartup() 方法。比如，在 Spring-web 包下，該文件內(nèi)容就是

org.springframework.web.SpringServletContainerInitializer，其源碼如下：

// 容器啟動(dòng)時(shí)，將 WebApplicationInitializer 的所有子類(lèi)傳遞至 webAppInitializerClasses
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
  /**
   * @param webAppInitializerClasses @HandlesTypes 導(dǎo)入的類(lèi)
   * @param servletContext 當(dāng)前 web 應(yīng)用 servlet 上下文
   */
  @Override
  public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext) throws ServletException {
    List<WebApplicationInitializer> initializers = new LinkedList<>();
    for (Class<?> waiClass : webAppInitializerClasses) {
      // 過(guò)濾出可用的 WebApplicationInitializer
      if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) && WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
        initializers.add((WebApplicationInitializer)ReflectionUtils.accessibleConstructor(waiClass).newInstance());
      }
    }
    for (WebApplicationInitializer initializer : initializers) {
      initializer.onStartup(servletContext);
    }
  }
}

容器啟動(dòng)時(shí)，執(zhí)行 SpringServletContainerInitializer.onStartup() 方法，@HandlesTypes 注解聲明了 WebApplicationInitializer 的所有子類(lèi)（在前面的示例中，啟動(dòng)類(lèi) Bootstrap 實(shí)現(xiàn)的 SpringBootServletInitializer 就是它的一個(gè)實(shí)現(xiàn)）會(huì)被傳遞給方法的參數(shù) webAppInitializerClasses。

onStartup() 方法會(huì)過(guò)濾出 webAppInitializerClasses 中可用的 WebApplicationInitializer 子類(lèi) Bootstrap，然后回調(diào) SpringBootServletInitializer 的 onStartup() 方法，其源碼如下：

public void onStartup(ServletContext servletContext) throws ServletException {
  WebApplicationContext rootAppContext = createRootApplicationContext(servletContext);
}
protected WebApplicationContext createRootApplicationContext(ServletContext servletContext) {
  SpringApplicationBuilder builder = createSpringApplicationBuilder();
  // 指定主類(lèi) Bootstrap
  builder.main(getClass());
  // 回調(diào) Bootstrap 重寫(xiě)的方法
  builder = configure(builder);
  return run(builder.build());
}

這個(gè)方法會(huì)配置當(dāng)前 web 應(yīng)用程序上下文環(huán)境：指定主類(lèi)、注冊(cè) servletContext、調(diào)用 configure()、run 運(yùn)行。

由于 Bootstrap 重寫(xiě)了 configure()，所以會(huì)執(zhí)行重寫(xiě)的方法來(lái)指定主類(lèi)，最后通過(guò) run 來(lái)完成啟動(dòng) Springboot 應(yīng)用。

總結(jié)

以上所述是小編給大家介紹的Springboot 2使用外部Tomcat源碼分析，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)歡迎給我留言，小編會(huì)及時(shí)回復(fù)大家的！

您可能感興趣的文章: