Tomcat中server.xml配置文件

发表于2019-03-05更新于2022-04-27阅读次数

简介

Tomcat服务器是由一系列可以配置的组件构成，其中核心组件是Catalina Servlet,它是最顶层组件。
Tomcat各组件是在server.xml(CATALINA_HOME\conf\server.xml)配置的。
其详细的配置文件结构如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?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="/opt/project/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 &quot;%r&quot; %s %b" />
      </Host>
    </Engine>
  </Service>

  <Service name="Catalina2">
    <Connector port="8084" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
    <Connector port="8010" protocol="AJP/1.3" redirectPort="8443" />
    <Engine name="Catalina2" defaultHost="localhost">
      <Realm className="org.apache.catalina.realm.LockOutRealm">
        <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
               resourceName="UserDatabase"/>
      </Realm>

      <Host name="localhost"  appBase="/opt/project/webapps2" unpackWARs="true" autoDeploy="true">
        <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" />
      </Host>
    </Engine>
  </Service>
</Server>

其抽离的配置文件结构如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<Server>
    <Listener/>
    <GlobaNamingResources>
    </GlobaNamingResources>
    <Service>
        <Connector/>
        <Engine>
            <Logger/>
            <Realm/>
                <host>
                    <Logger/>
                    <Context/>
                </host>
        </Engine>
    </Service>
</Server>

其关系结构图如下：

server结构

组件

server

Server即Catalina Servlet组件，它是server.xml的最外层元素
常用属性

address—Tomcat监听shutdown命令的地址，默认为localhost
className—指定实现org.apache.catalina.Server接口的类，默认值为org.apache.catalina.core.StandardServer
port－Tomcat监听shutdown命令的端口。设置为-1，则禁止通过端口关闭Tomcat，同时shutdown.bat也不能使用
shutdown－通过指定的地址（Address）、端口（port）关闭Tomcat所需的字符串。修改shutdown的值，对shutdown.bat无影响

Listener

Listener即监听器，负责监听特定的事件，当特定事件触发时，Listener会捕捉到该事件，并做出相应处理。Listener通常用在Tomcat的启动和关闭过程。Listener可嵌在Server、Engine、Host、Context内
常用属性

className－指定实现org.apache.catalina.LifecycleListener接口的类

GlobalNamingResources

GlobalNamingResources用于配置JNDI

Service

Service包装Executor、Connector、Engine，以组成一个完整的服务。一个Service可以包含多个Connector，但是只能包含一个Engine。
常用属性

className—指定实现org.apache.catalina. Service接口的类，默认值为org.apache.catalina.core.StandardService
name—Service的名字

Server可以包含多个Service组件

Executor

Executor即Service提供的线程池，供Service内各组件使用
常用属性

className－指定实现org.apache.catalina. Executor接口的类，默认值为org.apache.catalina.core. StandardThreadExecutor
name－线程池的名字
daemon－是否为守护线程，默认值为true
maxIdleTime－总线程数高于minSpareThreads时，空闲线程的存活时间（单位：ms），默认值为60000，即1min
maxQueueSize－任务队列上限，默认值为Integer.MAX_VALUE(2147483647)，超过此值，将拒绝
maxThreads－线程池内线程数上限，默认值为200
minSpareThreads－线程池内线程数下限，默认值为25
namePrefix－线程名字的前缀。线程名字通常为namePrefix+ threadNumber
prestartminSpareThreads－是否在Executor启动时，就生成minSpareThreads个线程。默认为false
threadPriority－Executor内线程的优先级，默认值为5(Thread.NORM_PRIORITY)
threadRenewalDelay－重建线程的时间间隔。重建线程池内的线程时，为了避免线程同时重建，每隔threadRenewalDelay（单位：ms）重建一个线程。默认值为1000，设置为负则不重建

Connector

Connector是Tomcat接收请求的入口，每个Connector有自己专属的监听端口
Connector有两种：HTTP Connector和AJP Connector

HTTP Connector(HTTP/1.1)

