天天看點

Tomcat conf/server.xml 配置項詳解

本文參考來源:https://blog.csdn.net/a314368439/article/details/60132783# <Server port="8005" shutdown="SHUTDOWN"> -- 屬性說明 port:指定一個端口,這個端口負責監聽關閉Tomcat的請求 shutdown:向以上端口發送的關閉伺服器的指令字元串 <Listener className="org.apache.catalina.core.AprLifecycleListener" /> <Listener className="org.apache.catalina.mbeans.ServerLifecycleListener" /> <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" /> <Listener className="org.apache.catalina.storeconfig.StoreConfigLifecycleListener"/> <GlobalNamingResources> <Environment name="simpleValue" type="java.lang.Integer" value="30"/> <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元素.元素處理在同一個<Service>中所有<Connector>元素接收到的客戶請求 --> <Service name="Catalina"> -- 屬性說明 name:Service的名稱 <!-- Connector元素: 由Connector接口定義.<Connector>元素代表與客戶程式實際互動的元件,它負責接收客戶請求,以及向客戶傳回響應結果. --> <Connector port="80" maxHttpHeaderSize="8192" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true" /> -- 屬性說明 port:伺服器連接配接器的端口号,該連接配接器将在指定端口偵聽來自用戶端的請求。 enableLookups:如果為true,則可以通過調用request.getRemoteHost()進行DNS查詢來得到遠端用戶端的實際主機名; 若為false則不進行DNS查詢,而是傳回其ip位址。 redirectPort:伺服器正在處理http請求時收到了一個SSL傳輸請求後重定向的端口号。 acceptCount:當所有可以使用的處理請求的線程都被用光時,可以放到處理隊列中的請求數,超過這個數的請求将不予處理,而傳回Connection refused錯誤。 connectionTimeout:等待逾時的時間數(以毫秒為機關)。 maxThreads:設定在監聽端口的線程的最大數目,這個值也決定了伺服器可以同時響應客戶請求的最大數目.預設值為200。 protocol:必須設定為AJP/1.3協定。 address:如果伺服器有兩個以上IP位址,該屬性可以設定端口監聽的IP位址,預設情況下,端口會監聽伺服器上所有IP位址。 minProcessors:伺服器啟動時建立的處理請求的線程數,每個請求由一個線程負責。 maxProcessors:最多可以建立的處理請求的線程數。 minSpareThreads:最小備用線程 。 maxSpareThreads:最大備用線程。 debug:日志等級。 disableUploadTimeout:禁用上傳逾時,主要用于大資料上傳時。 <Connector port="8009" enableLookups="false" redirectPort="8443" protocol="AJP/1.3" /> <!-- 負責和其他HTTP伺服器建立連接配接。在把Tomcat與其他HTTP伺服器內建時就需要用到這個連接配接器。 --> <Engine name="Catalina" defaultHost="localhost"> <!-- 屬性說明 name:對應$CATALINA_HOME/config/Catalina中的Catalina defaultHost:對應Host元素中的name屬性,也就是和$CATALINA_HOME/config/Catalina/localhost中的localhost 預設的處理請求的虛拟主機名,它至少與其中的一個Host元素的name屬性值是一樣的 debug:日志等級 --> <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/> <!-- 由Host接口定義.一個Engine元素可以包含多個<Host>元素. 每個<Host>的元素定義了一個虛拟主機.它包含了一個或多個Web應用. <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> -- 屬性說明 name:在此例中一直被強調為$CATALINA_HOME/config/Catalina/localhost中的localhost虛拟主機名 debug:是日志的調試等級 appBase:預設的應用路徑,也就是把應用放在一個目錄下,并在autoDeploy為true的情況下,可自動部署應用此路徑相對于$CATALINA_HOME/ (web applications的基本目錄) unpackWARs:設定為true,在Web應用為*.war是,解壓此WAR檔案. 如果為true,則tomcat會自動将WAR檔案解壓;否則不解壓,直接從WAR檔案中運作應用程式. autoDeploy:預設為true,表示如果有新的WEB應用放入appBase 并且Tomcat在運作的情況下,自動載入應用 <Context path="/demm" docBase="E:\\projects\\demm\\WebRoot" debug="0" reloadable="true" > </Context>

