承接上文http://11107124.blog.51cto.com/11097124/1888311
server.xml文件時Tomcat的核心配置文件,包括Service,Engine,Realm,Value,Host等組件的相關配置信息。
[root@node1 local]# vim tomcat/conf/server.xml
<?xml version='1.0' encoding='utf-8'?>
<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.JasperListener" />
<Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
<Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
<Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
<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 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">
<Realm className="org.apache.catalina.realm.LockOutRealm">
<Realm className="org.apache.catalina.realm.UserDatabaseRealm"
resourceName="UserDatabase"/>
</Realm>
<Host name="localhost" appBase="webapps"
unpackWARs="true" autoDeploy="true">
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
prefix="localhost_access_log." suffix=".txt"
pattern="%h %l %u %t "%r" %s %b" />
</Host>
</Engine>
</Service>
</Server>
server.xml文件中可定義的元素非常多,包括Server, Service, Connector, Engine, Cluster, Host, Alias, Context, Realm, Valve, Manager, Listener, Resources, Resource, ResourceEnvRef, ResourceLink, WatchedResource, GlobalNameingResources, Store,Transaction, Channel, Membership, Transport, Member, ClusterListener等。
下面將一個個詳細介紹各個組件
1、Server組件
如上面示例文件中定義的:
<Server port=”8005” shutdown=”SHUTDOWN”>
這會讓Tomcat啓動一個server實例(Tomcat實例),通常一個JVM只能包含一個Tomcat實例;因此,一臺物理服務器上可以在啓動多個JVM的情況下在每一個JVM中啓動一個Tomcat實例,每個實例分屬於一個獨立的管理端口,這是一個頂級組件。
如上面示例中,Tomcat實例監聽在8005端口以接收shutdown命令,各Server的定義不能使用同一個端口,這意味着如果在同一個物理機上啓動了多個Server實例,必須配置它們使用不同的端口。這個端口的定義用於爲管理員提供一個關閉此實例的便捷途徑,管理員用telnet連接到8005端口執行shutdown就可以把Tomcat關掉,爲了安全建議不啓用
Server的相關屬性:
className: 用於實現此Server容器的完全限定類的名稱,默認爲 org.apache.catalina.core.StandardServer;
port: 接收shutdown指令的端口,默認僅允許通過本機訪問,默認爲8005;
shutdown:發往此Server用於實現關閉tomcat實例的命令字符串,默認爲SHUTDOWN;
2、Service組件:
Service主要用於關聯一個引擎和與此引擎相關的連接器,每個連接器通過一個特定的端口和協議(http/ajp)接收入站請求將其轉發至關聯的引擎進行處理。困此,Service要包含一個引擎(也只能包 含一個引擎)、及一個或多個連接器。
如上面示例中的定義:
<Service name=”Catalina”>
這定義了一個名爲Catalina的Service,此名字也會在產生相關的日誌信息時記錄在日誌文件當中。
Service相關的屬性:
className: 用於實現service的類名,一般默認都是 org.apache.catalina.core.StandardService。
name:此服務的名稱,默認爲Catalina;
3、Connector(連接器)組件:
進入Tomcat的請求可以根據Tomcat的工作模式分爲如下兩類:
(1)Tomcat作爲應用程序服務器:請求來自於前端的web服務器轉發,這可能是Apache, IIS, Nginx 等;
(2)Tomcat作爲獨立服務器:請求直接來自於client的web瀏覽器;
Tomcat應該考慮工作情形併爲相應情形下的請求分別定義好需要的連接器才能正確接收來自於客戶端的請求。一個引擎可以有一個或多個連接器,以適應多種請求方式。
定義連接器可以使用多種屬性,有些屬性也只適用於某特定的連接器類型。一般說來,常見於server.xml中的連接器類型通常有4種:
1) HTTP連接器
2) SSL連接器
3) AJP 1.3連接器
4) proxy連接器
如上面示例server.xml中定義的HTTP連接器:
<Connector port="8080" protocol="HTTP/1.1"
maxThreads="150" connectionTimeout="20000"
redirectPort="8443"/>
定義連接器時可以配置的屬性非常多,但通常定義HTTP連接器時必須定義的屬性只有“port”,定義AJP連接器時必須定義的屬性只有"protocol",因爲默認的協議爲HTTP。以下爲常用屬性的說明:
1) address:指定連接器監聽的地址,默認爲所有地址,即0.0.0.0;
2) maxThreads:支持的最大併發連接數,默認爲200;
3) port:監聽的端口,默認爲0;
4) protocol:連接器使用的協議,默認爲HTTP/1.1,定義AJP協議時通常爲AJP/1.3;
5) redirectPort:如果某連接器支持的協議是HTTP,當接收客戶端發來的HTTPS請求時,則轉發至此屬 性定義的端口;
6) connectionTimeout:等待客戶端發送請求的超時時間,單位爲毫秒,默認爲60000,即1分鐘;
7) enableLookups:是否通過request.getRemoteHost()進行DNS查詢以獲取客戶端的主機名;默認爲 true(可以false掉);
8) acceptCount:設置等待隊列的最大長度;通常在tomcat所有處理線程均處於繁忙狀態時,新發來的 請求將被放置於等待隊列中;
下面是一個定義了多個屬性的SSL連接器:
<Connector port="8443"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" acceptCount="100" debug="0" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" />
4、Engine組件:
Engine是Servlet處理器的一個實例,即servlet引擎,默認爲定義在server.xml中的Catalina。Engine需要defaultHost屬性來爲其定義一個接收所有發往非明確定義虛擬主機的請求的host組件(因爲一個Engine中可以有多個虛擬主機,當用戶請求了一個不存在的主機時,這時一般要爲引擎指定一個默認的虛擬主機;每一個虛擬主機都可以是一個獨立的網站)。
如前面示例中定義的:
<Engine name="Catalina" defaultHost="localhost">
常用的屬性定義:
defaultHost:Tomcat支持基於FQDN(Fully Qualified Domain Name完全合格域名/全稱域名)的虛擬主 機,這些虛擬主機可以通過在Engine中定義多個不同的Host組件來實現;但如果此引擎的 連接器收到一個發往非明確定義虛擬主機的請求時則需要將此請求發往一個默認的虛擬主機進行處理,因此,在Engine中定義的多個虛擬主機的主機名稱中,至少要有一個虛擬主機的主機名稱跟defaultHost定義的主機名稱同名;
name:Engine組件的名稱,用於日誌和錯誤信息記錄時區別不同的引擎;
Engine容器中可以包含Realm、Host、Listener和Valve子容器。
5、Host組件:
位於Engine容器中用於接收和處理請求,如前面示例中的定義:
<Host name="localhost" appBase="webapps"
unpackWARs="true" autoDeploy="true"
xmlValidation="false" xmlNamespaceAware="false">
</Host>
常用屬性說明:
1) appBase:此Host的webapps目錄,即存放非歸檔的web應用程序的目錄或歸檔後的WAR文件的目錄路 徑;可以使用基於$CATALINA_HOME的相對路徑;
2) autoDeploy:在Tomcat處於運行狀態時放置於appBase目錄中的應用程序文件是否自動進行deploy; 默認爲true;
3) unpackWars:在啓用此webapps時是否對WAR格式的歸檔文件先進行展開;默認爲true;
虛擬主機定義示例:
<Engine name="Catalina" defaultHost="localhost">
<Host name="localhost" appBase="webapps">
<Context path="" docBase="ROOT"/>
<Context path="/bbs" docBase="/web/bss"
reloadable="true" crossContext="true"/>
</Host>
<Host name="mail.zxl.com" appBase="/web/mail">
<Context path="" docBase="ROOT"/>
</Host>
</Engine>
主機別名定義:
如果一個主機有兩個或兩個以上的主機名,額外的名稱均可以以別名的形式進行定義,如下:
<Host name="www.zxl.com" appBase="webapps" unpackWARs="true">
<Alias>zxl.com</Alias>
</Host>
6、Context(上下文)組件:
Context在某些意義上類似於apache中的路徑別名,一個Context定義用於標識tomcat實例中的一個Web應用程序。
如下面的定義:
<!-- Tomcat Root Context -->
<Context path="" docBase="/web/webapps"/>
<!-- buzzin webapp -->
<Context path="/bbs"
docBase="/web/threads/bbs"
reloadable="true">
</Context>
<!-- chat server -->
<Context path="/chat" docBase="/web/chat"/>
<!-- darian web -->
<Context path="/darian" docBase="darian"/>
在Tomcat中,每一個context定義也可以使用一個單獨的XML文件進行,其文件的目錄爲$CATALINA_HOME/conf/<engine name>/<host name>。可以用於Context中的XML元素有Loader,Manager,Realm,Resources和WatchedResource。
常用的屬性定義有:
1) docBase:相應的Web應用程序的存放位置;也可以使用相對路徑,起始路徑爲此Context所屬Host中appBase定義的路徑;切記,docBase的路徑名不能與相應的Host中appBase中定義的路徑名有包含關係,比如,如果appBase爲deploy,而docBase絕不能爲deploy-bbs類的名字;
2) path:相對於Web服務器根路徑而言的URI;如果爲空“”,則表示爲此webapp的根路徑;如果context定義在一個單獨的xml文件中,此屬性不需要定義;
3) reloadable:是否允許重新加載此context相關的Web應用程序的類;默認爲false;
7、Realm組件:
用於用戶的認證和授權;在配置一個應用程序時,管理員可以爲每個資源或資源組定義角色及權限,而這些訪問控制功能的生效需要通過Realm來實現;一個Realm表示一個安全上下文,它是一個授權訪問某個給定Context的用戶列表和某用戶所允許切換的角色相關定義的列表。因此,Realm就像是一個用戶和組相關的數據庫。
定義Realm時惟一必須要提供的屬性是classname,它是Realm的多個不同實現,用於表示此Realm認證的用戶及角色等認證信息的存放位置。
JAASRealm:基於Java Authintication and Authorization Service實現用戶認證;
JDBCRealm:通過JDBC訪問某關係型數據庫表實現用戶認證;
JNDIRealm:基於JNDI使用目錄服務實現認證信息的獲取;
MemoryRealm:查找tomcat-user.xml文件實現用戶信息的獲取;
UserDatabaseRealm:基於UserDatabase文件(通常是tomcat-user.xml)實現用戶認證,它實現是一個完全可更新和持久有效的MemoryRealm,因此能夠跟標準的MemoryRealm兼容;它通過JNDI實現;
下面是一個常見的使用UserDatabase的配置:
<Realm className=”org.apache.catalina.realm.UserDatabaseRealm”
resourceName=”UserDatabase”/>
下面是一個使用JDBC方式獲取用戶認證信息的配置:
<Realm className="org.apache.catalina.realm.JDBCRealm" debug="99"
driverName="org.gjt.mm.mysql.Driver"
connectionURL="jdbc:mysql://localhost/authority"
connectionName="test" connectionPassword="test"
userTable="users" userNameCol="user_name"
userCredCol="user_pass"
userRoleTable="user_roles" roleNameCol="role_name" />
8、Valve組件:
Valve常被用來記錄客戶端請求、客戶端IP地址和服務器等信息,Valve類似於過濾器,它可以工作於Engine和Host/Context之間、Host和Context之間以及Context和Web應用程序的某資源之間。
一個容器內可以建立多個Valve,而且Valve定義的次序也決定了它們生效的次序。Tomcat中實現了多種不同的Valve:
AccessLogValve:訪問日誌Valve
ExtendedAccessValve:擴展功能的訪問日誌Valve
JDBCAccessLogValve:通過JDBC將訪問日誌信息發送到數據庫中;
RequestDumperValve:請求轉儲Valve;
RemoteAddrValve:基於遠程地址的訪問控制;
RemoteHostValve:基於遠程主機名稱的訪問控制;
SemaphoreValve:用於控制Tomcat主機上任何容器上的併發訪問數量;
JvmRouteBinderValve:在配置多個Tomcat並以Apache通過mod_proxy或mod_jk作爲前端的集羣架構中,當期望停止某節點時,可以通過此Valve將用求請求定向至備用節點;使用此Valve,必須使用JvmRouteSessionIDBinderListener;
ReplicationValve:專用於Tomcat集羣架構中,可以在某個請求的session信息發生更改時觸發session數據在各節點間進行復制;
SingleSignOn:將兩個或多個需要對用戶進行認證webapp在認證用戶時連接在一起,即一次認證即可訪問所有連接在一起的webapp;
ClusterSingleSingOn:對SingleSignOn的擴展,專用於Tomcat集羣當中,需要結合ClusterSingleSignOnListener進行工作;
RemoteHostValve和RemoteAddrValve可以分別用來實現基於主機名稱和基於IP地址的訪問控制,控制本身可以通過allow或deny來進行定義,這有點類似於Apache的訪問控制功能;如下面的Valve則實現了僅允許本機訪問/probe:
<Context path="/probe" docBase="probe">
<Valve className="org.apache.catalina.valves.RemoteAddrValve"
allow="127\.0\.0\.1"/>
</Context>
其中相關屬性定義有:
1) className:相關的java實現的類名,相應於分別應該爲org.apache.catalina.valves.RemoteHostValve或org.apache.catalina.valves.RemoteAddrValve;
2) allow:以逗號分開的允許訪問的IP地址列表,支持正則表達式,因此,點號“.”用於IP地址時需要轉義;僅定義allow項時,非明確allow的地址均被deny;
3) deny: 以逗號分開的禁止訪問的IP地址列表,支持正則表達式;使用方式同allow;
9、GlobalNamingResources
應用於整個服務器的JNDI映射,此可以避免每個Web應用程序都需要在各自的web.xml創建,這在web應用程序以WAR的形式存在時尤爲有用。它通常可以包含三個子元素:
1) Environment;
2) Resource;
3) ResourceEnvRef;
下面是一些不常用的元素定義
10、WatchedResource
WatchedResource可以用於Context中監視指定的webapp程序文件的改變,並且能夠在監視到文件內容發生改變時重新裝載此文件。
11、Listener
Listener用於創建和配置LifecycleListener對象,而LifecycleListener通常被開發人員用來創建和刪除容器。
12、Loader
Java的動態裝載功能是其語言功能強大表現之一,Servlet容器使用此功能在運行時動態裝載servlet和它們所依賴的類。Loader可以用於Context中控制java類的加載。
13、Manager
Manger對象用於實現HTTP會話管理的功能,Tomcat6中有5種Manger的實現:
1) StandardManager
Tomcat6的默認會話管理器,用於非集羣環境中對單個處於運行狀態的Tomcat實例會話進行管理。當Tomcat關閉時,這些會話相關的數據會被寫入磁盤上的一個名叫SESSION.ser的文件,並在Tomcat下次啓動時讀取此文件。
2) PersistentManager
當一個會話長時間處於空閒狀態時會被寫入到swap會話對象,這對於內存資源比較吃緊的應用環境來說比較有用。
3)DeltaManager
用於Tomcat集羣的會話管理器,它通過將改變了會話數據同步給集羣中的其它節點實現會話複製。這種實現會將所有會話的改變同步給集羣中的每一個節點,也是在集羣環境中用得最多的一種實現方式。
4) BackupManager
用於Tomcat集羣的會話管理器,與DeltaManager不同的是,某節點會話的改變只會同步給集羣中的另一個而非所有節點。
5)SimpleTcpReplicationManager
Tomcat4時用到的版本,過於老舊了。
14、Stores
PersistentManager必須包含一個Store元素以指定將會話數據存儲至何處。這通常有兩種實現方式:FileStore和JDBCStore。
15、Resources
經常用於實現在Context中指定需要裝載的但不在Tomcat本地磁盤上的應用資源,如Java類,HTML頁面,JSP文件等。
16、Cluster
專用於配置Tomcat集羣的元素,可用於Engine和Host容器中。在用於Engine容器中時,Engine中的所有Host均支持集羣功能。在Cluster元素中,需要直接定義一個Manager元素,這個Manager元素有一個其值爲org.apache.catalina.ha.session.DeltaManager或org.apache.catalina.ha.session.BackupManager的className屬性。同時,Cluster中還需要分別定義一個Channel和ClusterListener元素。
(1)Channel
用於Cluster中給集羣中同一組中的節點定義通信“信道”。Channel中需要至少定義Membership、Receiver和Sender三個元素,此外還有一個可選元素Interceptor。
(2)Membership
用於Channel中配置同一通信信道上節點集羣組中的成員情況,即監控加入當前集羣組中的節點並在各節點間傳遞心跳信息,而且可以在接收不到某成員的心跳信息時將其從集羣節點中移除。Tomcat6中Membership的實現是org.apache.catalina.tribes.membership.McastService。
(3)Sender
用於Channel中配置“複製信息”的發送器,實現發送需要同步給其它節點的數據至集羣中的其它節點。發送器不需要屬性的定義,但可以在其內部定義一個Transport元素。
(4)Transport
用於Sender內部,配置數據如何發送至集羣中的其它節點。Tomcat6有兩種Transport的實現:
1. PooledMultiSender
基於Java阻塞式IO,可以將一次將多個信息併發發送至其它節點,但一次只能傳送給一個節點。
2. PooledParallelSener
基於Java非阻塞式IO,即NIO,可以一次發送多個信息至一個或多個節點。
(5)Receiver
用於Channel定義某節點如何從其它節點的Sender接收復制數據,Tomcat6中實現的接收方式有兩種BioReceiver和NioReceiver。