tomcat--目录结构和文件组成

目录结构

目录	说明
bin	服务启动，停止等相关程序和文件
conf	配置文件
lib	库目录
logs	日志记录
webapps	应用程序，应用部署目录
work	jsp编译后的结果文件，建议提前预热访问

/usr/local/apache-tomcat-8.5.100/work/Catalina/localhost/ROOT/org/apache/jsp更新时在这里删除缓存

配置文件

官方文档：Apache Tomcat 8 (8.5.100) - Documentation Index

文件名	说明
server.xml	主配置文件
web.xml	每个webapp只有“部署”后才能被访问，它的部署方式通常由web.xml进行定义，其存放位置为WEB-INF/目录中；此文件为所有的webapps提供默认部署相关的配置,每个web应用也可以使用专用配置文件,来覆盖全局文件
context.xml	用于定义所有web应用均需加载的Context配置，此文件为所有的webapps提供默认配置，每个web应用也可以使用自已专用的配置，它通常由专用的配置文件context.xml来定义，其存放位置为WEB-INF/目录中,覆盖全局的文件
tomcat-users.xml	用户认证的账号和密码文件
catalina.policy	当使用security选项启动tomcat时，用于为tomcat设置安全策略
catalina.properties	Tomcat 环境变量的配置，用于设定类加载器路径，以及一些与JVM调优相关参数
logging.properties	Tomcat 日志系统相关的配置，可以修改日志级别和日志路径等

日志文件

参考文档：Logging - Apache Tomcat - Apache Software Foundation

日志格式: Apache Tomcat 9 Configuration Reference (9.0.89) - The Valve Component

参数

%a - 远程IP地址。另见%{xxx}a，下方有更多说明。
%A - 本地IP地址
%b - 不包括HTTP头部的发送字节数，如果为零则显示'-'。
%B - 不包括HTTP头部的发送字节数。
%D - 处理请求所花费的时间（毫秒）。注意：在httpd中%D表示微秒。Tomcat 10及以后版本将与httpd的行为保持一致。
%F - 提交响应所花费的时间，以毫秒为单位。
%h - 远程主机名（如果连接器的enableLookups为false，则为IP地址）
%H - 请求协议
%I - 当前请求线程的名称（可用于后续与堆栈跟踪比较）
%l - 从identd获取的远程逻辑用户名（始终返回'-'）
%m - 请求方法（GET、POST等）
%p - 接收到此请求的本地端口。另见%{xxx}p，下方有更多说明。
%q - 查询字符串（如果存在，则以'?'开头）
%r - 请求的第一行（方法和请求URI）
%s - 响应的HTTP状态码
%S - 用户会话ID
%t - 日期和时间，采用通用日志格式
%T - 处理请求所花费的时间，以秒为单位。注意：这个值有毫秒级的精度，而在httpd中是秒级精度。Tomcat 10及以后版本将与httpd的行为对齐。
%u - 经过认证的远程用户（如果有的话），否则为'-'（如需可转义）
%U - 请求的URL路径
%v - 本地服务器名
%X - 响应完成后连接的状态：
    X = 连接在响应完成前被中止。
    + = 响应发送后连接可能保持活动。
    - = 响应发送后连接将关闭。

%{xxx}a - 写入远程地址（客户端）（xxx等于remote时）或连接对等端地址（xxx等于peer时）
%{xxx}i - 写入名为xxx的传入头部的值（如需可转义）
%{xxx}o - 写入名为xxx的传出头部的值（如需可转义）
%{xxx}c - 写入名为xxx的Cookie值（逗号分隔，如需可转义）
%{xxx}r - 写入名为xxx的ServletRequest属性的值（如需可转义，如果request为null则值为??）
%{xxx}s - 写入名为xxx的HttpSession属性的值（如需可转义，如果request为null则值为??）
%{xxx}p - 写入本地（服务器）端口（xxx等于local时）或远程（客户端）端口（xxx等于remote时）
%{xxx}t - 使用增强的SimpleDateFormat模式xxx格式化请求结束时的时间戳并写入

文件

