Tomcat server.xml详解

Server.xml的结构大致

<Server port="8005" shutdown="SHUTDOWN">
    <Service name="Catalina">
        <Executor ...... />
        <Connector ...... />
        <Connector ...... />
        <Engine name="Catalina" ... >
            <Host name="localhost" ... >
                <Context ... />
            </Host>
        </Engine>
    </Service>
</Server>

 即一个由 Server->Service->Engine->Host->Context 组成的四层结构，从里层向外层分别是：

Context： 即 Web 应用程序，一个 Context 即对于一个 Web 应用程序。
Host：即虚拟主机，比如 www.dog.com 对应一个虚拟主机，api.dog.com 对于另一个虚拟主机。一个 Host 用于定义一个虚拟主机。（所谓的”一个虚拟主机”可简单理解为”一个网站”）
Engine：一组虚拟主机的集合。比如www.dog.com 和 api.dog.com 可以组成一组虚拟主机集合。
Service：一组 Engine 的集合，包括线程池 Executor 和连接器 Connector 的定义。

 server.xml简单xml解释

<Server port="8005" shutdown="SHUTDOWN">
      <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>
     <!-- 定义的一个名叫“UserDatabase”的认证资源，将conf/tomcat-users.xml加载至内存中，在需要认证的时候到内存中进行认证 -->
    <Service name="Catalina">
       <!-- # 定义Service组件，同来关联Connector和Engine，一个Engine可以对应多个Connector，每个Service中只能一个Engine --!>
       <Connector port="80" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
       <!-- 修改HTTP/1.1的Connector监听端口为80.客户端通过浏览器访问的请求，只能通过HTTP传递给tomcat。  -->
       <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
       <Engine name="Catalina" defaultHost="test.com">
        　　　　<!-- 修改当前Engine，默认主机是，www.test.com  -->
        　<Realm className="org.apache.catalina.realm.LockOutRealm">
           　　 <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
       　　</Realm>
　　　　　　　　<!-- # Realm组件，定义对当前容器内的应用程序访问的认证，通过外部资源UserDatabase进行认证  --!>
　　　　　　<Host name="test.com" appBase="/web" unpackWARs="true" autoDeploy="true"> 
　　　　　　　　<!-- 定义一个主机，域名为：test.com，应用程序的目录是/web，设置自动部署，自动解压 --> 
　　　　　　　　<Alias>www.test.com</Alias> 
　　　　　　　　<!-- 定义一个别名www.test.com，类似apache的ServerAlias --> 
　　　　　　　　<Context path="" docBase="www/" reloadable="true" /> 
　　　　　　　　<!-- 定义该应用程序，访问路径""，即访问www.test.com即可访问，网页目录为：相对于appBase下的www/，即/web/www，并且当该应用程序下web.xml或者类等有相关变化时，自动重载当前配置，即不用重启tomcat使部署的新应用程序生效 --> 
　　　　　　　　<Context path="/bbs" docBase="/web/bbs" reloadable="true" /> 
　　　　　　　　<!-- 定义另外一个独立的应用程序，访问路径为：www.test.com/bbs，该应用程序网页目录为/web/bbs --> 
　　　　　　　　<Valve className="org.apache.catalina.valves.AccessLogValve" directory="/web/www/logs" prefix="www_access." suffix=".log" pattern="%h %l %u %t &quot;%r&quot; %s %b" /> 
　　　　　　　　<!-- 定义一个Valve组件，用来记录tomcat的访问日志，日志存放目录为：/web/www/logs如果定义为相对路径则是相当于$CATALINA_HOME，并非相对于appBase，这个要注意。定义日志文件前缀为www_access.并以.log结尾，pattern定义日志内容格式，具体字段表示可以查看tomcat官方文档 --> 
　　　　　　</Host>
 　　　　　 <Host name="manager.test.com" appBase="webapps" unpackWARs="true" autoDeploy="true"> 
　　　　　　　　<!-- 定义一个主机名为man.test.com，应用程序目录是$CATALINA_HOME/webapps,自动解压，自动部署 --> 
　　　　　　　　<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="172.23.136.*" /> 
　　　　　　　　<!-- 定义远程地址访问策略，仅允许172.23.136.*网段访问该主机，其他的将被拒绝访问 --> 
　　　　　　　　<Valve className="org.apache.catalina.valves.AccessLogValve" directory="/web/bbs/logs" prefix="bbs_access." suffix=".log" pattern="%h %l %u %t &quot;%r&quot; %s %b" /> 
　　　　　　　　<!-- 定义该主机的访问日志 -->
　　　　　　</Host> 
　　　　</Engine> 
　　</Service> 
</Server> 

server元素

属性：

port 
　　指定一个端口，这个端口负责监听关闭tomcat的请求 

shutdown 
　　指定向端口发送的命令字符串 

