tomcat（三）配置文件详解

最新推荐文章于 2024-06-17 15:04:14 发布

HYJ0101

最新推荐文章于 2024-06-17 15:04:14 发布

阅读量244

点赞数

分类专栏： web中间件文章标签： tomcat

本文链接：https://blog.csdn.net/u014761412/article/details/84335714

版权

web中间件专栏收录该内容

8 篇文章 0 订阅

订阅专栏

配置文件详解

一、server.xml的元素分类以及整体结构

server.xml位于$TOMCAT_HOME/conf目录下

1、整体结构

<Server>
    <Service>
        <Connector />
        <Connector />
        <Engine>
            <Host>
                <Context />   # 现在常常使用自动部署，不推荐配置Context元素
            </Host>
        </Engine>
    </Service>
</Server>

2、元素分类

顶层元素：<Server>、<Service>
<Server>元素是整个配置文件的根元素，<Service>则是代表一个Engine元素以及一组与之相连的Connector元素
连接器元素：<Connector>
代表了外部客户端发送请求到特定的service的接口，同时也是外部客户端从特定Service接收响应的接口。
容器元素：<Engine><Host><Context>
容器的功能是处理接收进来的请求，并产生相应的响应。Engine包含Host，Host包含Context，Engine处理Service中所有的请求，一个Host组件处理发向一个特定虚拟主机的所有请求，一个Context组件可以处理一个特定的web应用的所有请求。
内嵌组件：可以内嵌到容器中的组件

二、核心元素的主要功能

1、Server

server元素
shutdown属性表示关闭Server的指令；
port属性表示接收shutdown指令的端口号，设为-1可以禁掉该端口，或者把shutdown字段置为空

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

server的主要任务，就是提供一个接口让客户端能够访问到这个Service集合，同时维护其包含的Service的声明周期，包括如何初始化、如何结束服务、如何找到客户端要访问的Service。

2、Service

Service的作用，是在Connector和Engine外面包了一层，把它们组装在一起，一个Service可以包含多个Connector，但是只能包含一个Engine。其中系统默认配置文件中，包含一个名称为“Catalina”的Service。当想用不同的端口访问不同的程序时，需要定义多个service。

3、Connector

Connector的主要功能，是接收连接请求，创建Request和Response对象用于和请求端交换数据；然后分配线程让Engine来处理这个请求，并把产生的Request和Response对象传给Engine。
通过配置Connector，可以控制请求Service的协议及端口号。在第一部分的例子中，Service包含两个Connector：

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

（1）第一个connector，客户端可以从8080端口号使用http协议访问Tomcat
protocal规定了访问的协议
port规定了请求的端口号
maxThreads连接器创建处理请求线程的最大数目，处理同时请求的最大数目，默认值为200
minSpareThreads线程的最小运行数目，这些始终保持运行。如果未指定，默认值为10
acceptCount最大队列长度。一般与maxThreads相同，默认为100
maxConnections在任何给定的时间内，服务器将接受和处理的最大连接数。当这个数字已经达到时，服务器将接受但不处理，等待进一步连接。NIO与NIO2的默认值为10000，APR默认值为8192
connectionTimeout当请求已经被接受，但未被处理，也就是等待中的超时时间。单位为毫秒，默认值为60000。通常情况下设置为30000
maxHttpHeaderSize请求和响应的HTTP头的最大大小，以字节为单位指定。如果没有指定，这个属性被设置为8192（8 KB）
tcpNoDelay如果为true，服务器socket会设置TCP_NO_DELAY选项，在大多数情况下可以提高性能。缺省情况下设为true
compression是否启用gzip压缩，默认为关闭状态。这个参数的可接受值为“off”（不使用压缩），“on”（压缩文本数据），“force”（在所有的情况下强制压缩）
compressionMinSize如果compression=“on”，则启用此项。被压缩前数据的最小值，也就是超过这个值后才被压缩。如果没有指定，这个属性默认为“2048”（2KB），单位为byte
disableUploadTimeout这个标志允许servlet Container在一个servlet执行的时候，使用一个不同的，更长的连接超时。最终的结果是给servlet更长的时间以便完成其执行，或者在数据上传的时候更长的超时时间。如果没有指定，设为false
processorCache规定多少processor对象有能得到缓存，-1无限制，默认为200
redirectPort表示如果强制要求https而请求是是http,重定向至端口号为8443的connector
connectionTimeout表示连接的超时时间
在这个例子中，Tomcat监听HTTP请求，使用的是8080端口，而不是正式的80端口；实际上，在正式的生产环境中，Tomcat也常常监听8080端口，而不是80端口。这是因为在生产环境中，很少将Tomcat直接对外开放接收请求，而是在Tomcat和客户端之间加一层代理服务器(如nginx)，用于请求的转发、负载均衡、处理静态文件等；通过代理服务器访问Tomcat时，是在局域网中，因此一般仍使用8080端口。
（2）通过配置第2个Connector，客户端可以通过8009端口号使用AJP协议访问Tomcat。AJP协议负责和其他的HTTP服务器(如Apache)建立连接；在把Tomcat与其他HTTP服务器集成时，就需要用到这个连接器。之所以使用Tomcat和其他服务器集成，是因为Tomcat可以用作Servlet/JSP容器，但是对静态资源的处理速度较慢，不如Apache和IIS等HTTP服务器；因此常常将Tomcat与Apache等集成，前者作Servlet容器，后者处理静态资源，而AJP协议便负责Tomcat和Apache的连接。