-- 屬性說明 path:通路的URI,如:http://localhost/是我的應用的根目錄,通路此應用将用:http://localhost/demm進行操作,此元素必須, 表示此web application的URL的字首,用來比對一個Context。請求的URL形式為http://localhost:8080/path/* docBase:WEB應用的目錄,此目錄必須符合Java WEB應用的規範,web application的檔案存放路徑或者是WAR檔案存放路徑。 debug:日志等級 reloadable:是否在程式有改動時重新載入,設定成true會影響性能,但可自動載入修改後的檔案, 如果為true,則Tomcat将支援熱部署,會自動檢測web application的/WEB-INF/lib和/WEB-INF/classes目錄的變化, 自動裝載新的JSP和Servlet,我們可以在不重起Tomcat的情況下改變web application --> </Host> </Engine> </Service> </Server>

二 server.xml 的整體結構   

該結構中隻給出了tomcat的核心元件,除了核心元件外,tomcat還有一些其他的元件。   server.xml 整體結構如下:

1 <Server>
 2     <Service>

 3         <Connector />
 4         <Connector />

 5         <Engine>
 6             <Host>
 7                 <Context /><!-- 現在常常使用自動部署,不推薦配置Context元素,Context小節有詳細說明 -->
 8             </Host>
 9         </Engine>

10     </Service>
11 </Server>

三 元素分類

server.xml檔案中的元素可以分為以下4類:
<1>頂層元素:<server>和<service>
  <server>元素是整個配置檔案的根元素,<service>元素則代表一個Engine元素以及一組與之相連的Connector元素。
<2>連接配接器:<Connector>
<Connector>代表了外部用戶端發送請求到特定Service的接口;同時也是外部用戶端從特定Service接收響應的接口。
<3>容器:<Engine><Host><Context>
容器的功能是處理Connector接收進來的請求,并産生相應的響應。Engine、Host和Context都是容器,
但它們不是平行的關系,而是父子關系:Engine包含Host,Host包含Context。一個Engine元件可以處理Service中的所有請求,一個Host元件可以處理發向一個特定虛拟主機的所有請求,
一個Context元件可以處理一個特定Web應用的所有請求
<4>内嵌元件:可以内嵌到容器中的元件。實際上,Server、Service、Connector、Engine、Host和Context是最重要的最核心的Tomcat元件,其他元件都可以歸為内嵌元件。

四 核心元件的介紹
<1>Server
           

Server元素在最頂層,代表整個Tomcat容器,是以它必須是server.xml中唯一一個最外層的元素。一個Server元素中可以有一個或多個Service元素。

在第一部分的例子中,在最外層有一個<Server>元素,shutdown屬性表示關閉Server的指令;port屬性表示Server接收shutdown指令的端口号,設為-1可以禁掉該端口。

Server的主要任務,就是提供一個接口讓用戶端能夠通路到這個Service集合,同時維護它所包含的所有的Service的聲明周期,包括如何初始化、如何結束服務、如何找到用戶端要通路的Service。

<2>Service

Service的作用,是在Connector和Engine外面包了一層,把它們組裝在一起,對外提供服務。一個Service可以包含多個Connector,但是隻能包含一個Engine;其中Connector的作用是從用戶端接收請求,Engine的作用是處理接收進來的請求。

<3>Connector

Connector的主要功能,是接收連接配接請求,建立Request和Response對象用于和請求端交換資料;然後配置設定線程讓Engine來處理這個請求,并把産生的Request和Response對象傳給Engine

通過配置Connector,可以控制請求Service的協定及端口号。在第一部分的例子中,Service包含兩個Connector:

1 <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
2 <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
           

(1)通過配置第1個Connector,用戶端可以通過8080端口号使用http協定通路Tomcat。其中,protocol屬性規定了請求的協定,port規定了請求的端口号,redirectPort表示當強制要求https而請求是http時,重定向至端口号為8443的Connector,connectionTimeout表示連接配接的逾時時間。

在這個例子中,Tomcat監聽HTTP請求,使用的是8080端口,而不是正式的80端口;實際上,在正式的生産環境中,Tomcat也常常監聽8080端口,而不是80端口。這是因為在生産環境中,很少将Tomcat直接對外開放接收請求,而是在Tomcat和用戶端之間加一層代理伺服器(如nginx),用于請求的轉發、負載均衡、處理靜态檔案等;通過代理伺服器通路Tomcat時,是在區域網路中,是以一般仍使用8080端口。