port : 在端口号8080处侦听来自客户browser的HTTP1.1请求.如果把8080改成80,则只要输入http://localhost/即可
protocol:设定Http协议,默认值为HTTP/1.1
minSpareThreads: 该Connector先创建5个线程等待客户请求，每个请求由一个线程负责
maxSpareThread:设定在监听端口的线程的最大数目,这个值也决定了服务器可以同时响应客户请求的最大数目.默认值为200
redirectport : 当客户请求是https时，把该请求转发到端口8443去
enableLookups:如果设为true,表示支持域名解析,可以把IP地址解析为主机名.WEB应用中调用request.getRemoteHost方法返回客户机主机名.默认值为true
connectionTimeout:定义建立客户连接超时的时间.如果为-1,表示不限制建立客户连接的时间
allowTrace：是否允许HTTP的TRACE方法，默认为false
emptySessionPath：如果设置为true，用户的所有路径都将设置为/，默认为false。
enableLookups：调用request、getRemoteHost()执行DNS查询，以返回远程主机的主机名，如果设置为false，则直接返回IP地址。
maxPostSize：指定POST方式请求的最大量，没有指定默认为2097152。
protocol：值必须为HTTP1.1，如果使用AJP处理器，该值必须为AJP/1.3
proxyName：如这个连接器正在一个代理配置中被使用，指定这个属性，在request.getServerName()时返回
redirectPort：如连接器不支持SSL请求，如收到SSL请求，Catalina容器将会自动重定向指定的端口号，让其进行处理。
scheme：设置协议的名字，在request.getScheme()时返回，SSL连接器设为”https”，默认为”http”
secure：在SSL连接器可将其设置为true，默认为false
URIEncoding：用于解码URL的字符编码，没有指定默认值为ISO-8859-1
useBodyEncodingForURI：主要用于Tomcat4.1.x中，指示是否使用在contentType中指定的编码来取代URIEncoding，用于解码URI查询参数，默认为false
xpoweredBy：为true时，Tomcat使用规范建议的报头表明支持Servlet的规范版本，默认为false
acceptCount：当所有的可能处理的线程都正在使用时，在队列中排队请求的最大数目。当队列已满，任何接收到的请求都会被拒绝，默认值为10
bufferSize：设由连接器创建输入流缓冲区的大小，以字节为单位。默认情况下，缓存区大的大小为2048字节
compressableMimeType：MIME的列表，默认以逗号分隔。默认值是text/html，text/xml，text/plain
compression：指定是否对响应的数据进行压缩。off：表示禁止压缩、on：表示允许压缩（文本将被压缩）、force：表示所有情况下都进行压缩，默认值为off
connectionTimeout：设置连接的超时值，以毫秒为单位。默认值为60000=60秒
disableUploadTimeOut：允许Servlet容器，正在执行使用一个较长的连接超时值，以使Servlet有较长的时间来完成它的执行，默认值为false
maxHttpHeaderSize：HTTP请求和响应头的最大量，以字节为单位，默认值为4096字节
maxKeepAliveRequest：服务器关闭之前，客户端发送的流水线最大数目。默认值为100
maxSpareThreads：允许存在空闲线程的最大数目，默认值为50
minSpareThreads：设当连接器第一次启动创建线程的数目，确保至少有这么多的空闲线程可用。默认值为4
port：服务端套接字监听的TCP端口号，默认值为8080（必须）
socketBuffer：设Socket输出缓冲区的大小（以字节为单位），-1表示禁止缓冲，默认值为9000字节
toNoDelay：为true时，可以提高性能。默认值为true
threadPriority：设JVM中请求处理线程优先级。默认值为NORMAL-PRIORITY
executor－指定线程池

AJP Connector(AJP/1.3)

用于将Apache与Tomcat集成在一起，当Apache接收到动态内容请求时，通过在配置中指定的端口号将请求发送给在此端口号上监听的AJP连接器组件。

backlog：当所有可能的请求处理线程都在使用时，队列中排队的请求最大数目。默认为10，当队列已满，任何请求都将被拒绝
maxSpareThread：允许存在空闲线程的最大数目，默认值为50
maxThread：最大线程数，默认值为200
minSpareThreads：设当连接器第一次启动时创建线程的数目，确保至少有这么多的空闲线程可用，默认值为4
port：服务端套接字的TCP端口号，默认值为8089（必须）
topNoDelay：为true时，可以提高性能，默认值为true
soTimeout：超时值
executor－指定线程池

Engine

