Springboot 2使用外部Tomcat源码分析
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 应用。
总结
以上所述是小编给大家介绍的Springboot 2使用外部Tomcat源码分析,希望对大家有所帮助,如果大家有任何疑问欢迎给我留言,小编会及时回复大家的!