4、Engine（container）

Engine组件在Service组件中有且只有一个；Engine是Service组件中的请求处理组件。

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

name属性属于日志和错误信息，在整个server段中应该唯一。
defaultHost属性指定了默认的host名称,当发往本地的请求指定的host名称不存在时，一律使用defaultHost指定的host进行处理，因此defaultHost的值必须和Engine中的一个Host组件的name属性值相配。

5、Host

（1）Engine与Host

Host是Engine的子容器。Engine组件中可以内嵌一个或者多个Host组件，每个Host组件代表Engine中的一个虚拟主机。

（2）Host的作用

Host虚拟主机的作用，是运行多个web应用，负责安装、展开、启动、和结束多个web应用。
Host组件代表的虚拟主机，对应了服务器中一个网络名实体（如一个域名或者一个Ip地址）

（3）Host的配置

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

name属性指定虚拟主机的主机名
unpackWARs指定了是否讲web应用的WAR文件进行展开解压，如果为True，通过解压后的文件结构运行该web应用，如果为false，则直接运行WAR文件运行web应用
appBase属性指定了Web应用所在的目录，默认值是webapps，此为一个相对路径，绝对路径为Tomcat根目录/webapps
autoDeploy属性与web应用的自动部署有关

6、Context

（1）context的作用

Context元素代表在特定虚拟主机上运行一个web应用，每个Web应用基于WAR文件，或WAR文件解压后对应的目录。
在Host中可以定义任意多的Context元素

（2）Web应用的自动部署

要开启web应用的自动部署，配置方式是在相应的host字段中配置deployOnStartup和autoDeploy属性为ture。开启后，当tomcat检测到新的Web应用或者Web应用的更新时，会触发应用的部署。
deployOnStartup为true时，Tomcat在启动时检查Web应用，且检测到的所有Web应用视作新应用；
autoDeploy为true时，Tomcat在运行时定期检查新的Web应用或Web应用的更新
自动部署依赖检查是否有新的或者更改过的Web应用，而Host元素的appBase和xmlBase设置了检查web应用更新的目录
xmlBase属性指定web应用的XML配置文件所在的目录，默认值conf/<engine_name>/<host_name>

1 <Context docBase="D:\Program Files\app1.war" reloadable="true"/>
# 在该例子中，docBase位于Host的appBase目录之外；path属性没有指定，而是根据app1.xml自动推导为”app1”；由于是在开发环境下，因此reloadable设置为true，便于开发调试

docBase指定了该Web应用使用的WAR包路径，或应用目录。需要注意的是，在自动部署场景下(配置文件位于xmlBase中)，docBase不在appBase目录中，才需要指定；如果docBase指定的WAR包或应用目录就在docBase中，则不需要指定，因为Tomcat会自动扫描appBase中的WAR包和应用目录，指定了反而会造成问题。