(2)通過配置第2個Connector,用戶端可以通過8009端口号使用AJP協定通路Tomcat。AJP協定負責和其他的HTTP伺服器(如Apache)建立連接配接;在把Tomcat與其他HTTP伺服器內建時,就需要用到這個連接配接器。之是以使用Tomcat和其他伺服器內建,是因為Tomcat可以用作Servlet/JSP容器,但是對靜态資源的處理速度較慢,不如Apache和IIS等HTTP伺服器;是以常常将Tomcat與Apache等內建,前者作Servlet容器,後者處理靜态資源,而AJP協定便負責Tomcat和Apache的連接配接。

<4>Engine
           

Engine元件在Service元件中有且隻有一個;Engine是Service元件中的請求處理元件。Engine元件從一個或多個Connector中接收請求并處理,并将完成的響應傳回給Connector,最終傳遞給用戶端。

前面已經提到過,Engine、Host和Context都是容器,但它們不是平行的關系,而是父子關系:Engine包含Host,Host包含Context。

在第一部分的例子中,Engine的配置語句如下:

1 <Engine name="Catalina" defaultHost="localhost">
           

其中,name屬性用于日志和錯誤資訊,在整個Server中應該唯一。defaultHost屬性指定了預設的host名稱,當發往本機的請求指定的host名稱不存在時,一律使用defaultHost指定的host進行處理;是以,defaultHost的值,必須與Engine中的一個Host元件的name屬性值比對。

<5>Host
           

在第一部分的例子中,Host的配置如下:

1 <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">
           
下面對其中配置的屬性進行說明:
           

name屬性指定虛拟主機的主機名,一個Engine中有且僅有一個Host元件的name屬性與Engine元件的defaultHost屬性相比對;一般情況下,主機名需要是在DNS伺服器中注冊的網絡名,但是Engine指定的defaultHost不需要,原因在前面已經說明。

unpackWARs指定了是否将代表Web應用的WAR檔案解壓;如果為true,通過解壓後的檔案結構運作該Web應用,如果為false,直接使用WAR檔案運作Web應用。

Host的autoDeploy和appBase屬性,與Host内Web應用的自動部署有關;此外,本例中沒有出現的xmlBase和deployOnStartup屬性,也與Web應用的自動部署有關;将在下一節(Context)中介紹。

(1)Context的作用

Context元素代表在特定虛拟主機上運作的一個Web應用。在後文中,提到Context、應用或Web應用,它們指代的都是Web應用。每個Web應用基于WAR檔案,或WAR檔案解壓後對應的目錄(這裡稱為應用目錄)。

Context是Host的子容器,每個Host中可以定義任意多的Context元素。

在第一部分的例子中,可以看到server.xml配置檔案中并沒有出現Context元素的配置。這是因為,Tomcat開啟了自動部署,Web應用沒有在server.xml中配置靜态部署,而是由Tomcat通過特定的規則自動部署。下面介紹一下Tomcat自動部署Web應用的機制。

(2)Web應用自動部署

Host的配置

要開啟Web應用的自動部署,需要配置所在的虛拟主機;配置的方式就是前面提到的Host元素的deployOnStartup和autoDeploy屬性。如果deployOnStartup和autoDeploy設定為true,則tomcat啟動自動部署:當檢測到新的Web應用或Web應用的更新時,會觸發應用的部署(或重新部署)。二者的主要差別在于,deployOnStartup為true時,Tomcat在啟動時檢查Web應用,且檢測到的所有Web應用視作新應用;autoDeploy為true時,Tomcat在運作時定期檢查新的Web應用或Web應用的更新。除此之外,二者的處理相似。

通過配置deployOnStartup和autoDeploy可以開啟虛拟主機自動部署Web應用;實際上,自動部署依賴于檢查是否有新的或更改過的Web應用,而Host元素的appBase和xmlBase設定了檢查Web應用更新的目錄。

其中,appBase屬性指定Web應用所在的目錄,預設值是webapps,這是一個相對路徑,代表Tomcat根目錄下webapps檔案夾。

xmlBase屬性指定Web應用的XML配置檔案所在的目錄,預設值為conf/<engine_name>/<host_name>,例如第一部分的例子中,主機localhost的xmlBase的預設值是$TOMCAT_HOME/conf/Catalina/localhost。

檢查Web應用更新