该元素代表整个容器,是Tomcat实例的顶层元素.由org.apache.catalina.Server接口来定义.它包含一个元素.并且它不能做为任何元素的子元素. 

1>className指定实现org.apache.catalina.Server接口的类.默认值为org.apache.catalina.core.StandardServer 
2>port指定Tomcat监听shutdown命令端口.终止服务器运行时,必须在Tomcat服务器所在的机器上发出shutdown命令.该属性是必须的. 
3>shutdown指定终止Tomcat服务器运行时,发给Tomcat服务器的shutdown监听端口的字符串.该属性必须设置 

service 元素
属性：

name 
　　指定service的名字 

该元素由org.apache.catalina.Service接口定义,它包含一个元素,以及一个或多个,这些Connector元素共享用同一个Engine元素

第一个处理所有直接由Tomcat服务器接收的web客户请求. 
第二个处理所有由Apahce服务器转发过来的Web客户请求 

1>className 指定实现org.apahce.catalina.Service接口的类.默认为org.apahce.catalina.core.StandardService 
2>name定义Service的名字

Connector(表示客户端和service之间的连接) 

属性：

port 
　　指定服务器端要创建的端口号，并在这个端口监听来自客户端的请求 

minProcessors 
　　服务器启动时创建的处理请求的线程数 

maxProcessors 
　　最大可以创建的处理请求的线程数 

executor
　　指定当前连接器使用的线程池的名称，如果指定，则忽略其他针对线程数量的设置，比如 maxThreads。

maxThreads
　　(default=200) 最多可创建线程的数量。



maxPostSize
　　(default=2097152 即2MB) 最大允许 POST 上传的数据大小（单位为：字节），对于一般网站来说，比如有写评论写文章的网站，默认的2MB已经足够，不过如果网站带有图片甚至文件上传功能，则需要根据具体情况来定。

enableLookups 
　　如果为true，则可以通过调用request.getRemoteHost()进行DNS查询来得到远程客户端的实际主机名，若为false则不进行DNS查询，而是返回其ip地址 
　　(default=true) 是否允许反向解析访客的IP地址，当你的应用程序使用 request.getRemoteHost() 时如果只需要IP地址，建议禁用此项，这样能节省反向域名解析的时间。

redirectPort 
　　当用户访问非https的资源而该资源又需要https方式访问时，tomcat会自动重定向到https端口，一般https使用 TCP 443端口，所以一般取值”443″。 

SSLEnabled
　　(default=false)，设置当前连接器是否使用安全SSL传输，如果设置为”true”，则应该同时设置下面两个属性： scheme=”https” (default=http) 可以设置为 http 或者 https。 secure=”true” (default=false)。

acceptCount 
　　指定当所有可以使用的处理请求的线程数都被使用时，可以放到处理队列中的请求数，超过这个数的请求将不予处理 

connectionTimeout 
　　(default=”60000″) 当访客网络连接后，服务器等待第一行Request头出现的时间。
　　指定超时的时间数(以毫秒为单位) 


protocol
　　连接器的类型，tomcat 6 有如下几种选择

• org.apache.coyote.http11.Http11Protocol：简写为 “HTTP/1.1″，这是默认的连接器，一个访客网络连接需要一个线程，并发性能比较低。
• org.apache.coyote.http11.Http11NioProtocol：NIO连接器，一个由非阻塞的socket工作模式构成的连接器，并发性能良好，纯Java实现。
• org.apache.coyote.http11.Http11AprProtocol：APR连接器，所谓 APR 就是网络上最多服务器使用的 Web 服务程序 Apache Http Server 所使用的库，Tomcat 建议在生产环境使用，具体方法下面会介绍。

adress
　　连接器所绑定的IP地址，当一台服务器存在多个ip地址时可以指定其中的需要绑定的一个，默认不设置该属性的值表示绑定当前服务器的所有ip地址。


compressableMimeType
　　(default=”text/html,text/xml,text/plain”) 指定需要GZIP压缩的资源的类型。


compression
　　(default=off) 是否启用GZIP压缩，可以取值 on/off/force，设置为on之后会对 compressableMimeType 属性指定的资源类型启用GZIP压缩。


keepAliveTimeout
　　(default=connectionTimeout)，访客完成一次请求后维持网络连接的时间。

一个简单的 Connector 定义如下：

<Connector port="80" protocol="HTTP/1.1"  connectionTimeout="60000"  redirectPort="443" />

由Connector接口定义.元素代表与客户程序实际交互的给件,它负责接收客户请求,以及向客户返回响应结果.

　　第一个Connector元素定义了一个HTTP Connector,它通过8080端口接收HTTP请求;

　　第二个Connector元素定义了一个JD Connector,它通过8009端口接收由其它服务器转发过来的请求.

Connector元素共用属性 

