Springboot 使用外部 Tomcat 1.修改 pom.xml,改為打 war 包 2.將 Springboot 內置 tomcat 作用域改為 3.重寫 SpringBootServletInitializer 4.maven 打包出 war 包後,放到 tomcat 的 webapps ...
Springboot 使用外部 Tomcat
1.修改 pom.xml,改為打 war 包
<packaging>war</packaging>
2.將 Springboot 內置 tomcat 作用域改為provided
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
3.重寫 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 目錄下即可。
如果要訪問該 war 包的介面,預設需要在 url 加項目名作為首碼,例如:http://localhost:8080/{項目名}/users/123456
原理分析
ServletContainerInitializer
Servlet 容器啟動時,會掃描當前應用每個 jar 包路徑META-INF\services
下的文件javax.servlet.ServletContainerInitializer
,其文件內容就是 ServletContainerInitializer 的實現類全類名,並調用其 onStartup() 方法。比如,在 Spring-web 包下,該文件內容就是org.springframework.web.SpringServletContainerInitializer
,其源碼如下:
// 容器啟動時,將 WebApplicationInitializer 的所有子類傳遞至 webAppInitializerClasses
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
/**
* @param webAppInitializerClasses @HandlesTypes 導入的類
* @param servletContext 當前 web 應用 servlet 上下文
*/
@Override
public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext) throws ServletException {
List<WebApplicationInitializer> initializers = new LinkedList<>();
for (Class<?> waiClass : webAppInitializerClasses) {
// 過濾出可用的 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);
}
}
}
容器啟動時,執行 SpringServletContainerInitializer.onStartup() 方法,@HandlesTypes 註解聲明瞭 WebApplicationInitializer 的所有子類(在前面的示例中,啟動類 Bootstrap 實現的 SpringBootServletInitializer 就是它的一個實現)會被傳遞給方法的參數 webAppInitializerClasses。
onStartup() 方法會過濾出 webAppInitializerClasses 中可用的 WebApplicationInitializer 子類 Bootstrap,然後回調 SpringBootServletInitializer 的 onStartup() 方法,其源碼如下:
public void onStartup(ServletContext servletContext) throws ServletException {
WebApplicationContext rootAppContext = createRootApplicationContext(servletContext);
}
protected WebApplicationContext createRootApplicationContext(ServletContext servletContext) {
SpringApplicationBuilder builder = createSpringApplicationBuilder();
// 指定主類 Bootstrap
builder.main(getClass());
// 回調 Bootstrap 重寫的方法
builder = configure(builder);
return run(builder.build());
}
這個方法會配置當前 web 應用程式上下文環境:指定主類、註冊 servletContext、調用 configure()、run 運行。
由於 Bootstrap 重寫了 configure(),所以會執行重寫的方法來指定主類,最後通過 run 來完成啟動 Springboot 應用。