Tomcat核心配置文件server.xml说明

文章目录

• 一、server.xml主要标签结构
• 二、Service标签主要结构
• • 2.1 Executor标签
  • 2.2 Connector标签
  • 2.3 Engine标签
  • 2.4 Host标签
  • 2.5 Context标签

tomcat作为服务器的话，其核心配置文件是conf/server.xml，其中包含了Servlet容器的相关配置，即Catalina的配置信息。

一、server.xml主要标签结构

server.xml结构，Server 元素表示整个 Catalinaservlet 容器。因此，它必须是 conf/server.xml 配置文件中最外层的元素。它的属性表示 servlet 容器作为一个整体的特征。

<!--
Server 根元素，创建⼀个Server实例，
⼦标签有 Listener、GlobalNamingResources、Service
-->
<Server>
  <!--定义监听器-->
  <Listener/>
  <!--定义服务器的全局JNDI资源 -->
  <GlobalNamingResources/>
  <!--
  定义⼀个Service服务，⼀个Server标签可以有多个Service服务实例
  -->
  <Service/>
</Server>

server.xml示例

<!--port：关闭服务器的监听端⼝shutdown：关闭服务器的指令字符串-->
<Server port="8005" shutdown="SHUTDOWN">
  
<!-- 以⽇志形式输出服务器 、操作系统、JVM的版本信息 -->
<Listener className="org.apache.catalina.startup.VersionLoggerListener" />
  
<!-- Security listener. Documentation at /docs/config/listeners.html
<Listener className="org.apache.catalina.security.SecurityListener" />-->
  
<!--APR library loader. Documentation at /docs/apr.html -->
<!-- 
  加载（服务器启动） 和 销毁 （服务器停⽌） APR。 如果找不到APR库， 则会输出⽇志， 并不影响 Tomcat启动 
  -->
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  
<!-- Prevent memory leaks due to use of particular java/javax APIs-->
<!-- 避免JRE内存泄漏问题 -->
<Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
  
<!-- 加载（服务器启动） 和 销毁（服务器停⽌） 全局命名服务 -->
<Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
  
<!-- 在Context停⽌时重建 Executor 池中的线程， 以避免ThreadLocal 相关的内存泄漏 -->
<Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
  
<!-- Global JNDI resources Documentation at /docs/jndi-resources-howto.html GlobalNamingResources 中定义了全局命名服务-->
<GlobalNamingResources>
<!-- 
  Editable user database that can also be used by
	UserDatabaseRealm to authenticate users
-->
<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 : 
  1、可以集合多个连接器和共享同一个单独的“conntainer”.
  2、需要注意，service本身不是一个容器，因此无法在他这个级别下定义子容器，例如Valves
  3、Service 元素表示一个或多个连接器组件的组合，这些组件共享一个 Engine 组件来处理传入请求。
  	 一个或多个 Service 元素可以嵌套在一个 Server 元素中。
  
  service的自身属性：
  name属性: 此服务的显示名称，如果使用标准 Catalina 组件，将包含在日志消息中。
  与特定服务器关联的每个服务的名称必须是唯一的。
  className：要使用的实现的 Java 类名。这个类必须实现 org.apache.catalina。服务接口。
  如果未指定类名，则将使用标准实现。org.apache.catalina.core.StandardService
-->
<Service name="Catalina">
...
</Service>
</Server>

二、Service标签主要结构

<!--
该标签⽤于创建 Service 实例，默认使⽤ org.apache.catalina.core.StandardService。
默认情况下，Tomcat 仅指定了Service 的名称， 值为 "Catalina"。
Service ⼦标签为 ： Listener、Executor、Connector、Engine，
其中：
Listener ⽤于为Service添加⽣命周期监听器，
Executor ⽤于配置Service 共享线程池，
Connector ⽤于配置Service 包含的链接器，
Engine ⽤于配置Service中链接器对应的Servlet 容器引擎
-->
<Service name="Catalina">
...
</Service>

2.1 Executor标签

