tomcat 配置文件server.xml 详解 Connector Engine Host Context

一 server.xml

server.xml 是tomcat 的核心配置文件，位于./conf/ 下.具有server,connector
Hosts 等元素模块。接下来我们看看吧。(导游介绍词)。本文内容基于tomcat 8.5 不同版本配置或有差异性。
tomcat 8.5是基于Servlet 3.1和JavaServer Pages 2.3。

tomcat 测试war包下载路径 测试war包

server.xml 结构图(还有些其他元素没有加入)

1.1 server 配置

server 是server.xml 的最外层元素，常用的属性有：

1.2 service 配置

service 是 server 的内层。可以将一个多个service 放在server 层里，
一个service 里面可以有多个 Connector 和一个Engine .

service 的属性

1.3 Executor

官方文档链接
这个元素我们在平时配置的过程中用得比较少，它主要用于在多个connector 之间进行共享线程池。它的位置应该在 connector 之前，这样才能生效。

Executor 的属性 ：

1.4 Connector 配置

关于 Connector 官网链接
当前以下所有的说明是针对 tomcat 8.5版本来说的，其他版本详情见官方文档。

示例配置

 <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" 
               acceptCount="300" <!--默认值为100-->
               acceptorThreadCount="2" <!--默认值为1,在多核的情况下可设置该值-->
               compression="on" <!-- 开启对响应数据的压缩传输-->
               keepAliveTimeout="25000" <!-- 等待请求时间 默认值是使用为connectionTimeout属性设置的值 -->
               maxConnections="5000" <!-- 服务器在给定时间接受和处理的最大连接数，对于NIO和NIO2，默认值为10000。对于APR / native，默认为8192。-->
               maxThreads="400" <!-- 最大并发数,默认为200-->
               minSpareThreads="25" <!-- 始终保持运行的最小连接数，默认值为10-->
               />

maxThreads 配置说明(网上盗图，不提倡啊，哈哈)

1.5 Engine

Engine 结构示意图

Engine 的属性

Engine 必须嵌套在service 中。

Host(官网文档链接)

host 元素表示一个虚拟主机，我们常将一个主机与一个应用程序相连接
host 元素嵌套在Engine 元素里面。我们可以将Context 元素嵌套在Host元素里面。
Host 的属性

当autoDeploy 为true 时，tomcat 在启动后会监控部署的web应用程序的文件是否改变，根据具体的改变，web应用程序将重新加载或重新部署。重新部署的不会保留用户会话，重新加载的则会保留。

Context 中的docBase 的路径应该在appBase(Host)之外，否则可能会导致部署两次，属性deployIgnore可以避免这种情况。
如果在server.xml 中定义了Context 属性，则应该关闭deployIgnore,和自动部署应用程序。

日志记录(官网链接)

pattern

％a - 远程IP地址
％A - 本地IP地址
％b - 发送的字节数，不包括HTTP标头，如果为零则为“ - ”
％B - 发送的字节数，不包括HTTP标头
％h - 远程主机名（如果enableLookups连接器为false，则为IP地址 ）
％H - 请求协议
％l - 来自identd的远程逻辑用户名（始终返回' - '）
％m - 请求方法（GET，POST等）
％p - 收到此请求的本地端口。
％q - 查询字符串（前缀为'？'，如果存在）
％r - 请求首行（方法和请求URI）
％s - 响应的HTTP状态代码
％S - 用户会话ID
％t - 日期和时间，采用通用日志格式
％u - 经过身份验证的远程用户（如果有），否则为“ - ”
％U - 请求的URL路径
％v - 本地服务器名称
％D - 处理请求所用的时间(以毫秒为单位)
％T - 处理请求所用的时间，以秒为单位
％F - 提交响应所用的时间，以毫秒为单位
％I - 当前请求线程名称
％X - 响应完成时的连接状态：
    X =连接在响应完成之前中止。
    + =发送响应后，连接可以保持活动状态。
    - =发送响应后将关闭连接。

pattern="common" 对应于'％h％l％u％t“％r”％s％b'定义的通用日志格式 。
pattern="combined" 将 每个双引号中的Referer和User-Agent标题的值附加到common模式。