path属性指定了访问该Web应用的上下文路径，当请求到来时，Tomcat根据`属性与URI的匹配程度来选择Web应用处理相应请求。例如，Web应用app1的path属性是”/app1”，Web应用app2的path属性是”/app2”，那么请求/app1/index.html会交由app1来处理；而请求/app2/index.html会交由app2来处理。如果一个Context元素的path属性为””，那么这个Context是虚拟主机的默认Web应用；当请求的uri与所有的path都不匹配时，使用该默认Web应用来处理。

reloadable属性指示tomcat是否在运行时监控在WEB-INF/classes和WEB-INF/lib目录下class文件的改动。如果值为true，那么当class文件改动时，会触发Web应用的重新加载。在开发环境下，reloadable设置为true便于调试；但是在生产环境中设置为true会给服务器带来性能压力，因此reloadable参数的默认值为false

（3）静态部署

除了自动部署，我们也可以在server.xml中通过元素静态部署Web应用。静态部署与自动部署是可以共存的。在实际应用中，并不推荐使用静态部署，因为server.xml 是不可动态重加载的资源，服务器一旦启动了以后，要修改这个文件，就得重启服务器才能重新加载。而自动部署可以在Tomcat运行时通过定期的扫描来实现，不需要重启服务器

三、其他组件

1、Listener

Listener(即监听器)定义的组件，可以在特定事件发生时执行特定的操作；被监听的事件通常是Tomcat的启动和停止。
监听器可以在Server、Engine、Host或Context中，本例中的监听器都是在Server中。实际上，本例中定义的6个监听器，都只能存在于Server组件中。监听器不允许内嵌其他组件。

<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" />

该例子中监听器的的介绍：

VersionLoggerListener：当Tomcat启动时，该监听器记录Tomcat、Java和操作系统的信息。该监听器必须是配置的第一个监听器。
AprLifecycleListener：Tomcat启动时，检查APR库，如果存在则加载。APR，即Apache Portable Runtime，是Apache可移植运行库，可以实现高可扩展性、高性能，以及与本地服务器技术更好的集成。
JasperListener：在Web应用启动之前初始化Jasper，Jasper是JSP引擎，把JVM不认识的JSP文件解析成java文件，然后编译成class文件供JVM使用。
JreMemoryLeakPreventionListener：与类加载器导致的内存泄露有关。
GlobalResourcesLifecycleListener：通过该监听器，初始化< GlobalNamingResources>标签中定义的全局JNDI资源；如果没有该监听器，任何全局资源都不能使用。
ThreadLocalLeakPreventionListener：当Web应用因thread-local导致的内存泄露而要停止时，该监听器会触发线程池中线程的更新。当线程执行完任务被收回线程池时，活跃线程会一个一个的更新。只有当Web应用(即Context元素)的renewThreadsWhenStoppingContext属性设置为true时，该监听器才有效

2、GlobalNamingResources与Realm

1	   <Realm className="org.apache.catalina.realm.LockOutRealm">
2         <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
3                resourceName="UserDatabase"/>
4       </Realm>

Realm，可以把它理解成“域”；Realm提供了一种用户密码与web应用的映射关系，从而达到角色安全管理的作用。在本例中，Realm的配置使用name为UserDatabase的资源实现。而该资源在Server元素中使用GlobalNamingResources配置:

<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>

GlobalNamingResources元素定义了全局资源，通过配置可以看出，该配置是通过读取$TOMCAT_HOME/ conf/tomcat-users.xml实现的

3、Valve

（1）常规配置

<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" />

本例的AccessLogValve属性的配置，使用的是默认的配置；下面介绍AccessLogValve中各个属性的作用：
className：规定了Valve的类型，是最重要的属性；本例中，通过该属性规定了这是一个AccessLogValve
directory：指定日志存储的位置，本例中，日志存储在$TOMCAT_HOME/logs目录下
prefix：指定了日志文件的前缀
suffix：指定了日志文件的后缀。通过directory、prefix和suffix的配置，在$TOMCAT_HOME/logs目录下，可以看到如下所示的日志文件
pattern：指记录日志的格式，本例中各项的含义如下
- %a：远程IP地址
- %h：远程主机名或IP地址；如果有nginx等反向代理服务器进行请求分发，该主机名/IP地址代表的是nginx，否则代表的是客户端。
- %l：远程逻辑用户名，一律是”-”，可以忽略。
- %u：授权的远程用户名，如果没有，则是”-”。
- %t：访问的时间。
- %r：请求的第一行，即请求方法(get/post等)、uri、及协议
- %s：响应状态，200,404等等。
- %b：响应的数据量，不包括请求头，如果为0，则是””-。
- %D：请求处理的时间(单位是毫秒)。
- ％T - 处理请求的时间（以秒为单位）

（2）设置nginx代理至tomcat的配置

tomcat还可以将request请求的查询参数、session会话变量值、cookie值或HTTP请求/响应头内容的变量值等内容写入到日志文件中

％{XXX}i xxx代表传入的头(HTTP Request)
％{XXX}o xxx代表传出的响应头(Http Resonse)
％{XXX}c xxx代表特定的Cookie名
％{XXX}r xxx代表ServletRequest属性名
％{XXX}s xxx代表HttpSession中的属性名

%{X-Real-IP}i 此代表真实的远端主机IP，这需要在nginx中进行配置
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;

4、组件之间的关联

1、如何确定请求由谁处理

根据协议和端口号选定Service和Engine
server中可以配置多个Service，可以实现通过不通的端口号来访问同一台机器上部署的不通的应用
根据域名或IP地址选定Host
根据URI选定Context/web应用
2 如何配置多个服务
（1）复制元素，放在当前后面
（2）修改端口号：根据需要监听的端口号修改元素的port属性；必须确保该端口没有被其他进程占用，否则Tomcat启动时会报错，而无法通过该端口访问Web应用
（3）修改Service和Engine的name属性
（4）修改Host的appBase属性（如webapps2）
（5）Web应用仍然使用自动部署
（6）将要部署的Web应用(WAR包或应用目录)拷贝到新的appBase下

参考原博客地址

https://www.cnblogs.com/kismetv/p/7228274.html

HYJ0101

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
tomcat（三）配置文件详解

配置文件详解一、server.xml的元素分类以及整体结构server.xml位于$TOMCAT_HOME/conf目录下1、整体结构&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;lt;Server&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;gt; &amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;lt;Service&a
复制链接

扫一扫