[root@localhost ~]# ls /usr/local/apache-tomcat-8.5.100/logs/ -1
catalina.2024-05-14.log   tomcat服务日志
catalina.out       tomcat服务日志
host-manager.2024-05-14.log host manager管理日志
localhost.2024-05-14.log      默认主机日志
localhost_access_log.2024-05-14.txt      默认主机访问日志
manager.2024-05-14.log     manager 管理日志

文件格式

[root@localhost ~]# tail /usr/local/apache-tomcat-8.5.100/conf/server.xml
             Documentation at: /docs/config/valve.html
             Note: The pattern used is equivalent to using pattern="common" -->
        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
               prefix="localhost_access_log" suffix=".txt"
               pattern="%h %l %u %t "%r" %s %b" />

      </Host>
    </Engine>
</Service>
</Server>

查看访问文件

组件

分层和分类

参考：Tomcat的配置文件_tomcat配置文件-CSDN博客

顶级组件

Server，代表整个Tomcat容器，一台主机可以启动多tomcat实例，需要确保端口不要产生冲突

服务类组件

Service，实现组织Engine和Connector，建立两者之间关联关系, service 里面只能包含一个Engine

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

连接器组件

Connector，有HTTP（默认端口8080/tcp）、HTTPS（默认端口8443/tcp）、AJP（默认端口
8009/tcp）协议的连接器，AJP（Apache Jserv protocol）是一种基于TCP的二进制通讯协议。

address：指定连接器监听的地址，默认为所有地址，即0.0.0.0；
maxThreads：支持的最大并发连接数，默认为200；
port：监听的端口，默认为0；
protocol：连接器使用的协议，默认为HTTP/1.1，定义AJP协议时通常为AJP/1.3；
redirectPort：如果某连接器支持的协议是HTTP，当接收客户端发来的HTTPS请求时，则转发至此属性定义的端口；
connectionTimeout：等待客户端发送请求的超时时间，单位为毫秒，默认为60000，即1分钟；
enableLookups：是否通过request.getRemoteHost()进行DNS查询以获取客户端的主机名；默认为true；
acceptCount：设置等待队列的最大长度；通常在tomcat所有处理线程均处于繁忙状态时，新发来的请求将被放置于等待队列中；

容器类

Engine、Host（虚拟主机）、Context(上下文件,解决路径映射)都是容器类组件，可以嵌入其它组件，内部配置如何运行应用程序。

Engine：

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

Host:

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

Context:

docBase：相应的Web应用程序的存放位置；也可以使用相对路径，起始路径为此Context所属Host中appBase定义的路径；切记，docBase的路径名不能与相应的Host中appBase中定义的路径名有包含关系，比如，如果appBase为deploy，而docBase绝不能为deploy-bbs类的名字；
path：相对于Web服务器根路径而言的URI；如果为空“”，则表示为此webapp的根路径；如果context定义在一个单独的xml文件中，此属性不需要定义；
reloadable：是否允许重新加载此context相关的Web应用程序的类；默认为false

内嵌类

可以内嵌到其他组件内，valve、logger、realm、loader、manager等。以logger举例，在不同容器组件内分别定义。

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的访问控制功能；

参数：

className：相关的java实现的类名，相应于分别应该为org.apache.catalina.valves.RemoteHostValve或org.apache.catalina.valves.RemoteAddrValve；
allow：以逗号分开的允许访问的IP地址列表，支持正则表达式，因此，点号“.”用于IP地址时需要转义；仅定义allow项时，非明确allow的地址均被deny；
deny: 以逗号分开的禁止访问的IP地址列表，支持正则表达式；使用方式同allow；

realm:

JAASRealm：基于Java Authintication and Authorization Service实现用户认证；
JDBCRealm：通过JDBC访问某关系型数据库表实现用户认证；
JNDIRealm：基于JNDI使用目录服务实现认证信息的获取；
MemoryRealm：查找tomcat-user.xml文件实现用户信息的获取；
UserDatabaseRealm：基于UserDatabase文件(通常是tomcat-user.xml)实现用户认证，它实现是一个完全可更新和持久有效的MemoryRealm，因此能够跟标准的MemoryRealm兼容；它通过JNDI实现；