一個Web應用可能包括以下檔案:XML配置檔案,WAR包,以及一個應用目錄(該目錄包含Web應用的檔案結構);其中XML配置檔案位于xmlBase指定的目錄,WAR包和應用目錄位于appBase指定的目錄。

Tomcat按照如下的順序進行掃描,來檢查應用更新:

A、掃描虛拟主機指定的xmlBase下的XML配置檔案

B、掃描虛拟主機指定的appBase下的WAR檔案

C、掃描虛拟主機指定的appBase下的應用目錄

<Context>元素的配置

Context元素最重要的屬性是docBase和path,此外reloadable屬性也比較常用。

docBase指定了該Web應用使用的WAR包路徑,或應用目錄。需要注意的是,在自動部署場景下(配置檔案位于xmlBase中),docBase不在appBase目錄中,才需要指定;如果docBase指定的WAR包或應用目錄就在docBase中,則不需要指定,因為Tomcat會自動掃描appBase中的WAR包和應用目錄,指定了反而會造成問題。

path指定了通路該Web應用的上下文路徑,當請求到來時,Tomcat根據Web應用的 path屬性與URI的比對程度來選擇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應用時,發現了xmlBase目錄下的app1.xml,或appBase目錄下的app1.WAR或app1應用目錄,則該Web應用的path屬性是”app1”。如果名稱不是app1而是ROOT,則該Web應用是虛拟主機預設的Web應用,此時path屬性推導為””。

reloadable屬性訓示tomcat是否在運作時監控在WEB-INF/classes和WEB-INF/lib目錄下class檔案的改動。如果值為true,那麼當class檔案改動時,會觸發Web應用的重新加載。在開發環境下,reloadable設定為true便于調試;但是在生産環境中設定為true會給伺服器帶來性能壓力,是以reloadable參數的預設值為false。

下面來看自動部署時,xmlBase下的XML配置檔案app1.xml的例子:

1 <Context docBase="D:\Program Files\app1.war" reloadable="true"/>
           

在該例子中,docBase位于Host的appBase目錄之外;path屬性沒有指定,而是根據app1.xml自動推導為”app1”;由于是在開發環境下,是以reloadable設定為true,便于開發調試。

自動部署舉例

最典型的自動部署,就是當我們安裝完Tomcat後,$TOMCAT_HOME/webapps目錄下有如下檔案夾:

Tomcat conf/server.xml 配置項詳解

當我們啟動Tomcat後,可以使用http://localhost:8080/來通路Tomcat,其實通路的就是ROOT對應的Web應用;我們也可以通過http://localhost:8080/docs來通路docs應用,同理我們可以通路examples/host-manager/manager這幾個Web應用。

(3)server.xml中靜态部署Web應用

除了自動部署,我們也可以在server.xml中通過<context>元素靜态部署Web應用。靜态部署與自動部署是可以共存的。在實際應用中,并不推薦使用靜态部署,因為server.xml 是不可動态重加載的資源,伺服器一旦啟動了以後,要修改這個檔案,就得重新開機伺服器才能重新加載。而自動部署可以在Tomcat運作時通過定期的掃描來實作,不需要重新開機伺服器。

server.xml中使用Context元素配置Web應用,Context元素應該位于Host元素中。舉例如下:

1 <Context path="/" docBase="D:\Program Files \app1.war" reloadable="true"/>
           

docBase:靜态部署時,docBase可以在appBase目錄下,也可以不在;本例中,docBase不在appBase目錄下。

path:靜态部署時,可以顯式指定path屬性,但是仍然受到了嚴格的限制:隻有當自動部署完全關閉(deployOnStartup和autoDeploy都為false)或docBase不在appBase中時,才可以設定path屬性。在本例中,docBase不在appBase中,是以path屬性可以設定。

reloadable屬性的用法與自動部署時相同。

五 核心元件的關聯

1、整體關系

核心元件之間的整體關系,在上一部分有所介紹,這裡總結一下:

Server元素在最頂層,代表整個Tomcat容器;一個Server元素中可以有一個或多個Service元素。

Service在Connector和Engine外面包了一層,把它們組裝在一起,對外提供服務。一個Service可以包含多個Connector,但是隻能包含一個Engine;Connector接收請求,Engine處理請求。

