Tomcat的配置文件

本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net

Tomcat 的配置文件详解

一. Tomcat 的配置文件

Tomcat 的配置文件默认存放在 $CATALINA_HOME/conf 目录中，主要有以下几个：

1.server.xml:

Tomcat 的主配置文件，包含 Service, Connector, Engine, Realm, Valve, Hosts 主组件的相关配置信息；

2.web.xml：

遵循 Servlet 规范标准的配置文件，用于配置 servlet，并为所有的 Web 应用程序提供包括 MIME 映射等默认配置信息；
3.tomcat-user.xml：

Realm 认证时用到的相关角色、用户和密码等信息；Tomcat 自带的 manager 默认情况下会用到此文件；在 Tomcat 中添加 / 删除用户，为用户指定角色等将通过编辑此文件实现；

4.catalina.policy：

Java 相关的安全策略配置文件，在系统资源级别上提供访问控制的能力；

5>.catalina.properties：

Tomcat 内部 package 的定义及访问相关的控制，也包括对通过类装载器装载的内容的控制；Tomcat6 在启动时会事先读取此文件的相关设置；

6.logging.properties:

Tomcat6 通过自己内部实现的 JAVA 日志记录器来记录操作相关的日志，此文件即为日志记录器相关的配置信息，可以用来定义日志记录的组件级别以及日志文件的存在位置等；

7.context.xml：

所有 host 的默认配置信息；

二. server.xml 配置文件详解

server.xml 中定义的每个主元素都会被创建为对象，并以某特定的层次结构将这些对象组织在一起。下面是个样样例配置：

<Server port="8005" shutdown="SHUTDOWN">

  <Listener class />
  <Listener class />
  <Listener class />

  <GlobalNamingResources>
    <Resource 
    type="org.apache.catalina.UserDatabase"
    description="User database that can be updated and saved"
    factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
    path/>
  </GlobalNamingResources>

  <Service >

    <Connector port="8080" protocol="HTTP/1.1"
      maxThreads="150" connectionTimeout="20000"
      redirectPort="8443"/>

    <Engine >

      <Host 
        unpackWARs="true" autoDeploy="true"
        xmlValidation="false" xmlNamespaceAware="false">
      </Host>
    </Engine>
  </Service>
</Server>


<Server port="8005" shutdown="SHUTDOWN">
  <Listener class />
  <Listener class />
  <Listener class />
  <Listener class />
  <Listener class />

  <GlobalNamingResources>
    <Resource 
              type="org.apache.catalina.UserDatabase"
              description="User database that can be updated and saved"
              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
              path />
  </GlobalNamingResources>

  <Service >

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

    <Engine >

      <Realm class>
        <Realm class
               resource/>
      </Realm>

      <Host 
            unpackWARs="true" autoDeploy="true">

        <Valve class
               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 实例（即一个 JVM），它监听在 8005 端口以接收 shutdown 命令。各 Server 的定义不能使用同一个端口，这意味着如果在同一个物理机上启动了多个 Server 实例，必须配置它们使用不同的端口。这个端口的定义用于为管理员提供一个关闭此实例的便捷途径，因此，管理员可以直接 telnet 至此端口使用 SHUTDOWN 命令关闭此实例。不过，基于安全角度的考虑，这通常不允许远程进行。

Server 的相关属性：

className: 用于实现此 Server 容器的完全限定类的名称，默认为 org.apache.catalina.core.StandardServer；
port: 接收 shutdown 指令的端口，默认仅允许通过本机访问，默认为 8005；
shutdown：发往此 Server 用于实现关闭 tomcat 实例的命令字符串，默认为 SHUTDOWN；

2.Service 组件

Service 主要用于关联一个引擎和与此引擎相关的连接器，每个连接器通过一个特定的端口和协议接收入站请求交将其转发至关联的引擎进行处理。困此，Service 要包含一个引擎（Engine）、一个或多个连接器。

如上面示例中的定义：

<Service name=”Catalina”>

这定义了一个名为 Catalina 的 Service，此名字也会在产生相关的日志信息时记录在日志文件当中。

Service 相关的属性：

className： 用于实现 service 的类名，一般都是 org.apache.catalina.core.StandardService。
name：此服务的名称，默认为 Catalina；
复制代码

3.Connector 组件

