Spring Boot如何启动嵌入式Tomcat?

简介: Spring Boot在内部启动了一个嵌入式Web容器。Tomcat是组件化设计,所以就是启动这些组件。

Spring Boot在内部启动了一个嵌入式Web容器。

Tomcat是组件化设计,所以就是启动这些组件。


Tomcat独立部署模式是通过startup脚本启动,Tomcat中的Bootstrap和Catalina会负责初始化类加载器,并解析server.xml和启动这些组件。


内嵌模式,Bootstrap和Catalina的工作由Spring Boot代劳,Spring Boot调用Tomcat API启动这些组件。

Spring Boot中Web容器相关接口

WebServer

为支持各种Web容器,Spring Boot抽象出嵌入式Web容器,定义WebServer接口:

image.pngWeb容器比如Tomcat、Jetty去实现该接口

image.png

ServletWebServerFactory

创建Web容器,返回的就是上面提到的WebServer。

public interface ServletWebServerFactory {
    WebServer getWebServer(ServletContextInitializer... initializers);
}

ServletContextInitializer入参表示ServletContext的初始化器,用于ServletContext中的一些配置:

public interface ServletContextInitializer {
    void onStartup(ServletContext servletContext) throws ServletException;
}

getWebServer会调用ServletContextInitializer#onStartup,即若想在Servlet容器启动时做一些事情,比如注册自己的Servlet,可以实现一个ServletContextInitializer,在Web容器启动时,Spring Boot会把所有实现ServletContextInitializer接口的类收集起来,统一调其onStartup。

WebServerFactoryCustomizerBeanPostProcessor

一个BeanPostProcessor,为定制化嵌入式Web容器,在postProcessBeforeInitialization过程中去寻找Spring容器中WebServerFactoryCustomizer类型的Bean,并依次调用WebServerFactoryCustomizer接口的customize方法做一些定制化。

public interface WebServerFactoryCustomizer<T extends WebServerFactory> {
    void customize(T factory);
}

创建、启动嵌入式Web容器

Spring的ApplicationContext,其抽象实现类AbstractApplicationContext#refresh

image.png

用来新建或刷新一个ApplicationContext,在refresh中会调用onRefresh,AbstractApplicationContext的子类可以重写onRefresh实现Context刷新逻辑。

因此重写 ServletWebServerApplicationContext#onRefresh 创建嵌入式Web容器:

image.png

重写onRefresh方法,调用createWebServer创建和启动Tomcat。

createWebServer

private void createWebServer() {
    // WebServer是Spring Boot抽象出来的接口,具体实现类就是不同Web容器
    WebServer webServer = this.webServer;
    ServletContext servletContext = this.getServletContext();
    // 若Web容器尚未创建
    if (webServer == null && servletContext == null) {
        // 通过Web容器工厂创建
        ServletWebServerFactory factory = this.getWebServerFactory();
        // 传入一个"SelfInitializer"
        this.webServer = factory.getWebServer(new ServletContextInitializer[]{this.getSelfInitializer()});
    } else if (servletContext != null) {
        try {
            this.getSelfInitializer().onStartup(servletContext);
        } catch (ServletException var4) {
          ...
        }
    }
    this.initPropertySources();
}

getWebServer

以Tomcat为例,主要调用Tomcat的API去创建各种组件:

public WebServer getWebServer(ServletContextInitializer... initializers) {
    // 1.实例化一个Tomcat【Server组件】
    Tomcat tomcat = new Tomcat();
    // 2. 创建一个临时目录
    File baseDir = this.baseDirectory != null ? this.baseDirectory : this.createTempDir("tomcat");
    tomcat.setBaseDir(baseDir.getAbsolutePath());
    // 3.初始化各种组件
    Connector connector = new Connector(this.protocol);
    tomcat.getService().addConnector(connector);
    this.customizeConnector(connector);
    tomcat.setConnector(connector);
    tomcat.getHost().setAutoDeploy(false);
    this.configureEngine(tomcat.getEngine());
    // 4. 创建定制版的"Context"组件
    this.prepareContext(tomcat.getHost(), initializers);
    return this.getTomcatWebServer(tomcat);
}

