Tomcat架構設計剖析 | 博學谷狂野架構師
Tomcat體系架構
Tomcat專案結構
bin目錄
bin目錄主要是用來存放tomcat的命令，主要有兩大類，一類是以.sh結尾的（linux命令），另一類是以.bat結尾的（windows命令）。
很多環境變數的設定都在此處，例如可以設定JDK路徑、tomcat路徑
- startup檔案：主要是檢查catalina.bat/sh 執行所需環境，並呼叫catalina.bat 批處理檔案。啟動tomcat。
- catalina檔案：真正啟動Tomcat檔案，可以在裡面設定jvm引數。後面效能調優會重點講
- shutdown檔案：關閉Tomcat
- 指令碼version.sh、startup.sh、shutdown.sh、configtest.sh都是對catalina.sh的包裝，內容大同小異，差異在於功能介紹和呼叫catalina.sh時的引數不同。
- Version：檢視當前tomcat的版本號，
- Configtest：校驗tomcat配置檔案server.xml的格式、內容等是否合法、正確。
- Service：安裝tomcat服務，可用net start tomcat 啟動
conf目錄
conf目錄主要是用來存放tomcat的一些配置檔案。
- server.xml：可以設定埠號、設定域名或IP、預設載入的專案、請求編碼
- web.xml：可以設定tomcat支援的檔案型別
- context.xml：可以用來配置資料來源之類的
- tomcat-users.xml：用來配置管理tomcat的使用者與許可權
- 在Catalina目錄下可以設定預設載入的專案
server.xml
COPY<?xml version="1.0" encoding="UTF-8"?>
<!-- Server代表一個 Tomcat 例項。可以包含一個或多個 Services，其中每個Service都有自己的Engines和Connectors。
port="8005"指定一個埠，這個埠負責監聽關閉tomcat的請求
-->
<Server port="8005" shutdown="SHUTDOWN">
<!-- 監聽器 -->
<Listener className="org.apache.catalina.startup.VersionLoggerListener" />
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
<Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
<Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
<Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
<!-- 全域性命名資源，定義了UserDatabase的一個JNDI(java命名和目錄介面)，通過pathname的檔案得到一個使用者授權的記憶體資料庫 -->
<GlobalNamingResources>
<Resource name="UserDatabase" auth="Container"
type="org.apache.catalina.UserDatabase"
description="User database that can be updated and saved"
factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
pathname="conf/tomcat-users.xml" />
</GlobalNamingResources>
<!-- Service它包含一個<Engine>元素,以及一個或多個<Connector>,這些Connector元素共享用同一個Engine元素 -->
<Service name="Catalina">
<!--
每個Service可以有一個或多個聯結器<Connector>元素，
第一個Connector元素定義了一個HTTP Connector,它通過8080埠接收HTTP請求;第二個Connector元素定
義了一個JD Connector,它通過8009埠接收由其它伺服器轉發過來的請求.
-->
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
<!-- 每個Service只能有一個<Engine>元素 -->
<Engine name="Catalina" defaultHost="localhost">
<Realm className="org.apache.catalina.realm.LockOutRealm">
<Realm className="org.apache.catalina.realm.UserDatabaseRealm"
resourceName="UserDatabase"/>
</Realm>
<!-- 預設host配置，有幾個域名就配置幾個Host，但是這種只能是同一個埠號 -->
<Host name="localhost" appBase="webapps"
unpackWARs="true" autoDeploy="true">
<!-- Tomcat的訪問日誌，預設可以關閉掉它，它會在logs檔案裡生成localhost_access_log的訪問日誌 -->
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
prefix="localhost_access_log" suffix=".txt"
pattern="%h %l %u %t "%r" %s %b" />
</Host>
<Host name="www.hzg.com" appBase="webapps"
unpackWARs="true" autoDeploy="true">
<Context path="" docBase="/myweb1" />
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
prefix="hzg_access_log" suffix=".txt"
pattern="%h %l %u %t "%r" %s %b" />
</Host>
</Engine>
</Service>
</Server>
patter解釋
有效的日誌格式模式可以參見下面內容，如下字串，其對應的資訊由指定的響應內容取代：
- ％a - 遠端IP地址
- ％A - 本地IP地址
- ％b - 傳送的位元組數，不包括HTTP頭，或“ - ”如果沒有傳送位元組
- ％B - 傳送的位元組數，不包括HTTP頭
- ％h - 遠端主機名
- ％H - 請求協議
- ％l (小寫的L)- 遠端邏輯從identd的使用者名稱（總是返回’ - ‘）
- ％m - 請求方法
- ％p - 本地埠
- ％q - 查詢字串（在前面加上一個“？”如果它存在，否則是一個空字串
- ％r - 第一行的要求
- ％s - 響應的HTTP狀態程式碼
- ％S - 使用者會話ID
- ％t - 日期和時間，在通用日誌格式
- ％u - 遠端使用者身份驗證
- ％U - 請求的URL路徑
- ％v - 本地伺服器名
- ％D - 處理請求的時間（以毫秒為單位）
web.xml
Tomcat中所有應用預設的部署描述檔案，主要定義了基礎的Servlet和MIME對映(mime-mapping 檔案型別，其實就是Tomcat處理的檔案型別),如果部署的應用中不包含Web.xml，那麼Tomcat將使用此檔案初始化部署描述，反之，Tomcat會在啟動時將預設描述與定義描述配置進行合併。
載入一些tomcat內建的servlet
DefaultServlet預設的,載入靜態檔案 html,js,jpg等靜態檔案。
JspServlet專門處理jsp。
context.xml
用於自定義所有Web應用均需要載入的Context配置，如果Web應用指定了自己的context.xml，那麼該檔案的配置將被覆蓋。
context.xml與server.xml中配置context的區別
server.xml是不可動態重載入的資源，伺服器一旦啟動了以後，要修改這個檔案，就得重啟伺服器才能重新載入。而context.xml檔案則不然，tomcat伺服器會定時去掃描這個檔案。一旦發現檔案被修改（時間戳改變了），就會自動重新載入這個檔案，而不需要重啟伺服器。
catalina.policy
許可權相關 Permission ，Tomcat是跑在jvm上的，所以有些預設的許可權
tomcat-users.xml
配置Tomcat的server的manager資訊
COPY<?xml version="1.0" encoding="UTF-8"?>
<tomcat-users xmlns="http://tomcat.apache.org/xml"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://tomcat.apache.org/xml tomcat-users.xsd"
version="1.0">
<role rolename="manager-gui"/>
<user username="manager" password="manager" roles="manager-gui"/>
</tomcat-users>
logging.properties
設定tomcat日誌
控制輸出不輸出內容到檔案，不能阻止生成檔案，阻止聲檔案可用註釋掉
lib目錄
lib目錄主要用來存放tomcat執行需要載入的jar包。
例如，像連線資料庫的jdbc的包我們可以加入到lib目錄中來。
Tomcat的類庫，裡面是一大堆jar檔案。如果需要新增Tomcat依賴的jar檔案，可以把它放到這個目錄中，當然也可以把應用依賴的jar檔案放到這個目錄中，這個目錄中的jar所有專案都可以共享之，但這樣你的應用放到其他Tomcat下時就不能再共享這個目錄下的Jar包了，所以建議只把Tomcat需要的Jar包放到這個目錄下；
logs目錄
logs目錄用來存放tomcat在執行過程中產生的日誌檔案，非常重要的是在控制檯輸出的日誌。（清空不會對tomcat執行帶來影響）
這個目錄中都是日誌檔案，記錄了Tomcat啟動和關閉的資訊，如果啟動Tomcat時有錯誤，那麼異常也會記錄在日誌檔案中
在windows環境中，控制檯的輸出日誌在catalina.xxxx-xx-xx.log檔案中 在linux環境中，控制檯的輸出日誌在catalina.out檔案中
- localhost-xxx.log：Web應用的內部程式日誌，建議保留
- catalina-xxx.log：控制檯日誌
- host-manager.xxx.log：Tomcat管理頁面中的host-manager的操作日誌，建議關閉
- localhost_access_log_xxx.log：使用者請求Tomcat的訪問日誌（這個檔案在conf/server.xml裡配置），建議關閉
temp目錄
temp目錄使用者存放tomcat在執行過程中產生的臨時檔案。（清空不會對tomcat執行帶來影響）
webapps目錄
webapps目錄用來存放應用程式，當tomcat啟動時會去載入webapps目錄下的應用程式。可以以資料夾、war包、jar包的形式釋出應用。
當然，你也可以把應用程式放置在磁碟的任意位置，在配置檔案中對映好就行。
存放web專案的目錄，其中每個資料夾都是一個專案；如果這個目錄下已經存在了目錄，那麼都是tomcat自帶的。專案。其中ROOT是一個特殊的專案，在位址列中沒有給出專案目錄時，對應的就是ROOT專案。http://localhost:8080/examples，進入示例專案。其中examples就是專案名，即資料夾的名字。
work目錄
work目錄用來存放tomcat在執行時的編譯後文件，例如JSP編譯後的檔案。 清空work目錄，然後重啟tomcat，可以達到清除快取的作用。
執行時生成的檔案，最終執行的檔案都在這裡。通過webapps中的專案生成的！可以把這個目錄下的內容刪除，再次執行時會生再次生成work目錄。當客戶端使用者訪問一個JSP檔案時，Tomcat會通過JSP生成Java檔案，然後再編譯Java檔案生成class檔案，生成的java和class檔案都會存放到這個目錄下。
Tomcat元件及架構
Server
Server是最頂級的元件，它代表Tomcat的執行例項，它掌管著整個Tomcat的生死大權；
- 提供了監聽器機制，用於在Tomcat整個生命週期中對不同時間進行處理
- 提供Tomcat容器全域性的命名資源實現，JNDI
- 監聽某個埠以接受SHUTDOWN命令，用於關閉Tomcat
Service
一個概念，一個Service維護多個Connector和一個Container
它由一個或者多個Connector組成，以及一個Engine，負責處理所有Connector所獲得的客戶請求。
Connector元件
連結器：監聽轉換Socket請求，將請求交給Container處理，支援不同協議以及不同的I/O方式
TOMCAT有兩個典型的Connector，一個直接偵聽來自browser的http請求，一個偵聽來自其它WebServer的請求Coyote Http/1.1 Connector 在埠8080處偵聽來自客戶browser的http請求Coyote JK2 Connector 在埠8009處偵聽來自其它WebServer(Apache)的servlet/jsp代理請求。
Container
表示能夠執行客戶端請求並返回響應的一類物件，其中有不同級別的容器：Engine、Host、Context、Wrapper
Engine
整個Servler引擎，最高階的容器物件
Engine下可以配置多個虛擬主機Virtual Host，每個虛擬主機都有一個域名當Engine獲得一個請求時，它把該請求匹配到某個Host上，然後把該請求交給該Host來處理Engine有一個預設虛擬主機，當請求無法匹配到任何一個Host上的時候，將交給該預設Host來處理。
Host
表示Servlet引擎中的虛擬機器，主要與域名有關，一個伺服器有多個域名是可以使用多個Host
代表一個Virtual Host，虛擬主機，每個虛擬主機和某個網路域名Domain Name相匹配，每個虛擬主機下都可以部署(deploy)一個或者多個Web App，每個Web App對應於一個Context，有一個Context path當Host獲得一個請求時，將把該請求匹配到某個Context上，然後把該請求交給該Context來處理匹配的方法是“最長匹配”，所以一個path==””的Context將成為該Host的預設Context所有無法和其它Context的路徑名匹配的請求都將最終和該預設Context匹配。
Context
用於表示ServletContext,一個ServletContext表示一個獨立的Web應用
一個Context對應於一個Web Application，一個WebApplication由一個或者多個Servlet組成，Context在建立的時候將根據配置檔案$CATALINA_HOME/conf/web.xml和$WEBAPP_HOME/WEB-INF/web.xml載入Servlet類，當Context獲得請求時，將在自己的對映表(mapping table)中尋找相匹配的Servlet類。如果找到，則執行該類，獲得請求的迴應，並返回。
是Web應用的抽象，Web應用部署到Tomcat後執行時就會轉化成Context物件；包含了各種靜態資源、若干Servlet（Wrapper容器）以及各種其他動態資源；
- 包含Listener元件用以在生命週期中對Context相關的事件進行監聽；
- 包含AccessLog元件以記錄訪問日誌；
- 包含Pipeline元件用以處理請求；
- 包含Realm元件用以提供安全許可權功能；
- 包含Loader元件用以載入Web應用的資源，保證不同Web應用之間的資源隔離；
- 包含Manager元件用以管理Web容器的會話，包括維護會話的生成、更新和銷燬；
- 包含NamingResource元件將Tomcat配置檔案的server.xml和Web應用的context.xml資源和屬性對映到記憶體中；
Wrapper
用於表示Web應用中定義的Servlet
對應的是Servlet；包含Web應用開發常用的Servlet元件；包含ServletPool元件用以存放Servlet物件，當Web應用的Servlet實現了SingleThreadModel介面時則會再Wrapper中產生一個Servlet物件池，執行緒執行時，需先從物件池中獲取到一個Servlet物件，ServletPool元件能保證Servlet物件的執行緒安全；包含Pipeline元件用以處理請求。
我們從功能的角度將Tomcat原始碼分成5個子模組，它們分別是：
- Jsper子模組：這個子模組負責jsp頁面的解析、jsp屬性的驗證，同時也負責將jsp頁面動態轉換為java程式碼並編譯成class檔案。在Tomcat原始碼中，凡是屬於org.apache.jasper包及其子包中的原始碼都屬於這個子模組；
- Servlet和Jsp規範的實現模組：這個子模組的原始碼屬於javax.servlet包及其子包，如我們非常熟悉的javax.servlet.Servlet介面、javax.servet.http.HttpServlet類及javax.servlet.jsp.HttpJspPage就位於這個子模組中；
- Catalina子模組：這個子模組包含了所有以org.apache.catalina開頭的java原始碼。該子模組的任務是規範了Tomcat的總體架構，定義了Server、Service、Host、Connector、Context、Session及Cluster等關鍵元件及這些元件的實現，這個子模組大量運用了Composite設計模式。同時也規範了Catalina的啟動及停止等事件的執行流程。從程式碼閱讀的角度看，這個子模組應該是我們閱讀和學習的重點。
- Connectors子模組：如果說上面三個子模組實現了Tomcat應用伺服器的話，那麼這個子模組就是Web伺服器的實現。所謂聯結器(Connector)就是一個連線客戶和應用伺服器的橋樑，它接收使用者的請求，並把使用者請求包裝成標準的Http請求(包含協議名稱，請求頭Head，請求方法是Get還是Post等等)。同時，這個子模組還按照標準的Http協議，負責給客戶端傳送響應頁面，比如在請求頁面未發現時，connector就會給客戶端瀏覽器傳送標準的Http 404錯誤響應頁面。
- Resource子模組：這個子模組包含一些資原始檔，如Server.xml及Web.xml配置檔案。嚴格說來，這個子模組不包含java原始碼，但是它還是Tomcat編譯執行所必需的。
Executor
Tomcat元件間可以共享的執行緒池
Tomcat的併發，提供了Executor介面來表示一個可以在元件間共享的執行緒池。該介面同樣繼承LifeCycle介面
共享範圍：Executor由Service維護，因此同一個Service中的元件可以共享一個執行緒池
Tomcat的核心元件
- 解耦：網路協議與容器的解耦。
- Connector：連結器封裝了底層的網路請求(Socket請求及相應處理),提供了統一的介面，使Container容器與具體的請求協議以及I/O方式解耦。
- Connector：將Socket輸入轉換成Request物件，交給Container容器進行處理，處理請求後，Container通過Connector提供的Response物件將結果寫入輸出流。
因為無論是Request物件還是Response物件都沒有實現Servlet規範對應的介面，Container會將它們進一步分裝成ServletRequest和ServletResponse.
Tomcat的連結器
AJP主要是用於Web伺服器與Tomcat伺服器整合，AJP採用二進位制傳輸可讀性文字，使用保持永續性的TCP連結，使得AJP佔用更少的頻寬，並且連結開銷要小得多，但是由於AJP採用持久化連結，因此有效的連線數較HTTP要更多。
對於I/0選擇，要根據業務場景來定，一般高併發場景下，APR和NIO2的效能要優於NIO和BIO，（linux作業系統支援的NIO2由於是一個假的，並沒有真正實現AIO，所以一般linux上推薦使用NIO，如果是APR的話，需要安裝APR庫，而Windows上預設安裝了），所以在8.5的版本中預設是NIO。
Tomcat執行流程
假設來自客戶的請求為 http://localhost:8080/test/index.jsp
- 請求被髮送到本機埠8080，被在那裡偵聽的Coyote HTTP/1.1 Connector獲得
- Connector把該請求交給它所在的Service的Engine來處理，並等待Engine的迴應
- Engine獲得請求localhost:8080/test/index.jsp，匹配它所有虛擬主機Host
- Engine匹配到名為localhost的Host（即使匹配不到也把請求交給該Host處理，因為該Host被定義為該Engine的預設主機）
- localhost Host獲得請求/test/index.jsp，匹配它所擁有的所有Context
- Host匹配到路徑為/test的Context（如果匹配不到就把該請求交給路徑名為””的Context去處理）
- path=”/test”的Context獲得請求/index.jsp，在它的mapping table中尋找對應的servlet
- Context匹配到URL PATTERN為*.jsp的servlet，對應於JspServlet類
- 構造HttpServletRequest物件和HttpServletResponse物件，作為引數呼叫JspServlet的doGet或doPost方法
- Context把執行完了之後的HttpServletResponse物件返回給Host
- Host把HttpServletResponse物件返回給Engine
- Engine把HttpServletResponse物件返回給Connector
- Connector把HttpServletResponse物件返回給客戶browser
本文由
傳智教育博學谷狂野架構師教研團隊釋出。如果本文對您有幫助，歡迎
關注和點贊；如果您有任何建議也可留言評論或私信，您的支援是我堅持創作的動力。轉載請註明出處！
- ElasticSearch還能效能調優，漲見識、漲見識了！！！
- 【必須收藏】別再亂找TiDB 叢集部署教程了，這篇保姆級教程來幫你！！| 博學谷狂野架構師
- 【建議收藏】7000 字的TIDB保姆級簡介，你見過嗎
- Tomcat架構設計剖析 | 博學谷狂野架構師
- 你可能不那麼知道的Tomcat生命週期管理 | 博學谷狂野架構師
- 大哥，這是併發不是並行，Are You Ok？
- 為啥要重學Tomcat？| 博學谷狂野架構師
- 這是一篇純講SQL語句優化的文章！！！| 博學谷狂野架構師
- 捲起來！！！看了這篇文章我才知道MySQL事務&MVCC到底是啥？
- 為什麼99%的程式設計師都做不好SQL優化？
- 如何搞定MySQL鎖（全域性鎖、表級鎖、行級鎖）？這篇文章告訴你答案！太TMD詳細了！！！
- 【建議收藏】超詳細的Canal入門，看這篇就夠了！！！
- 從菜鳥程式設計師到高階架構師，竟然是因為這個字final
- 為什麼95%的Java程式設計師，都是用不好Synchronized？
- 99%的Java程式設計師者，都敗給這一個字！
- 8000 字，就說一個字Volatile
- 98%的程式設計師，都沒有研究過JVM重排序和順序一致性
- 來一波騷操作，Java記憶體模型
- 時隔多年，這次我終於把動態代理的原始碼翻了個地兒朝天
- 再有人問你分散式事務，把這篇文章砸過去給他