Tomcat如何配置和優(yōu)化,并不是每個(gè)工程師都需要掌握的內(nèi)容。但如果你想成為一個(gè)架構(gòu)師,就必須要學(xué)會(huì)本文的人內(nèi)容了。在conf目錄下存放著Tomcat的所有配置文件,而server.xml是其中最為重要的一個(gè),server.xml的每個(gè)元素都對應(yīng)了Tomcat中的一個(gè)組件;通過元素的配置,可以實(shí)現(xiàn)對Tomcat中各個(gè)組件的控制。
1.server.xml的整體結(jié)構(gòu)
<Server> <Service> <Connector /> <Connector /> <Engine> <Host> <Context /> </Host> </Engine> </Service> </Server>
該結(jié)構(gòu)只是給出了Tomcat的核心組件,除了核心組件外,Tomcat還有一些其他組件。下面我們一一學(xué)習(xí)。
2.元素分類
(1)頂層元素:<Server></Server>
<Server>元素是整個(gè)配置文件的根元素,<Server>元素代表一個(gè)Engine元素以及一組與之相連的Connector元素。
(2)連接器:<Connector>
<Connector>代表了外部客戶端發(fā)送請求到特定Service的接口;也是外部客戶端從特定Service接收響應(yīng)的接口。
(3)容器:<Engine><Host><Context>
容器的功能時(shí)處理Connector接收進(jìn)來的請求,并產(chǎn)生相應(yīng)的響應(yīng)。Engine包含Host,Host包含Context。一個(gè)Engine組件可以處理Service中的所有請求,一個(gè)Host組件可以處理發(fā)向一個(gè)特定虛擬主機(jī)的所有請求,一個(gè)Context組件可以處理一個(gè)特定Web應(yīng)用的所有請求。
3.核心組件
(1)Server
Server元素在最頂層,代表整個(gè)Tomcat容器,因此他必須是server.xml中唯一一個(gè)最外層的元素。一個(gè)Server元素可以有一個(gè)或多個(gè)Service元素。
<Server port="8005" shutdown="SHUTDOWN"> </Server>
可以看到,最外層有一個(gè)<Server>元素,shutdown屬性表示關(guān)閉Server的指令;port屬性表示Server接收shutdown指令的端口號(hào),設(shè)置為-1可以禁掉該端口。
Server的主要任務(wù),就是提供一個(gè)接口讓客戶端能夠訪問到這個(gè)Service集合,同時(shí)維護(hù)它所包含的所有的Service的生命周期,包含如何初始化,如何結(jié)束服務(wù),如何找到客戶端要訪問的Service。
(2)Service
service的作用,是在Connector和Engine外面包一層,把它們組合在一起,對外提供服務(wù)。一個(gè)Service可以包含多個(gè)Connector,但是只能包含一個(gè)Engine;其中Connector的作用是從客戶端接收請求,Engine的作用是處理接收進(jìn)來的請求。
<Server port="8005" shutdown="SHUTDOWN"> <Service name="Catalina"> </Service> </Server>
如上圖,Server中包含一個(gè)名稱為“Catalina”的Service。實(shí)際上,Tomcat可以提供多個(gè)Service,不同的Service監(jiān)聽不同的端口。
(3)Connector
Connector的主要功能,是接收連接請求,創(chuàng)建Request和Response對象用于和客戶端交換數(shù)據(jù);然后分配線程讓Engine來處理這個(gè)請求,并把產(chǎn)生的Request和Response對象傳給Engine。
通過配置Connector,可以控制請求Service的協(xié)議及端口號(hào)。
<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>
通過配置第一個(gè)Connector,客戶端可以通過8080端口號(hào)協(xié)議訪問tomcat。其中,protocol屬性規(guī)定了請求的協(xié)議,port規(guī)定了請求的端口號(hào),redirectPort表示當(dāng)強(qiáng)制要求https而請求是http時(shí),重定向至端口號(hào)為8443的Connector,connectionTimeout表示連接的超時(shí)時(shí)間。
在這個(gè)例子中,Tomcat監(jiān)聽Http請求,使用的是8080端口,而不是正式的80端口;實(shí)際上,在生產(chǎn)環(huán)境中,Tomcat也常常監(jiān)聽8080端口。而不是80端口。這是因?yàn)樵谏a(chǎn)環(huán)境中,很少講Tomcat直接對外開放接收請求,而是在Tomcat和客戶端之間加一層代理服務(wù)器(如Nginx),用于請求的轉(zhuǎn)發(fā)、負(fù)載均衡、處理靜態(tài)文件等;通過代理服務(wù)器訪問Tomcat時(shí),是在局域網(wǎng)中,因?yàn)橐话闳允褂?080端口。
第二個(gè)配置Connector,客戶端可以通過8009端口使用AJP協(xié)議訪問Tomcat。AJP協(xié)議負(fù)責(zé)和其他的Http服務(wù)器(如Apache)建立連接;在把Tomcat與其他服務(wù)器集成時(shí),就需要用到這個(gè)連接器,之所以使用Tomcat和其他服務(wù)器集成,是因?yàn)門omcat可以用作Servlet/JSP容器,但是對靜態(tài)資源處理速度較慢,不如Apache和IIS等HTTP服務(wù)器;因此常常將Tomcat和Apache等集成,前者做Servlet容器,后者處理靜態(tài)資源,而AJP協(xié)議便負(fù)責(zé)Tomcat與Apache的連接。Tomcat和Apache等集成的原理如下圖:
Tomcat與Apache整合
4.Engine
Engine組件在Service組件有且只有一個(gè);Engine是service組件中的請求處理組件。Engine組件從一個(gè)或多個(gè)Connector中接收并處理,并將完成的響應(yīng)返回給Connector,最終傳遞給客戶端。
前面說到,Engine、Host和Context都是容器,但是它們不是平行關(guān)系,而是父子關(guān)系: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屬性用于日志和錯(cuò)誤信息,在整個(gè)Server中應(yīng)該是唯一的。defalutHost屬性指定了默認(rèn)的host名稱,當(dāng)發(fā)往本機(jī)的請求指定的host名稱不存在時(shí),一律使用defaultHost指定的host進(jìn)行處理;因此defaultHost的值,必須與Engine中的一個(gè)Host組件的name屬性值匹配。
5. Host
(1)Engine和Host
Host是Engine的子容器。Engine組件中可以內(nèi)嵌1個(gè)或者多個(gè)Host組件,每個(gè)Host組件代表Engine中的一個(gè)虛擬主機(jī)。Host組件至少有一個(gè),且其中一個(gè)的name必須與Engine組件中的defaultHost屬性相匹配。
(2)Host的作用
Host虛擬主機(jī)的作用,是運(yùn)行多個(gè)Web應(yīng)用(一個(gè)Context代表一個(gè)Web應(yīng)用),并負(fù)責(zé)安裝、展開、啟動(dòng)、結(jié)束每個(gè)Web應(yīng)用。
Host組件代表的虛擬主機(jī),對應(yīng)服務(wù)器中一個(gè)網(wǎng)絡(luò)名實(shí)體(如"www.test.com"或IP地址"116.25.25.25");為了使用戶可以通過網(wǎng)絡(luò)名連接Tomcat服務(wù)器,這個(gè)名字應(yīng)該在DNS服務(wù)器上注冊。
客戶端通常使用主機(jī)名來標(biāo)識(shí)它們希望連接的服務(wù)器,該主機(jī)名也會(huì)包含在HTTP請求頭中,Tomcat從HTTP頭中提取出主機(jī)名,尋找名字匹配的主機(jī)。如果沒有匹配,請求會(huì)發(fā)送至默認(rèn)的主機(jī)。因此默認(rèn)主機(jī)不需要再DNS服務(wù)器中注冊網(wǎng)絡(luò)名,因?yàn)槿魏闻c所有Host名稱不匹配的請求,都會(huì)路由至默認(rèn)主機(jī)。
(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屬性指定虛擬主機(jī)的主機(jī)名,一個(gè)Engine有且只有一個(gè)Host組件的name屬性和Engine組件的defaultHost屬性相匹配;一般情況下,主機(jī)名需要是在DNS服務(wù)器中注冊網(wǎng)絡(luò)名,但是Engine指定的defaultHost不需要。
unpackWARs指定了是否將代表Web應(yīng)用的WAR文件解壓;如果是true,通過解壓后的文件結(jié)構(gòu)運(yùn)行該Web應(yīng)用,如果是false,直接使用WAR文件運(yùn)行Web應(yīng)用。
6.Context
(1)Context的作用
Context元素代表在虛擬主機(jī)上運(yùn)行的一個(gè)Web應(yīng)用。在后文中,提到Context、應(yīng)用或Web應(yīng)用,他們都代指Web應(yīng)用,每個(gè)Web應(yīng)用基于WAR文件,或WAR文件解壓后對應(yīng)的目錄(這里稱為應(yīng)用目錄)
Context是Host的子容器,每個(gè)Host都可以定義任意多的Context元素。
若是自動(dòng)部署(即autoDeploy="true"),那么server.xml配置文件中沒有Context元素的配置。這是因?yàn)門omcat開啟了自動(dòng)部署,Web應(yīng)用沒有在server.xml中配置靜態(tài)部署,而是由Tomcat通過特定的規(guī)則自動(dòng)部署。
(2)Web的自動(dòng)部署
要開啟Web應(yīng)用的自動(dòng)部署,需要配置所在的虛擬主機(jī);配置的方式就是在配置Host元素的deployOnStartup和autoDeploy屬性。如果deployOnStartup和autoDeploy設(shè)置為true,則tomcat啟動(dòng)自動(dòng)部署:當(dāng)檢測到新的Web應(yīng)用或Web應(yīng)用更新時(shí),會(huì)觸發(fā)應(yīng)用的部署(或重新部署)。二者的主要區(qū)別在于
- deployeOnStartup為true時(shí),Tomcat在啟動(dòng)時(shí)檢查Web應(yīng)用,且檢測到所有的Web應(yīng)用都視作新應(yīng)用;
- autoDeploy為true時(shí),Tomcat在運(yùn)行時(shí)定期檢查新的Web應(yīng)用或Web應(yīng)用的更新;
通過配置deployOnStartup和autoDeploy可以開啟虛擬主機(jī)自動(dòng)部署Web應(yīng)用;實(shí)際上,自動(dòng)部署依賴于檢查是否有新的或更改過的Web應(yīng)用,而Host元素中的appBase和xml配置設(shè)置了檢查web應(yīng)用更新的目錄。
其中,appBase屬性指定Web應(yīng)用所在的目錄,默認(rèn)值是webapps,這是一個(gè)相對路徑,代表Tomcat根目錄下的webapps文件夾。
xmlBase屬性指定Web應(yīng)用的XML配置文件所在的目錄,默認(rèn)值為conf/Catalina/<engine_name><engine_name>,例如上面例子中,主機(jī)localhost的xmlBase的默認(rèn)值是$TOMCAT_HOME/conf/Catalina/localhost。
(3)檢查WEB應(yīng)用更新
一個(gè)Web應(yīng)用可能包含以下文件:xml配置文件,WAR包,以及一個(gè)應(yīng)用目錄;其中XML配置文件位于xmlBase指定的目錄,WAR包和應(yīng)用目錄位于appBase指定的目錄。
Tomcat按照如下的順序進(jìn)行掃描,來檢查應(yīng)用更新:
- 掃描虛擬主機(jī)指定的xmlBase下的xml配置;
- 掃描虛擬主機(jī)指定的appBase下的WAR文件;
- 掃描虛擬主機(jī)指定的appBase下的應(yīng)用目錄;
(4)<Context>元素的配置
Context元素最重要的屬性是docBase和path,此外reloadable屬性也比較常用。
docBase指定了該Web應(yīng)用使用WAR包路徑,或應(yīng)用目錄。需要注意的是:在自動(dòng)部署場景下(配置文件位于xmlBase中),docBase不在appBase目錄中,才需要指定;如果docBase指定的WAR包或應(yīng)用目錄就在appBase中,則不需要指定。因?yàn)門omcat會(huì)自動(dòng)掃描appBase中的WAR包和應(yīng)用目錄,制定了反而造成問題。
path指定了訪問該Web應(yīng)用上下文路徑,當(dāng)請求到來時(shí),Tomcat根據(jù)Web應(yīng)用的path屬性與URL匹配程度來選擇Web應(yīng)用處理相應(yīng)請求。例如:Web應(yīng)用app1的path屬性是"/app1",Web應(yīng)用app2的path屬性是"/app2",那么請求/app1/index.html會(huì)交由app1來處理;而請求/app2/index.html會(huì)交由app2來處理。如果一個(gè)Context元素的path屬性為"",那么這個(gè)Context是虛擬主機(jī)的默認(rèn)的Web應(yīng)用;當(dāng)請求的uri與所有的path都不匹配時(shí),使用該默認(rèn)Web應(yīng)用來處理。
但是,需要注意的是,在自動(dòng)部署場景(配置文件位于xmlBase中),不能指定path屬性,path屬性由配置的文件的文件名,WAR文件的文件名或應(yīng)用目錄的名稱自動(dòng)推導(dǎo)出來。如掃描Web應(yīng)該時(shí),發(fā)現(xiàn)xmlBase目錄下的app1.xml,或appBase目錄下的app1.WAR或app1應(yīng)用目錄,則該Web用于的path屬性是"app1"。如果名稱不是app1而是ROOT,則該Web應(yīng)用時(shí)虛擬主機(jī)默認(rèn)的Web應(yīng)用,此時(shí)path屬性推導(dǎo)為""。
reloadable屬性指示tomcat是否在運(yùn)行時(shí)監(jiān)控在WEB-INF/classes和WEB-INF/lib目錄下class文件的改動(dòng)。如果值為true,那么當(dāng)class文件改動(dòng)時(shí),會(huì)重新web應(yīng)用的重新加載。在開發(fā)環(huán)境下,reloadable設(shè)置為ture便于調(diào)試;但是在生產(chǎn)環(huán)境中設(shè)置為true會(huì)給服務(wù)器帶來性能壓力,因此reloadable參數(shù)的默認(rèn)值為false。
<Context docBase="D:Program Filesapp1.war" reloadable="true"></Context>
在該例子中,docBase位于Host的appBase目錄之外;path屬性沒有指定,而是根據(jù)app1.xml自動(dòng)推導(dǎo)為"app1"。
(5)自動(dòng)部署舉例
最典型的自動(dòng)部署,就是當(dāng)我們安裝完Tomcat后,$TOMCAT_HOME/webapps目錄有如下目錄:
當(dāng)我們啟動(dòng)tomcat后,可以使用http://localhost:8080/來訪問Tomcat,其實(shí)訪問的就是ROOT對應(yīng)的Web應(yīng)用;我們也可以通過http://localhost:8080/docs來訪問docs應(yīng)用。
(6)server.xml中靜態(tài)部署Web應(yīng)用
除了自動(dòng)部署,我們也可以在server.xml通過<Context>元素部署Web應(yīng)用。靜態(tài)部署與自動(dòng)部署是可以共存的。但是靜態(tài)部署中server.xml是不可動(dòng)態(tài)重加載的資源,服務(wù)器一旦啟動(dòng),要修改這個(gè)文件,就得重啟服務(wù)器才能重新加載。
server.xml中使用Context元素配置web應(yīng)用,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)部署時(shí),docBase可以在appBase目錄下,也可以不在。
- path:靜態(tài)部署時(shí),可以顯示指定path屬性,但是仍然受到了嚴(yán)格的限制:只有當(dāng)自動(dòng)部署完全關(guān)閉(deployOnStartup和autoDeploy都為false)或docBase不在appBase中時(shí),才可以設(shè)置path屬性。在本例中,docBase不在appBase中,因此path屬性可以設(shè)置。
- reloadable:屬性用法和自動(dòng)部署相同。
思考與探討
我們在開發(fā)部署時(shí)基本上一定會(huì)碰到重復(fù)部署的問題,不知怎么就發(fā)現(xiàn)應(yīng)用被部署了兩次。下面我們來研究下怎么回事?
先說說appBase和docBase的區(qū)別
appBase:這個(gè)目錄下面的子目錄將自動(dòng)被部署為應(yīng)用,且war文件將被自動(dòng)解壓縮并部署為應(yīng)用,默認(rèn)為tomcat下webapps目錄。
docBase:指定需要關(guān)聯(lián)的項(xiàng)目自動(dòng)解壓并部署到appBase目錄下。項(xiàng)目的名稱由path屬性決定。
部署<Context path="" docBase="/app/tomcat/webapps/xxx"> 時(shí)需要注意,docBase所在的文件或者war包必須存在。否則項(xiàng)目啟動(dòng)找不到對應(yīng)的目錄。此時(shí)文件解壓到appBase目錄下,根據(jù)path屬性,決定解壓后的文件名。
若采用了<Host name="localhost" appBase="webapp" autoDeploy="true">配置,那么appBase目錄下的應(yīng)用目錄將會(huì)再次部署。此時(shí)項(xiàng)目是部署了兩遍。解決辦法,設(shè)置autoDeploy="false"。