prepareContext的Context指Tomcat的Context组件,为控制Context组件行为,Spring Boot自定义了TomcatEmbeddedContext类,继承Tomcat的StandardContext:

image.png

注册Servlet

  • 有@RestController,为什么还要自己去注册Servlet给Tomcat?
    可能有些场景需要注册你自己写的一个Servlet提供辅助功能,与主程序分开。
  • Sprong Boot 不注册Servlet 给Tomcat 直接用 @Controller 就能实现Servlet功能是为啥呢?
    因为Sprong Boot默认给我们注册了DispatcherSetvlet。

Servlet注解

在Spring Boot启动类上加上 @ServletComponentScan 注解后,使用@WebServlet、@WebFilter、@WebListener标记的Servlet、Filter、Listener就可以自动注册到Servlet容器。

image.png

image.png

在Web应用的入口类上加上@ServletComponentScan,并且在Servlet类上加上@WebServlet,这样Spring Boot会负责将Servlet注册到内嵌的Tomcat中。

ServletRegistrationBean

Spring Boot提供了

  • ServletRegistrationBean
  • FilterRegistrationBean
  • ServletListenerRegistrationBean


分别用来注册Servlet、Filter、Listener。

假如要注册一个Servlet:

image.png

返回一个ServletRegistrationBean,并将它当作Bean注册到Spring,因此你需要把这段代码放到Spring Boot自动扫描的目录中,或者放到**@Configuration**标识的类中。

Spring会把这种类型的Bean收集起来,根据Bean里的定义向Tomcat注册Servlet。

动态注册

可以创建一个类去实现ServletContextInitializer接口,并把它注册为一个Bean,Spring Boot会负责调用这个接口的onStartup。

实现ServletContextInitializer接口的类会被spring管理,而不是被Servlet容器管理。

@Component
public class MyServletRegister implements ServletContextInitializer {
    @Override
    public void onStartup(ServletContext servletContext) {
        // Servlet 3.0规范新的API
        ServletRegistration myServlet = servletContext
                .addServlet("HelloServlet", HelloServlet.class);
        myServlet.addMapping("/hello");
        myServlet.setInitParameter("name", "Hello Servlet");
    }
}

ServletRegistrationBean也是通过ServletContextInitializer实现的,它实现了ServletContextInitializer接口。

注意到onStartup方法的参数是我们熟悉的ServletContext,可以通过调用它的addServlet方法来动态注册新的Servlet,这是Servlet 3.0以后才有的功能。

通过 ServletContextInitializer 接口可以向 Web 容器注册 Servlet,实现 ServletContextInitializer 接口的Bean被speing管理,但是在什么时机触发其onStartup()方法的呢?

通过 Tomcat 中的 ServletContainerInitializer 接口实现者,如TomcatStarter,创建tomcat时设置了该类,在tomcat启动时会触发ServletContainerInitializer实现者的onStartup()方法,在这个方法中触发ServletContextInitializer接口的onStartup()方法,如注册DispatcherServlet。

DispatcherServletRegistrationBean实现了ServletContextInitializer接口,它的作用就是向Tomcat注册DispatcherServlet,那它是在什么时候、如何被使用的呢?

prepareContext方法调用了另一个私有方法configureContext,这个方法就包括了往Tomcat的Context添加ServletContainerInitializer对象:


//

context.addServletContainerInitializer(starter, NO_CLASSES);

其中有DispatcherServletRegistrationBean。

定制Web容器

如何在Spring Boot中定制Web容器。在Spring Boot 2.0中可通过如下方式:

ConfigurableServletWebServerFactory

通用的Web容器工厂,定制Web容器通用参数:

@Component
public class MyGeneralCustomizer implements
  WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> {
    public void customize(ConfigurableServletWebServerFactory factory) {
        factory.setPort(8081);
        factory.setContextPath("/hello");
     }
}

TomcatServletWebServerFactory

通过特定Web容器工厂进一步定制。

给Tomcat增加一个Valve,这个Valve的功能是向请求头里添加traceid,用于分布式追踪。

