Spring Boot源码分析之外部tomcat启动war包的原理

前情提示:以前我们说过，springboot程序是jar的方式,是通过IOC容器启动带动了tomcat的启动
那么，我们把springboot的程序打成war的时候，是怎么样的原理了？(tomcat启动带动IOC容器的启动)
从疑问开始: 我们把springboot打成war的包时候，为什么要在启动类程序上实现 SpringBootServletInitializer 接口?
以及com.tuling.TulingvipSpringbootWarApplication#configure()是在什么时候触发调用的?

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

1 从servlet3.0的特性说起

8.2.4 Shared libraries / runtimes pluggability

The ServletContainerInitializer class is looked up via the jar services API. For each application, an instance of the ServletContainerInitializer is created by the container at application startup time. The framework providing an implementation of the ServletContainerInitializer MUST bundle in the META-INF/services directory of the jar file a file called javax.servlet.ServletContainerInitializer, as per the jar services API,that points to the implementation class of the ServletContainerInitializer. In addition to the ServletContainerInitializer we also have an annotation -HandlesTypes. The HandlesTypes annotation on the implementation of the ServletContainerInitializer is used to express interest in classes that may have annotations (type, method or field level annotations) specified in the value of the HandlesTypes or if it extends / implements one those classes anywhere in the class’ super types. The HandlesTypes annotation is applied irrespective of the setting of metadata-complete.

1.1 web应用启动， 会创建当前Web应用导入jar包中的 ServletContainerInitializer类的实例

1.2 ServletContainerInitializer 类必须放在jar包的 META-INF/services目录下,文件名称为 javax.servlet.ServletContainerInitializer

1.3 文件的内容指向ServletContainerInitializer实现类的全路径

1.4 使用@HandlesTypes在我们应用启动的时候，加载我们感兴趣的类

@HandlesTypes(WebApplicationInitializer.class)
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
    @Override
    public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext) throws ServletException {
        //创建保存感兴趣的类的集合
        List<WebApplicationInitializer> initializers = new LinkedList<>();
        if (webAppInitializerClasses != null) {
            for (Class<?> waiClass : webAppInitializerClasses) {
                // Be defensive: Some servlet containers provide us with invalid classes,
                // no matter what @HandlesTypes says...
                // 判断感兴趣的类不是接口不是抽象类
                if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) && WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
                    try {
                        //通过反射创建实例并且加入到集合中
                        initializers.add((WebApplicationInitializer) ReflectionUtils.accessibleConstructor(waiClass).newInstance());
                    } catch (Throwable ex) {
                        throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
                    }
                }
            }
        }
        if (initializers.isEmpty()) {
            servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
            return;
        }
        servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
        AnnotationAwareOrderComparator.sort(initializers);
        //循环调用集合中的感兴趣类对象的onstartup的方法
        for (WebApplicationInitializer initializer : initializers) {
            initializer.onStartup(servletContext);
        }
    }
}

主要流程:

1 tomcat启动，然后去

org\springframework\spring-web\5.0.10.RELEASE\spring-web-5.0. 10.RELEASE.jar!\META-INF\services\javax.servlet.ServletContainerInitializer文件中org.springframework.web.SpringServletContainerInitializer的实例

2 将@HandlesTypes标注的感兴趣的类 （WebApplicationInitializer） 都传入到 osStartup()的方法中

Set<Class<?>>参数中为这些感兴趣的类创建实例 ReflectionUtils.accessibleConstructor(waiClass).newInstance());

3 调用WebApplicationInitializer的onStartup方法

3.1 我们来看下 WebApplicationInitializer的实现类就有我们的TulingVipSpringBootWarApplication类

3.2 由于TulingVipSpringBootWarApplication这个类 没有自己的onstart方法 ， 那么就调用父类SpringBootServletInitializer的onStartup的方法

2 Spring Boot启动War包流程图