Engine、Host和Context都是容器,且 Engine包含Host,Host包含Context。每個Host元件代表Engine中的一個虛拟主機;每個Context元件代表在特定Host上運作的一個Web應用。

2、如何确定請求由誰處理?

當請求被發送到Tomcat所在的主機時,如何确定最終哪個Web應用來處理該請求呢?

(1)根據協定和端口号標明Service和Engine

Service中的Connector元件可以接收特定端口的請求,是以,當Tomcat啟動時,Service元件就會監聽特定的端口。在第一部分的例子中,Catalina這個Service監聽了8080端口(基于HTTP協定)和8009端口(基于AJP協定)。當請求進來時,Tomcat便可以根據協定和端口号標明處理請求的Service;Service一旦標明,Engine也就确定。

通過在Server中配置多個Service,可以實作通過不同的端口号來通路同一台機器上部署的不同應用。

(2)根據域名或IP位址標明Host

Service确定後,Tomcat在Service中尋找名稱與域名/IP位址比對的Host處理該請求。如果沒有找到,則使用Engine中指定的defaultHost來處理該請求。在第一部分的例子中,由于隻有一個Host(name屬性為localhost),是以該Service/Engine的所有請求都交給該Host處理。

(3)根據URI標明Context/Web應用

這一點在Context一節有詳細的說明:Tomcat根據應用的 path屬性與URI的比對程度來選擇Web應用處理相應請求,這裡不再贅述。

(4)舉例

以請求http://localhost:8080/app1/index.html為例,首先通過協定和端口号(http和8080)標明Service;然後通過主機名(localhost)標明Host;然後通過uri(/app1/index.html)標明Web應用。

通過在Server中配置多個Service服務,可以實作通過不同的端口号來通路同一台機器上部署的不同Web應用。

在server.xml中配置多服務的方法非常簡單,分為以下幾步:

(1)複制<Service>元素,放在目前<Service>後面。

(2)修改端口号:根據需要監聽的端口号修改<Connector>元素的port屬性;必須確定該端口沒有被其他程序占用,否則Tomcat啟動時會報錯,而無法通過該端口通路Web應用。

以Win7為例,可以用如下方法找出某個端口是否被其他程序占用:netstat -aon|findstr "8081"發現8081端口被PID為2064的程序占用

(3)修改Service和Engine的name屬性

(4)修改Host的appBase屬性(如webapps2)

(5)Web應用仍然使用自動部署

(6)将要部署的Web應用(WAR包或應用目錄)拷貝到新的appBase下。

以第一部分的server.xml為例,多個Service的配置如下:

1 <?xml version='1.0' encoding='utf-8'?>
 2 <Server port="8005" shutdown="SHUTDOWN">
 3   <Listener className="org.apache.catalina.startup.VersionLoggerListener" />
 4   <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
 5   <Listener className="org.apache.catalina.core.JasperListener" />
 6   <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
 7   <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
 8   <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
 9 
10   <GlobalNamingResources>
11     <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" />
12   </GlobalNamingResources>
13 
14   <Service name="Catalina">
15     <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
16     <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
17     <Engine name="Catalina" defaultHost="localhost">
18       <Realm className="org.apache.catalina.realm.LockOutRealm">
19         <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
20                resourceName="UserDatabase"/>
21       </Realm>
22 
23       <Host name="localhost"  appBase="/opt/project/webapps" unpackWARs="true" autoDeploy="true">
24         <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".txt" pattern="%h %l %u %t &quot;%r&quot; %s %b" />
25       </Host>
26     </Engine>
27   </Service>
28 
29   <Service name="Catalina2">
30     <Connector port="8084" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
31     <Connector port="8010" protocol="AJP/1.3" redirectPort="8443" />
32     <Engine name="Catalina2" defaultHost="localhost">
33       <Realm className="org.apache.catalina.realm.LockOutRealm">
34         <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
35                resourceName="UserDatabase"/>
36       </Realm>
37 
38       <Host name="localhost"  appBase="/opt/project/webapps2" unpackWARs="true" autoDeploy="true">
39         <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".txt" pattern="%h %l %u %t &quot;%r&quot; %s %b" />
40       </Host>
41     </Engine>
42   </Service>
43 </Server>
再将原webapps下的docs目錄拷貝到webapps2中,則通過如下兩個接口都可以通路docs應用:
           

http://localhost:8080/docs/

http://localhost:8084/docs/