Spring 应用的多种启动方式

本文基于:
SpringBoot-2.1.4

方式1. Servlet3.0 之前使用 web.xml 配置监听器,Servlet,Filter 就可以了,如下:

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
      ...
</servlet>
<filter>
      ...
</filter>

ContextLoaderListener实现了 ServletContextListener,当 Servlet 容器启动时,contextInitialized(ServletContextEvent event)方法会被回调,Spring 会做相应的 ApplicationContext 初始化。

方式2. Servlet3.0 之后,可以使用编程方式启动 Spring(不使用 Springboot)

该方式得益于 Servlet3.0 的 ServletContainerInitializer 接口,该接口使用 SPI 加载实现类,Spring 的SpringServletContainerInitializer 实现了该接口,源码如下:

@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {
    @Override
    public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
            throws ServletException {
  ...
  }
}

HandlesTypes: HandlesTypes的作用是其配置的类会被注入到onStartup方法的webAppInitializerClasses参数。

我们也可以自己实现 ServletContainerInitializer 来做我们想做的事情。但是一般我们只要实现了 AbstractAnnotationConfigDispatcherServletInitializer 就可以使用 Spring(非 SpringBoog)。

方式3. SpringBoot war包启动

如果你是使用的 SpringBoot war包启动的话,你的启动类可能是这样的:

@SpringBootApplication
public class SpringTestApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(SpringTestApplication.class);
    }
}

SpringBootServletInitializer 实现了 WebApplicationInitializer,就像上面提到的,我们的启动类会被注入到 SpringServletContainerInitializeronStartup 方法。在 onStartup 方法中 Spring 会做相应的ApplicationContext 初始化。看 SpringBootServletInitializer 的源码你就会发现,其实 war 包启动的方式最后还是会使用到 SpringApplication#run。

方式4. SpringBoot jar方式启动

该方式,Spring 会通过 main 方法中的 SpringApplication.run(SpringTestApplication.class, args); 来做相应的 ApplicationContext 初始化,并且它使用嵌入式的 Tomcat 来加载 Servlet,但是它没有完全遵守 servlet3.0 的规范,你可以尝试在 SpringServletContainerInitializer 中打个断点,你会发现它并没有被运行。它其实会进入到TomcatStarterTomcatStarterSpringServletContainerInitializer 一样也实现了 ServletContainerInitializer 接口,监听器,Servlet,Filter 的注册依靠的是 ServletContextInitializer。具体请看 spring-boot中tomcat的启动过程

对于为什么不使用 SpringServletContainerInitializer? SpringBoot 在 github 的 issues 中也做了回答。Springboot 考虑到了如下的问题,我们在使用 Springboot 时,开发阶段一般都是使用内嵌 tomcat 容器,但部署时却存在两种选择:一种是打成 jar 包,使用 java -jar 的方式运行;另一种是打成 war 包,交给外置容器去运行。前者就会导致容器搜索算法出现问题,因为这是 jar 包的运行策略,不会按照 servlet3.0 的策略去加载 ServletContainerInitializer!最后作者还提供了一个替代选项:ServletContextInitializer。该类被使用在了 TomcatServer 中。其实 war 包启动也会使用到 ServletContextInitializer,只要是 SpringBoot 启动都会使用 ServletContextInitializer 而不是 ServletContainerInitializer

3.1 自定义 Servler,Filter,Listener 的一种注册方式

基于以上内容,我们可以自定义 ServletContextInitializer 的实现类来实现 Servler,Filter,Listener 的注册(无论你是war包启动还是jar包启动)。其实 Spirng 已经帮我们做好了,当你去看它的实现类时,你会看到:

  • ServletRegistrationBean:用来注册 Servlet
  • FilterRegistrationBean:用来注册 Filter
  • ServletListenerRegistrationBean:用来注册 Listener
  • ...

Spring 会通过以下方法为你注册:

ServletWebServerApplicationContext.java

private void createWebServer() {
    WebServer webServer = this.webServer;
    ServletContext servletContext = getServletContext();
    if (webServer == null && servletContext == null) { //jar包启动入口
        ServletWebServerFactory factory = getWebServerFactory();
        // 这一步 getSelfInitializer() 方法返回的是一个 ServletContextInitializer,
        // 它负责处理所有的 Servler,Filter,Listener 的注册
        this.webServer = factory.getWebServer(getSelfInitializer());
    }
    else if (servletContext != null) {//war包启动入口
        try {
            getSelfInitializer().onStartup(servletContext);
        }
        catch (ServletException ex) {
            throw new ApplicationContextException("Cannot initialize servlet context",
                    ex);
        }
    }
    initPropertySources();
}

private org.springframework.boot.web.servlet.ServletContextInitializer getSelfInitializer() {
    return this::selfInitialize;
}
private void selfInitialize(ServletContext servletContext) throws ServletException {
    prepareWebApplicationContext(servletContext);
    registerApplicationScope(servletContext);
    WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);
    // getServletContextInitializerBeans()  会获取所有有注册的 ServletContextInitializer 实例
    for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
        beans.onStartup(servletContext);
    }
}

题外话

  1. 注解的方式注册Servlet。 3.0 以后,@WebServlet,@WebFilter,@WebListener + @ServletComponentScan
  2. Filter 的做种注册方式,详情

总结

  1. Servlet 3.0 后使整个应用更加轻量了,出去繁琐的 xml 配置,甚至可以动态配置 Servlet,Filter,Listener 等。
  2. 无论 SpringBoot 是 war 包还是 jar 启动,它最后的都是调用的 SpringApplication#run 来启动的。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容