1>className指定实现Connector接口的类 
2>enableLookups如果设为true,表示支持域名解析,可以把IP地址解析为主机名.WEB应用中调用request.getRemoteHost方法返回客户机主机名.默认值为true 
3>redirectPort指定转发端口.如果当前端口只支持non-SSL请求,在需要安全通信的场命,将把客户请求转发至SSL的redirectPort端口 
HttpConnector元素的属性 
1>className实现Connector的类 
2>port设定Tcp/IP端口,默认值为8080,如果把8080改成80,则只要输入http://localhost即可 
因为TCP/IP的默认端口是80 
3>address如果服务器有二个以上ip地址,此属性可以设定端口监听的ip地址.默认情况下,端口会监听服务器上所有的ip地址 
4>bufferSize设定由端口创建的输入流的缓存大小.默认值为2048byte 
5>protocol设定Http协议,默认值为HTTP/1.1 
6>maxThreads设定在监听端口的线程的最大数目,这个值也决定了服务器可以同时响应客户请求的最大数目.默认值为200 
7>acceptCount设定在监听端口队列的最大客户请求数量,默认值为10.如果队列已满,客户必须等待. 
8>connectionTimeout定义建立客户连接超时的时间.如果为-1,表示不限制建立客户连接的时间 
JkConnector的属性 
1>className实现Connector的类 
2>port设定AJP端口号

Executor（ 用于定义共享的线程池。默认情况下每个 Connector 都会产生自己的一个线程池）

　　如果你想多个 Connector 共享一个线程池，则可以先定义一个线程池，如：

<Executor name="tomcatThreadPool" namePrefix="catalina-exec-" maxThreads="150" minSpareThreads="4"/>

　　然后修改上述的 Connector 配置，增加 executor 属性，修改后的配置如下：

<Connector executor="tomcatThreadPool" port="80" protocol="HTTP/1.1" connectionTimeout="60000" redirectPort="443" />

 

Engine(表示指定service中的请求处理机，接收和处理来自Connector的请求) 
属性：

defaultHost 
　　用于指定访客在没有相应的虚拟主机时，Tomcat 默认选择的虚拟主机的名称
　　指定缺省的处理请求的主机名，它至少与其中的一个host元素的name属性值是一样的 
　　(假如有3个域名都 DNS 解析到你的服务器，比如 dog.com, www.dog.com, api.dog.com，当前你只配置了虚拟主机 dog.com 和 www.dog.com，那么当有个访客通过 api.dog.com 访问你的服务器时，Tomcat 就会依据 defaultHost 的设置返回其中一个虚拟主机运行的结果。实际应用中 defaultHost 应该设置为你的主力域名，比如 www.dog.com。)

默认的 Engine 节点如下：

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

每个Service元素只能有一个Engine元素.元素处理在同一个中所有元素接收到的客户请求.由org.apahce.catalina.Engine接口定义.

1>className指定实现Engine接口的类,默认值为StandardEngine 
2>defaultHost指定处理客户的默认主机名,在中的子元素中必须定义这一主机 
3>name定义Engine的名字 

Context(表示一个web应用程序，通常为WAR文件，关于WAR的具体信息见servlet规范) 
属性：

docBase 
　　应用程序的路径或者是WAR文件存放的路径 

path 
　　表示此web应用程序的url的前缀，这样请求的url为http://localhost:8080/path/**** 

reloadable 
　　这个属性非常重要，如果为true，则tomcat会自动检测应用程序的/WEB-INF/lib 和/WEB-INF/classes目录的变化，自动装载新的应用程序，我们可以在不重起tomcat的情况下改变应用程序 

由Context接口定义.是使用最频繁的元素.每个可以包含多个元素.每个web应用有唯一的一个相对应的Context代表web应用自身.servlet容器为第一个web应用创建一个ServletContext对象.

1>className指定实现Context的类,默认为StandardContext类 
2>path指定访问Web应用的URL入口,注意/myweb,而不是myweb了事 
3>reloadable如果这个属性设为true, Tomcat服务器在运行状态下会监视在WEB-INF/classes和Web-INF/lib目录CLASS文件的改运.如果监视到有class文件被更新,服务器自重新加载Web应用 
3>cookies指定是否通过Cookies来支持Session,默认值为true 
4>useNaming指定是否支持JNDI,默认值为了true 

可以在一个Host元素中嵌套任意多的Context元素。每个Context的路径必须是惟一的，由path属性定义。

另外，你必须定义一个context路径长度为0的Context，这个Context称为该虚拟主机的缺省web应用，用来处理那些不能匹配任何Context的Context路径的请求。

host(表示一个虚拟主机) 
属性：

name 
　　指定主机名 
　　设置虚拟主机的域名，比如 localhost 表示本机名称，实际应用时应该填写具体域名，比如 www.dog.com 或者 dog.com，当然如果该虚拟主机是给内部人员访问的，也可以直接填写服务器的 ip 地址，比如 192.168.1.10。