<!--
默认情况下，Service 并未添加共享线程池配置。 如果我们想添加⼀个线程池， 可以在
<Service> 下添加如下配置：
name：线程池名称，⽤于 Connector中指定
namePrefix：所创建的每个线程的名称前缀，⼀个单独的线程名称为
namePrefix+threadNumber
maxThreads：池中最⼤线程数
minSpareThreads：活跃线程数，也就是核⼼池线程数，这些线程不会被销毁，会⼀直存在
maxIdleTime：线程空闲时间，超过该时间后，空闲线程会被销毁，默认值为6000（1分钟），单位毫秒
maxQueueSize：在被执⾏前最⼤线程排队数⽬，默认为Int的最⼤值，也就是⼴义的⽆限。除⾮特
							殊情况，这个值 不需要更改，否则会有请求不会被处理的情况发⽣
prestartminSpareThreads：启动线程池时是否启动 minSpareThreads部分线程。默认值为false，即不启动
threadPriority：线程池中线程优先级，默认值为5，值从1到10
className：线程池实现类，未指定情况下，默认实现类为org.apache.catalina.core.StandardThreadExecutor。
					如果想使⽤⾃定义线程池⾸先需要实现 org.apache.catalina.Executor接⼝
-->
<Executor name="commonThreadPool"
namePrefix="thread-exec-"
maxThreads="200"
minSpareThreads="100"
maxIdleTime="60000"
maxQueueSize="Integer.MAX_VALUE"
prestartminSpareThreads="false"
threadPriority="5"
className="org.apache.catalina.core.StandardThreadExecutor"
/>

2.2 Connector标签

Connector 标签⽤于创建链接器实例。默认情况下，server.xml 配置了两个链接器，⼀个⽀持HTTP协议，⼀个⽀持AJP协议⼤多数情况下，我们并不需要新增链接器配置，只是根据需要对已有链接器进⾏优化

<!--
port：端⼝号，Connector ⽤于创建服务端Socket 并进⾏监听， 以等待客户端请求链接。如果该属性设置
			为0， Tomcat将会随机选择⼀个可⽤的端⼝号给当前Connector 使⽤
protocol：当前Connector ⽀持的访问协议。 默认为 HTTP/1.1 ， 并采⽤⾃动切换机制选择⼀个基于 JAVA
					NIO 的链接器或者基于本地APR的链接器（根据本地是否含有Tomcat的本地库判定）
connectionTimeOut：Connector 接收链接后的等待超时时间， 单位为 毫秒。 -1 表示不超时。
redirectPort：当前Connector 不⽀持SSL请求， 接收到了⼀个请求， 并且也符合security-constraint 约束，
							需要SSL传输，Catalina⾃动将请求重定向到指定的端⼝。
executor：指定共享线程池的名称， 也可以通过maxThreads、minSpareThreads 等属性配置内部线程池。
URIEncoding:⽤于指定编码URI的字符编码， 
						Tomcat8.x版本默认的编码为 UTF-8 , Tomcat7.x版本默认为ISO-8859-1
-->
<!--org.apache.coyote.http11.Http11NioProtocol,⾮阻塞式 Java NIO 链接器-->
<Connector port="8080" protocol="HTTP/1.1" 
	connectionTimeout="20000" redirectPort="8443" />

<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />

<Connector port="8080"
protocol="HTTP/1.1"
executor="commonThreadPool"
maxThreads="1000"
minSpareThreads="100"
acceptCount="1000"
maxConnections="1000"
connectionTimeout="20000"
compression="on"
compressionMinSize="2048"
disableUploadTimeout="true"
redirectPort="8443"
URIEncoding="UTF-8" />

2.3 Engine标签

<!--
name： ⽤于指定Engine 的名称， 默认为Catalina
defaultHost：默认使⽤的虚拟主机名称， 当客户端请求指向的主机⽆效时， 将交由默认的虚拟主机处
理， 默认为localhost
-->
<Engine name="Catalina" defaultHost="localhost">
...
</Engine>

2.4 Host标签

Host 标签⽤于配置⼀个虚拟主机

<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">
...
</Host>

2.5 Context标签

<Host name="www.abc.com" appBase="webapps" unpackWARs="true" autoDeploy="true">
  <!--
  docBase：Web应⽤⽬录或者War包的部署路径。可以是绝对路径，也可以是相对于 Host appBase的
  相对路径。
  path：Web应⽤的Context 路径。如果我们Host名为localhost， 则该web应⽤访问的根路径为：
  http://localhost:8080/web3
  -->
  <Context docBase="/Users/yingdian/web_demo" path="/web3"></Context>
  <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>