Tomcat如何配置和優(yōu)化,并不是每個工程師都需要掌握的內容。但如果你想成為一個架構師,就必須要學會本文的人內容了。在conf目錄下存放著Tomcat的所有配置文件,而server.xml是其中最為重要的一個,server.xml的每個元素都對應了Tomcat中的一個組件;通過元素的配置,可以實現(xiàn)對Tomcat中各個組件的控制。
1.server.xml的整體結構
<Server> <Service> <Connector /> <Connector /> <Engine> <Host> <Context /> </Host> </Engine> </Service> </Server>
該結構只是給出了Tomcat的核心組件,除了核心組件外,Tomcat還有一些其他組件。下面我們一一學習。
2.元素分類
(1)頂層元素:<Server></Server>
<Server>元素是整個配置文件的根元素,<Server>元素代表一個Engine元素以及一組與之相連的Connector元素。
(2)連接器:<Connector>
<Connector>代表了外部客戶端發(fā)送請求到特定Service的接口;也是外部客戶端從特定Service接收響應的接口。
(3)容器:<Engine><Host><Context>
容器的功能時處理Connector接收進來的請求,并產(chǎn)生相應的響應。Engine包含Host,Host包含Context。一個Engine組件可以處理Service中的所有請求,一個Host組件可以處理發(fā)向一個特定虛擬主機的所有請求,一個Context組件可以處理一個特定Web應用的所有請求。
3.核心組件
(1)Server
Server元素在最頂層,代表整個Tomcat容器,因此他必須是server.xml中唯一一個最外層的元素。一個Server元素可以有一個或多個Service元素。
<Server port="8005" shutdown="SHUTDOWN"> </Server>
可以看到,最外層有一個<Server>元素,shutdown屬性表示關閉Server的指令;port屬性表示Server接收shutdown指令的端口號,設置為-1可以禁掉該端口。
Server的主要任務,就是提供一個接口讓客戶端能夠訪問到這個Service集合,同時維護它所包含的所有的Service的生命周期,包含如何初始化,如何結束服務,如何找到客戶端要訪問的Service。
(2)Service
service的作用,是在Connector和Engine外面包一層,把它們組合在一起,對外提供服務。一個Service可以包含多個Connector,但是只能包含一個Engine;其中Connector的作用是從客戶端接收請求,Engine的作用是處理接收進來的請求。
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> </Service> </Server>
如上圖,Server中包含一個名稱為“Catalina”的Service。實際上,Tomcat可以提供多個Service,不同的Service監(jiān)聽不同的端口。
(3)Connector
Connector的主要功能,是接收連接請求,創(chuàng)建Request和Response對象用于和客戶端交換數(shù)據(jù);然后分配線程讓Engine來處理這個請求,并把產(chǎn)生的Request和Response對象傳給Engine。
通過配置Connector,可以控制請求Service的協(xié)議及端口號。
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" /> <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> </Service> </Server>
通過配置第一個Connector,客戶端可以通過8080端口號協(xié)議訪問tomcat。其中,protocol屬性規(guī)定了請求的協(xié)議,port規(guī)定了請求的端口號,redirectPort表示當強制要求https而請求是http時,重定向至端口號為8443的Connector,connectionTimeout表示連接的超時時間。
在這個例子中,Tomcat監(jiān)聽Http請求,使用的是8080端口,而不是正式的80端口;實際上,在生產(chǎn)環(huán)境中,Tomcat也常常監(jiān)聽8080端口。而不是80端口。這是因為在生產(chǎn)環(huán)境中,很少講Tomcat直接對外開放接收請求,而是在Tomcat和客戶端之間加一層代理服務器(如Nginx),用于請求的轉發(fā)、負載均衡、處理靜態(tài)文件等;通過代理服務器訪問Tomcat時,是在局域網(wǎng)中,因為一般仍使用8080端口。
第二個配置Connector,客戶端可以通過8009端口使用AJP協(xié)議訪問Tomcat。AJP協(xié)議負責和其他的Http服務器(如Apache)建立連接;在把Tomcat與其他服務器集成時,就需要用到這個連接器,之所以使用Tomcat和其他服務器集成,是因為Tomcat可以用作Servlet/JSP容器,但是對靜態(tài)資源處理速度較慢,不如Apache和IIS等HTTP服務器;因此常常將Tomcat和Apache等集成,前者做Servlet容器,后者處理靜態(tài)資源,而AJP協(xié)議便負責Tomcat與Apache的連接。Tomcat和Apache等集成的原理如下圖:

Tomcat與Apache整合
4.Engine
Engine組件在Service組件有且只有一個;Engine是service組件中的請求處理組件。Engine組件從一個或多個Connector中接收并處理,并將完成的響應返回給Connector,最終傳遞給客戶端。
前面說到,Engine、Host和Context都是容器,但是它們不是平行關系,而是父子關系:Engine包含Host,Host包含Context。
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" /> <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> <Engine name="Catalina" defaultHost="localhost"> </Engine> </Service> </Server>
其中name屬性用于日志和錯誤信息,在整個Server中應該是唯一的。defalutHost屬性指定了默認的host名稱,當發(fā)往本機的請求指定的host名稱不存在時,一律使用defaultHost指定的host進行處理;因此defaultHost的值,必須與Engine中的一個Host組件的name屬性值匹配。
5. Host
(1)Engine和Host
Host是Engine的子容器。Engine組件中可以內嵌1個或者多個Host組件,每個Host組件代表Engine中的一個虛擬主機。Host組件至少有一個,且其中一個的name必須與Engine組件中的defaultHost屬性相匹配。
(2)Host的作用
Host虛擬主機的作用,是運行多個Web應用(一個Context代表一個Web應用),并負責安裝、展開、啟動、結束每個Web應用。
Host組件代表的虛擬主機,對應服務器中一個網(wǎng)絡名實體(如"www.test.com"或IP地址"116.25.25.25");為了使用戶可以通過網(wǎng)絡名連接Tomcat服務器,這個名字應該在DNS服務器上注冊。
客戶端通常使用主機名來標識它們希望連接的服務器,該主機名也會包含在HTTP請求頭中,Tomcat從HTTP頭中提取出主機名,尋找名字匹配的主機。如果沒有匹配,請求會發(fā)送至默認的主機。因此默認主機不需要再DNS服務器中注冊網(wǎng)絡名,因為任何與所有Host名稱不匹配的請求,都會路由至默認主機。
(3)Host的配置
在第一部分的例子中,Host配置如下:
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" /> <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> <Engine name="Catalina" defaultHost="localhost"> <Host name="localhost" AppBase="webapps" unpackWARs="true" autoDeploy="true"> </Host> </Engine> </Service> </Server>
name屬性指定虛擬主機的主機名,一個Engine有且只有一個Host組件的name屬性和Engine組件的defaultHost屬性相匹配;一般情況下,主機名需要是在DNS服務器中注冊網(wǎng)絡名,但是Engine指定的defaultHost不需要。
unpackWARs指定了是否將代表Web應用的WAR文件解壓;如果是true,通過解壓后的文件結構運行該Web應用,如果是false,直接使用WAR文件運行Web應用。
6.Context
(1)Context的作用
Context元素代表在虛擬主機上運行的一個Web應用。在后文中,提到Context、應用或Web應用,他們都代指Web應用,每個Web應用基于WAR文件,或WAR文件解壓后對應的目錄(這里稱為應用目錄)
Context是Host的子容器,每個Host都可以定義任意多的Context元素。
若是自動部署(即autoDeploy="true"),那么server.xml配置文件中沒有Context元素的配置。這是因為Tomcat開啟了自動部署,Web應用沒有在server.xml中配置靜態(tài)部署,而是由Tomcat通過特定的規(guī)則自動部署。
(2)Web的自動部署
要開啟Web應用的自動部署,需要配置所在的虛擬主機;配置的方式就是在配置Host元素的deployOnStartup和autoDeploy屬性。如果deployOnStartup和autoDeploy設置為true,則tomcat啟動自動部署:當檢測到新的Web應用或Web應用更新時,會觸發(fā)應用的部署(或重新部署)。二者的主要區(qū)別在于
- deployeOnStartup為true時,Tomcat在啟動時檢查Web應用,且檢測到所有的Web應用都視作新應用;
- autoDeploy為true時,Tomcat在運行時定期檢查新的Web應用或Web應用的更新;
通過配置deployOnStartup和autoDeploy可以開啟虛擬主機自動部署Web應用;實際上,自動部署依賴于檢查是否有新的或更改過的Web應用,而Host元素中的appBase和xml配置設置了檢查web應用更新的目錄。
其中,appBase屬性指定Web應用所在的目錄,默認值是webapps,這是一個相對路徑,代表Tomcat根目錄下的webapps文件夾。
xmlBase屬性指定Web應用的XML配置文件所在的目錄,默認值為conf/Catalina/<engine_name><engine_name>,例如上面例子中,主機localhost的xmlBase的默認值是$TOMCAT_HOME/conf/Catalina/localhost。
(3)檢查WEB應用更新
一個Web應用可能包含以下文件:xml配置文件,WAR包,以及一個應用目錄;其中XML配置文件位于xmlBase指定的目錄,WAR包和應用目錄位于appBase指定的目錄。
Tomcat按照如下的順序進行掃描,來檢查應用更新:
- 掃描虛擬主機指定的xmlBase下的xml配置;
- 掃描虛擬主機指定的appBase下的WAR文件;
- 掃描虛擬主機指定的appBase下的應用目錄;
(4)<Context>元素的配置
Context元素最重要的屬性是docBase和path,此外reloadable屬性也比較常用。
docBase指定了該Web應用使用WAR包路徑,或應用目錄。需要注意的是:在自動部署場景下(配置文件位于xmlBase中),docBase不在appBase目錄中,才需要指定;如果docBase指定的WAR包或應用目錄就在appBase中,則不需要指定。因為Tomcat會自動掃描appBase中的WAR包和應用目錄,制定了反而造成問題。
path指定了訪問該Web應用上下文路徑,當請求到來時,Tomcat根據(jù)Web應用的path屬性與URL匹配程度來選擇Web應用處理相應請求。例如:Web應用app1的path屬性是"/app1",Web應用app2的path屬性是"/app2",那么請求/app1/index.html會交由app1來處理;而請求/app2/index.html會交由app2來處理。如果一個Context元素的path屬性為"",那么這個Context是虛擬主機的默認的Web應用;當請求的uri與所有的path都不匹配時,使用該默認Web應用來處理。
但是,需要注意的是,在自動部署場景(配置文件位于xmlBase中),不能指定path屬性,path屬性由配置的文件的文件名,WAR文件的文件名或應用目錄的名稱自動推導出來。如掃描Web應該時,發(fā)現(xiàn)xmlBase目錄下的app1.xml,或appBase目錄下的app1.WAR或app1應用目錄,則該Web用于的path屬性是"app1"。如果名稱不是app1而是ROOT,則該Web應用時虛擬主機默認的Web應用,此時path屬性推導為""。
reloadable屬性指示tomcat是否在運行時監(jiān)控在WEB-INF/classes和WEB-INF/lib目錄下class文件的改動。如果值為true,那么當class文件改動時,會重新web應用的重新加載。在開發(fā)環(huán)境下,reloadable設置為ture便于調試;但是在生產(chǎn)環(huán)境中設置為true會給服務器帶來性能壓力,因此reloadable參數(shù)的默認值為false。
<Context docBase="D:Program Filesapp1.war" reloadable="true"></Context>
在該例子中,docBase位于Host的appBase目錄之外;path屬性沒有指定,而是根據(jù)app1.xml自動推導為"app1"。
(5)自動部署舉例
最典型的自動部署,就是當我們安裝完Tomcat后,$TOMCAT_HOME/webapps目錄有如下目錄:

當我們啟動tomcat后,可以使用http://localhost:8080/來訪問Tomcat,其實訪問的就是ROOT對應的Web應用;我們也可以通過http://localhost:8080/docs來訪問docs應用。
(6)server.xml中靜態(tài)部署Web應用
除了自動部署,我們也可以在server.xml通過<Context>元素部署Web應用。靜態(tài)部署與自動部署是可以共存的。但是靜態(tài)部署中server.xml是不可動態(tài)重加載的資源,服務器一旦啟動,要修改這個文件,就得重啟服務器才能重新加載。
server.xml中使用Context元素配置web應用,Context元素位于Host元素中。
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" /> <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> <Engine name="Catalina" defaultHost="localhost"> <Host name="localhost" appBase="webapp" unpackWARs="true" autoDeploy="true"> <Context path="" docBase="/app/tomcat/webapps/xxx" reloadable="true" workDir="/app/tomcat/work" ></Context> </Host> </Engine> </Service> </Server>
- docBase:靜態(tài)部署時,docBase可以在appBase目錄下,也可以不在。
- path:靜態(tài)部署時,可以顯示指定path屬性,但是仍然受到了嚴格的限制:只有當自動部署完全關閉(deployOnStartup和autoDeploy都為false)或docBase不在appBase中時,才可以設置path屬性。在本例中,docBase不在appBase中,因此path屬性可以設置。
- reloadable:屬性用法和自動部署相同。
思考與探討
我們在開發(fā)部署時基本上一定會碰到重復部署的問題,不知怎么就發(fā)現(xiàn)應用被部署了兩次。下面我們來研究下怎么回事?
先說說appBase和docBase的區(qū)別
appBase:這個目錄下面的子目錄將自動被部署為應用,且war文件將被自動解壓縮并部署為應用,默認為tomcat下webapps目錄。
docBase:指定需要關聯(lián)的項目自動解壓并部署到appBase目錄下。項目的名稱由path屬性決定。
部署<Context path="" docBase="/app/tomcat/webapps/xxx"> 時需要注意,docBase所在的文件或者war包必須存在。否則項目啟動找不到對應的目錄。此時文件解壓到appBase目錄下,根據(jù)path屬性,決定解壓后的文件名。
若采用了<Host name="localhost" appBase="webapp" autoDeploy="true">配置,那么appBase目錄下的應用目錄將會再次部署。此時項目是部署了兩遍。解決辦法,設置autoDeploy="false"。