默认访问日志配置

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

请求过滤器(基于请求ip 官网链接)

基于ip地址对请求进行过滤处理。限制条件可以使用正则表达式，但是它和普通的正则语法有所不同，它采用的是java.util.regex 包。可以用";" 来分割端口限制。
拒绝请求时的行为可以更改为不拒绝，而是设置无效的authentication 标头。这与context属性 preemptiveAuthentication="true" 结合使用。

在过滤带有ipv6地址的请求的时候，需要注意过滤器匹配的ip地址格式，详细见官网。

示例：

1. 仅允许从localhost 连接

<Valve className="org.apache.catalina.valves.RemoteAddrValve"
   allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1"/>

1. 仅允许允许从localhost 连接，但其它客户端连接到8443的不受限制

<Valve className="org.apache.catalina.valves.RemoteAddrValve"
   addConnectorPort="true"
   allow="127\.\d+\.\d+\.\d+;\d*|::1;\d*|0:0:0:0:0:0:0:1;\d*|.*;8443"/>

3.允许任何客户端请求访问8009端口，其它端口要触发身份验证

<Context>
  ...  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         addConnectorPort="true"
         invalidAuthenticationWhenDeny="true"
         allow=".*;8009"/>
  <Valve className="org.apache.catalina.authenticator.BasicAuthenticator" />
  ...</Context>

请求过滤器（基于请求主机名 官网链接）

用于限制不符合条件的客户端，接收符合条件的客户端。
限制条件可以使用正则表达式，但是它和普通的正则语法有所不同，它采用的是java.util.regex 包。

拒绝请求时的行为可以更改为不拒绝，而是设置无效的authentication 标头。这与context属性 preemptiveAuthentication="true" 结合使用。

注意：此过滤器返回的值获取方法ServletRequest.getRemoteHost()需要获取正确的主机名。要允许该方法返回正确的主机名，您必须在 connector 上启用 enableLookups 参数。（因为该过滤器是基于主机名过滤，所以要开启获取主机名才能获取到主机名的值）

context 配置 (官网链接)

It is NOT recommended to place <Context> elements directly in the server.xml file.

建议我们不要将context 直接放在server.xml 文件里面，因为这样不太安全。放在conf/server.xml 下的话，如果不重新启动tomcat的话是无法加载里面的配置的。如果我们在其他位置也配置了context的话，是会覆盖server.xml 的配置的。如果我们仍要以server.xml 的文件为主的话，那么我们需要将context 的override 参数设置为true .
但我实际测试的话，发现不设置override为true ,在server.xml 和conf/Catalina/localhost/djx.xml 配置相同的path 名称，不同的war包最后还是server.xml 生效了。

context 元素定义的三种方式：

1. conf/server.xml (不建议)
   示例

<Context  path="/djx"  docBase="/tmp/svnadmin.war"/>

1. webapps/appname/META-INF/context.xml，
   示例： manager/META-INF/context.xml

<?xml version="1.0" encoding="UTF-8"?><!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
--><Context antiResourceLocking="false" privileged="true" >
  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1" />
  <Manager sessionAttributeValueClassNameFilter="java\.lang\.(?:Boolean|Integer|Long|Number|String)|org\.apache\.catalina\.filters\.CsrfPreventionFilter\$LruCache(?:\$1)?|java\.util\.(?:Linked)?HashMap"/></Context>

1. conf/Catalina/localhost/djx.xml ，文件名为访问路径，示例：

<Context docBase="/tmp/sample.war" reloadable="false" />

注意点
除了server.xml 外，任何定义Context的文件只能定义一个context 元素

context 的属性

Context 路径命名示例

WatchedResource 属性，用于监控war包后的解压文件，如果更改则自动重新加载
示例：

<WatchedResource>WEB-INF/web.xml</WatchedResource>

以上就是server.xml 的一些元素和属性，还有一些我们没有列举的，我们可以去官网文档查看。

作者：理想三旬

出处：https://www.cnblogs.com/operationhome/