appBase 
　　应用程序基本目录，即存放应用程序的目录 
　　设置 Web 应用程序组的路径。前面说过一个虚拟主机可以由多个 Web 应用程序构成，所以这里的 appBase 所指向的目录应该是准备用于存放这一组 Web 应用程序的目录，而不是具体某个 Web 应用程序的目录本身（即使该虚拟主机只由一个 Web 应用程序组成）。appBase 属性的值可以是相对于 Tomcat 安装目录的相对路径，也可以是绝对路径，需要注意的是该路径必须是 Tomcat 有权限访问的，通过 Arch Linux 源安装的 Tomcat 是通过 tomcat 用户运行的，因此创建一个新的 appBase 目录之后可以使用 chown 命令更改目录的所有者。

unpackWARs 
　　如果为true，则tomcat会自动将WAR文件解压，否则不解压，直接从WAR文件中运行应用程序 

autoDeploy
　　是否允许自动部署，默认值是 true，即表示 Tomcat 会自动检测 appBase 目录下面的文件变化从而自动应用到正在运行的 Web 应用程序。

一个简单的 Host 配置：

<Host name="localhost"  appBase="webapps" unpackWARs="true" autoDeploy="true">
     <Alias>dog.com</Alias>
     <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" 
　　　　　　prefix="localhost_access_log." suffix=".txt" pattern="common" resolveHosts="false"/>
</Host>

Host接口定义.一个Engine元素可以包含多个元素.每个的元素定义了一个虚拟主机.它包含了一个或多个Web应用.

1>className指定实现Host接口的类.默认值为StandardHost 
2>appBase指定虚拟主机的目录,可以指定绝对目录,也可以指定相对于的相对目录.如果没有此项,默认为/webapps 
3>autoDeploy如果此项设为true,表示Tomcat服务处于运行状态时,能够监测appBase下的文件,如果有新有web应用加入进来,会自运发布这个WEB应用 
4>unpackWARs如果此项设置为true,表示把WEB应用的WAR文件先展开为开放目录结构后再运行.如果设为false将直接运行为WAR文件 
5>alias指定主机别名,可以指定多个别名 
6>deployOnStartup如果此项设为true,表示Tomcat服务器启动时会自动发布appBase目录下所有的Web应用.如果Web应用中的server.xml没有相应的元素,将采用Tomcat默认的Context 
7>name定义虚拟主机的名字 

下面举例说明如何创建一个新的虚拟主机 www.dog.com：

　　在目录 /var/lib/tomcat6 下面可以看到安装 Tomcat 时默认创建的 webapps 目录，为了方便管理我们即将创建的虚拟主机的文档也在 /var/lib/tomcat6 里创建：

$ sudo mkdir dog

　　然后在 dog 目录里面创建目录 ROOT，再在 ROOT 里面创建文件 index.html（内容随便）。

现在将目录的所有者和所有组都更改为 tomcat：

$ sudo chown -R tomcat:tomcat dog

　　然后在 server.xml 的 Host 节点下增加如下 Host 节点：

<Host name="www.dog.com"  appBase="/var/lib/tomcat6/dog">
</Host>

　　重启 Tomcat 服务就可以在浏览器里通过地址 http://www.dog.com 访问这个新创建的虚拟主机了，当然你必须要先在 /etc/hosts 文件里增加 www.dog.com 到 127.0.0.1 的解析记录，如下：

127.0.0.1    www.dog.com

　　有时一个虚拟主机可能会同时绑定多个域名，比如 www.dog.com 和 dog.com，这时可以通过在 Host 配置节点里增加 Alias 实现，比如：

<Alias>dog.com</Alias>

　　另外上面示例当中的 <Valve className=… /> 配置了访客的访问日志的储存位置以及文件名。

Logger(表示日志，调试和错误信息) 
属性：

className 
　　指定logger使用的类名，此类必须实现org.apache.catalina.Logger 接口 

prefix 
　　指定log文件的前缀 

suffix 
　　指定log文件的后缀 

timestamp 
　　如果为true，则log文件名中要加入时间，如下例:localhost_log.2001-10-04.txt 

Realm(表示存放用户名，密码及role的数据库) 
属性：

className 
　　指定Realm使用的类名，此类必须实现org.apache.catalina.Realm接口 

Valve(功能与Logger差不多，其prefix和suffix属性解释和Logger 中的一样) 

属性：

className 
　　指定Valve使用的类名，如用org.apache.catalina.valves.AccessLogValve类可以记录应用程序的访问信息 

directory 
　　指定log文件存放的位置 

pattern 
　　有两个值，common方式记录远程主机名或ip地址，用户名，日期，第一行请求的字符串，HTTP响应代码，发送的字节数。combined方式比common方式记录的值更多