进入 Tomcat 的请求可以根据 Tomcat 的工作模式分为如下两类：
Tomcat 作为应用程序服务器：请求来自于前端的 web 服务器，这可能是 Apache, IIS, Nginx 等；
Tomcat 作为独立服务器：请求来自于 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；
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 >

常用的属性定义：

defaultHost：Tomcat 支持基于 FQDN 的虚拟主机，这些虚拟主机可以通过在 Engine 容器中定义多个不同的 Host 组件来实现；但如果此引擎的连接器收到一个发往非非明确定义虚拟主机的请求时则需要将此请求发往一个默认的虚拟主机进行处理，因此，在 Engine 中定义的多个虚拟主机的主机名称中至少要有一个跟 defaultHost 定义的主机名称同名；
name：Engine 组件的名称，用于日志和错误信息记录时区别不同的引擎；

Engine 容器中可以包含 Realm、Host、Listener 和 Valve 子容器。

5.Host 组件

位于 Engine 容器中用于接收请求并进行相应处理的主机或虚拟主机（可以理解为一个虚拟主机），如前面示例中的定义：

常用属性说明：

1. name : 主机名 (FQDN)
2. appBase：此 Host 的 webapps 目录，即存放非归档的 web 应用程序的目录或归档后的 WAR 文件的目录路径；可以使用基于 $CATALINA_HOME 的相对路径；
3. autoDeploy：在 Tomcat 处于运行状态时放置于 appBase 目录中的应用程序文件是否自动进行 deploy；默认为 true；
4. unpackWars：在启用此 webapps 时是否对 WAR 格式的归档文件先进行展开；默认为 true；

虚拟主机定义示例：

<Engine >
  <Host >
    <Context path="" docBase="ROOT"/>
    <Context path="/bbs" docBase="/web/bss"
      reloadable="true" crossContext="true"/>
  </Host>
  
  <Host >
    <Context path="" docBase="ROOT"/>
  </Host>
</Engine>

主机别名定义：
如果一个主机有两个或两个以上的主机名，额外的名称均可以以别名的形式进行定义，如下：

<Host >
  <Alias>magedu.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"/>

在 Tomcat6 中，每一个 context 定义也可以使用一个单独的 XML 文件进行，其文件的目录为 $CATALINA_HOME/conf//。可以用于 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 表示一个安全上下文，它是一个授权访问某个给定 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 class
    driver
    connectionURL="jdbc:mysql://localhost/authority"
    connection
    userTable="users" userNameCol="user_name"
    userCredCol="user_pass"
    userRoleTable="user_roles" roleNameCol="role_name" />

8.Valve 组件（阀门）

Valve 类似于过滤器，它可以工作于 Engine 和 Host/Context 之间、Host 和 Context 之间以及 Context 和 Web 应用程序的某资源之间。一个容器内可以建立多个 Valve，而且 Valve 定义的次序也决定了它们生效的次序。Tomcat6 中实现了多种不同的 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 class
    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 元素。

16.1、Channel

用于 Cluster 中给集群中同一组中的节点定义通信 “信道”。Channel 中需要至少定义 Membership、Receiver 和 Sender 三个元素，此外还有一个可选元素 Interceptor。

16.2、Membership

用于 Channel 中配置同一通信信道上节点集群组中的成员情况，即监控加入当前集群组中的节点并在各节点间传递心跳信息，而且可以在接收不到某成员的心跳信息时将其从集群节点中移除。Tomcat6 中 Membership 的实现是 org.apache.catalina.tribes.membership.McastService。

16.3、Sender

用于 Channel 中配置 “复制信息” 的发送器，实现发送需要同步给其它节点的数据至集群中的其它节点。发送器不需要属性的定义，但可以在其内部定义一个 Transport 元素。

16.4 Transport

用于 Sender 内部，配置数据如何发送至集群中的其它节点。Tomcat6 有两种 Transport 的实现：

1. PooledMultiSender
   基于 Java 阻塞式 IO，可以将一次将多个信息并发发送至其它节点，但一次只能传送给一个节点。
   2)PooledParallelSener
   基于 Java 非阻塞式 IO，即 NIO，可以一次发送多个信息至一个或多个节点。

16.5 Receiver

用于 Channel 定义某节点如何从其它节点的 Sender 接收复制数据，Tomcat6 中实现的接收方式有两种 BioReceiver 和 NioReceiver。
复制代码