主頁 > 後端開發 > Spring Boot如何啟動嵌入式Tomcat?

Spring Boot如何啟動嵌入式Tomcat?

2021-08-03 07:25:49 後端開發

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介面:

Web容器比如Tomcat、Jetty去實作該介面

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

用來新建或重繪一個ApplicationContext,在refresh中會呼叫onRefresh,AbstractApplicationContext的子類可以重寫onRefresh實作Context重繪邏輯,

因此重寫 ServletWebServerApplicationContext#onRefresh 創建嵌入式Web容器:

重寫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:

注冊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容器,


在Web應用的入口類上加上@ServletComponentScan,并且在Servlet類上加上@WebServlet,這樣Spring Boot會負責將Servlet注冊到內嵌的Tomcat中,

ServletRegistrationBean

Spring Boot提供了

  • ServletRegistrationBean
  • FilterRegistrationBean
  • ServletListenerRegistrationBean

分別用來注冊Servlet、Filter、Listener,
假如要注冊一個Servlet:

回傳一個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() );

    }
}

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/291462.html

標籤:java

上一篇:【leetcode刷題】18.反轉鏈表——Java版

下一篇:Python操作mysql資料庫

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more