manager:

StandardManager
Tomcat6的默认会话管理器，用于非集群环境中对单个处于运行状态的Tomcat实例会话进行管理。当Tomcat关闭时，这些会话相关的数据会被写入磁盘上的一个名叫SESSION.ser的文件，并在Tomcat下次启动时读取此文件。
PersistentManager
当一个会话长时间处于空闲状态时会被写入到swap会话对象，这对于内存资源比较吃紧的应用环境来说比较有用。
DeltaManager
用于Tomcat集群的会话管理器，它通过将改变了会话数据同步给集群中的其它节点实现会话复制。这种实现会将所有会话的改变同步给集群中的每一个节点，也是在集群环境中用得最多的一种实现方式。
BackupManager
用于Tomcat集群的会话管理器，与DeltaManager不同的是，某节点会话的改变只会同步给集群中的另一个而非所有节点。
SimpleTcpReplicationManager

集群类组件

listener、cluste

内部组成

名称	说明
Server	服务器，Tomcat 运行的进程实例，一个Server中可以有多个service，但通常就一个
Service	服务，用来组织Engine和Connector的对应关系，一个service中只有一个Engine
Connector	连接器，负责客户端的HTTP、HTTPS、AJP等协议连接。一个Connector只属于某一个Engine
Engine	即引擎，用来响应并处理用户请求。一个Engine上可以绑定多个Connector
Host	即虚拟主机,可以实现多虚拟主机,例如使用不同的主机头区分
Context	应用的上下文，配置特定url路径映射和目录的映射关系：url => director

每一个组件都由一个Java“类”实现，这些组件大体可分为以下几个类型：

顶级组件：Server
服务类组件：Service
连接器组件：http, https, ajp（apache jserv protocol）
容器类：Engine, Host, Context
被嵌套类：valve, logger, realm, loader, manager, ...
集群类组件：listener, cluster, ...

核心组件

Tomcat启动一个Server进程。可以启动多个Server，即tomcat的多实例, 但一般只启动一个
创建一个Service提供服务。可以创建多个Service，但一般也只创建一个

每个Service中，是Engine和其连接器Connector的关联配置

可以为这个Service提供多个连接器Connector，这些Connector使用了不同的协议，绑定了不同的
端口。其作用就是处理来自客户端的不同的连接请求或响应
Service 内部还定义了Engine，引擎才是真正的处理请求的入口，其内部定义多个虚拟主机Host

Engine对请求头做了分析，将请求发送给相应的虚拟主机
如果没有匹配，数据就发往Engine上的defaultHost缺省虚拟主机
Engine上的缺省虚拟主机可以修改

Host 定义虚拟主机，虚拟主机有name名称，通过名称匹配
Context 定义应用程序单独的路径映射和配置

<?xml version="1.0" encoding="UTF-8"?>
<Server port="8005" shutdown="SHUTDOWN">
  <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">
       <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">
          <Context >
          <Context />
       </Host>
    </Engine>
  </Service>
</Server>

tomcat 处理请求过程

浏览器端的请求被发送到服务端端口8080，Tomcat进程监听在此端口上。通过侦听的HTTP/1.1Connector获得此请求。
Connector把该请求交给它所在的Service的Engine来处理，并等待Engine的响应
Engine获得请求localhost:8080/test/index.jsp，遍历它所有虚拟主机Host
Engine匹配到名为localhost的Host。如果匹配不到,就把请求交给该Engine中的defaultHost处理
localhost Host获得请求/test/index.jsp，匹配它所拥有的所有Context
Host匹配到路径为/test的Context
path=/test的Context获得请求index.jsp，在它的mapping table中寻找对应的servlet
Context匹配到URL PATTERN为 *.jsp 的servlet，对应于JspServlet类构造HttpServletRequest对象和HttpServletResponse对象，作为参数调用JspServlet的doGet或doPost方法。
Context把执行完了之后的HttpServletResponse对象返回给Host
Host把HttpServletResponse对象返回给Engine
Engine把HttpServletResponse对象返回给Connector
Connector把HttpServletResponse对象返回给浏览器端