Engine负责处理Service内的所有请求。它接收来自Connector的请求，并决定传给哪个Host来处理，Host处理完请求后，将结果返回给Engine，Engine再将结果返回给Connector
常用属性：
name－Engine的名字
defaultHost－指定默认Host。Engine接收来自Connector的请求，然后将请求传递给defaultHost，defaultHost 负责处理请求
className－指定实现org.apache.catalina. Engine接口的类，
默认值为org.apache.catalina.core. StandardEngine
backgroundProcessorDelay－Engine及其部分子组件（Host、Context）调用backgroundProcessor方法的时间间隔。backgroundProcessorDelay为负，将不调用backgroundProcessor。
backgroundProcessorDelay的默认值为10
注：Tomcat启动后，Engine、Host、Context会启动一个后台线程，定期调用backgroundProcessor方法。backgroundProcessor方法主要用于重新加载Web应用程序的类文件和资源、扫描Session过期
jvmRoute－Tomcat集群节点的id。部署Tomcat集群时会用到该属性，
Service内必须包含一个Engine组件
Service包含一个或多个Connector组件，Service内的Connector共享一个Engine

Host

Host负责管理一个或多个Web项目
常用属性：
name－Host的名字
appBase－存放Web项目的目录（绝对路径、相对路径均可）
unpackWARs－当appBase下有WAR格式的项目时，是否将其解压（解成目录结构的Web项目）。设成false，则直接从WAR文件运行Web项目
autoDeploy－是否开启自动部署。设为true，Tomcat检测到appBase有新添加的Web项目时，会自动将其部署
startStopThreads－线程池内的线程数量。Tomcat启动时，Host提供一个线程池，用于部署Web项目
startStopThreads为0，并行线程数=系统CPU核数
startStopThreads为负数，并行线程数=系统CPU核数+startStopThreads，如果（系统CPU核数+startStopThreads）小于1，并行线程数设为1
startStopThreads为正数，并行线程数= startStopThreads
startStopThreads默认值为1
startStopThreads为默认值时，Host只提供一个线程，用于部署Host下的所有Web项目。如果Host下的Web项目较多，由于只有一个线程负责部署这些项目，因此这些项目将依次部署，最终导致Tomcat的启动时间较长。此时，修改startStopThreads值，增加Host部署Web项目的并行线程数，可降低Tomcat的启动时间

Context

Context代表一个运行在Host上的Web项目。一个Host上可以有多个Context
将一个Web项目（D:\MyApp）添加到Tomcat，在Host标签内，添加Context标签

常用属性：
path－该Web项目的URL入口。path设置为””，输入http://localhost:8080即可访问MyApp；path设置为”/test/MyApp”，输入http://localhost:8080/test/MyApp才能访问MyApp
docBase－Web项目的路径，绝对路径、相对路径均可（相对路径是相对于CATALINA_HOME\webapps）
reloadable－设置为true，Tomcat会自动监控Web项目的/WEB-INF/classes/和/WEB-INF/lib变化，当检测到变化时，会重新部署Web项目。reloadable默认值为false。通常项目开发过程中设为true，项目发布的则设为false
crossContext－设置为true，该Web项目的Session信息可以共享给同一host下的其他Web项目。默认为false

Tomcat Server处理一个http请求的过程

假设来自客户的请求为：http://localhost:8080/wsota/wsota_index.jsp

  1. 请求被发送到本机端口8080，被在那里侦听的Coyote HTTP/1.1 Connector获得
  2. Connector把该请求交给它所在的Service的Engine来处理，并等待来自Engine的回应
  3. Engine获得请求localhost/wsota/wsota_index.jsp，匹配它所拥有的所有虚拟主机Host
  4. Engine匹配到名为localhost的Host（即使匹配不到也把请求交给该Host处理，因为该Host被定义为该Engine的默认主机）
  5. localhost Host获得请求/wsota/wsota_index.jsp，匹配它所拥有的所有Context
  6. Host匹配到路径为/wsota的Context（如果匹配不到就把该请求交给路径名为””的Context去处理）
  7. path=”/wsota”的Context获得请求/wsota_index.jsp，在它的mapping table中寻找对应的servlet
  8. Context匹配到URL PATTERN为*.jsp的servlet，对应于JspServlet类
  9. 构造HttpServletRequest对象和HttpServletResponse对象，作为参数调用JspServlet的doGet或doPost方法
  10. Context把执行完了之后的HttpServletResponse对象返回给Host
  11. Host把HttpServletResponse对象返回给Engine
  12. Engine把HttpServletResponse对象返回给Connector
  13. Connector把HttpServletResponse对象返回给客户browser

请求流程.png