class TraceValve extends ValveBase {
    @Override
    public void invoke(Request request, Response response) throws IOException, ServletException {
        request.getCoyoteRequest().getMimeHeaders().
        addValue("traceid").setString("1234xxxxabcd");
        Valve next = getNext();
        if (null == next) {
            return;
        }
        next.invoke(request, response);
    }
}

跟方式一类似,再添加一个定制器:

@Component
public class MyTomcatCustomizer implements
        WebServerFactoryCustomizer<TomcatServletWebServerFactory> {
    @Override
    public void customize(TomcatServletWebServerFactory factory) {
        factory.setPort(8081);
        factory.setContextPath("/hello");
        factory.addEngineValves(new TraceValve() );
    }
}

springboot默认会在8080端口提供 HTTP 服务,所以这里是一个处理HTTP协议请求的 Http11NioProtocol 实例,使用 NIO 方式处理 HTTP 协议。

Connector 对HTTP请求的接收和处理并非亲自完成,而是委托该 Http11NioProtocol protocolHandler 完成


目录
相关文章
|
11月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
1857 5
|
监控 Java 应用服务中间件
Spring Boot整合Tomcat底层源码分析
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置和起步依赖等特性,大大简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是其与Tomcat的整合。
501 1
|
前端开发 Java 应用服务中间件
从零手写实现 tomcat-08-tomcat 如何与 springboot 集成?
本文探讨了Spring Boot如何实现像普通Java程序一样通过main方法启动,关键在于Spring Boot的自动配置、内嵌Servlet容器(如Tomcat)以及`SpringApplication`类。Spring与Tomcat集成有两种方式:独立模式和嵌入式模式,两者通过Servlet规范、Spring MVC协同工作。Spring和Tomcat的生命周期同步涉及启动、运行和关闭阶段,通过事件和监听器实现。文章鼓励读者从实现Tomcat中学习资源管理和生命周期管理。此外,推荐了Netty权威指南系列文章,并提到了一个名为mini-cat的简易Tomcat实现项目。
|
监控 前端开发 Java
SpringBoot集成Tomcat、DispatcherServlet
通过这些配置,您可以充分利用 Spring Boot 内置的功能,快速构建和优化您的 Web 应用。
1329 21
|
Java 应用服务中间件 Maven
idea+maven+tomcat+spring 创建一个jsp项目
这篇文章介绍了如何在IntelliJ IDEA中使用Maven和Tomcat创建一个JSP项目,包括配置Maven依赖、设置Tomcat服务器、编写JSP页面、创建控制器和配置文件,以及项目的运行结果。
1286 0
idea+maven+tomcat+spring 创建一个jsp项目
|
Java 测试技术 数据库连接
Spring Boot中的嵌入式数据库使用
Spring Boot中的嵌入式数据库使用
|
前端开发 Java 应用服务中间件
Spring框架第六章(SpringMVC概括及基于JDK21与Tomcat10创建SpringMVC程序)
Spring框架第六章(SpringMVC概括及基于JDK21与Tomcat10创建SpringMVC程序)
|
前端开发 Java 应用服务中间件
Spring Boot 2.x 嵌入式 Servlet 容器
Spring Boot使用内嵌Tomcat,默认端口8080,可通过`application.properties`配置端口、上下文路径等。配置方式有两种:1) 直接在配置文件中添加`server.port`和`server.servlet.context-path`;2) 创建`WebServerFactoryCustomizer` Bean来自定义配置,如设置端口`factory.setPort(8083)`,这种方式优先级更高。
544 0
|
XML Java 应用服务中间件
springboot定制嵌入式的servlet
SpringBoot允许定制嵌入式Servlet容器,如修改配置或更换默认的Tomcat。配置可通过`application.properties`设置`server.port`和`server.tomcat.*`属性。此外,可创建`EmbeddedServletContainerCustomizer` Bean来自定义容器,例如改变端口。要替换默认的Tomcat,需排除`spring-boot-starter-tomcat`依赖,并引入`spring-boot-starter-jetty`。
339 0
|
Java 应用服务中间件 网络安全
Spring Boot中的嵌入式服务器配置
Spring Boot中的嵌入式服务器配置