tomcat（2）- tomcat目录结果和配置文件

1 Tomcat目录结构
2 Tomcat的配置文件

1 Tomcat目录结构

tomcat安装完成后在安装目录下会存在下面几个目录：

[root@tomcat01 apps]# ll /apps/tomcat/*/ -d

drwxr-x--- 2 root root 4096 Jul  5 11:34 /apps/tomcat/bin/

drwx------ 3 root root  254 Jul  5 11:36 /apps/tomcat/conf/

drwxr-x--- 2 root root 4096 Jul  5 11:34 /apps/tomcat/lib/

drwxr-x--- 2 root root  132 Jul  5 11:36 /apps/tomcat/logs/

drwxr-x--- 2 root root   30 Jul  5 11:34 /apps/tomcat/temp/

drwxr-x--- 7 root root   81 Jun  9 00:31 /apps/tomcat/webapps/

drwxr-x--- 3 root root   22 Jul  5 11:36 /apps/tomcat/work/

bin目录

bin目录主要是用来存放tomcat的命令，主要有两大类，一类是以.sh结尾的（linux命令），另一类是以.bat结尾的（windows命令）。

很多环境变量的设置都在此处，例如可以设置JDK路径、TOMCAT路径。

startup 用来启动tomcat 。

shutdown 用来关闭tomcat 。

修改catalina可以设置tomcat的内存。
conf目录

conf目录主要是用来存放tomcat的一些配置文件。其中：
- server.xml为主配置文件，可以设置端口号、设置域名或IP、默认加载的项目、请求编码
- web.xml可以设置tomcat支持的文件类型
- context.xml可以用来配置数据源之类的
- tomcat-users.xml用来配置管理tomcat的用户与权限
- 在Catalina目录下可以设置默认加载的项目
lib目录

lib目录主要用来存放tomcat运行需要加载的jar包。

例如，像连接数据库的jdbc的包我们可以加入到lib目录中来。
logs目录

logs目录用来存放tomcat在运行过程中产生的日志文件，非常重要的是在控制台输出的日志。（清空不会对tomcat运行带来影响）。

在windows环境中，控制台的输出日志在catalina.xxxx-xx-xx.log文件中。

在linux环境中，控制台的输出日志在catalina.out文件中。
temp目录

temp目录用户存放tomcat在运行过程中产生的临时文件。（清空不会对tomcat运行带来影响）。
webapps目录

webapps目录用来存放应用程序。

当tomcat启动时会去加载webapps目录下的应用程序。可以为文件夹、war包、jar包的形式发布应用。

也可以把应用程序放置在磁盘的任意位置，在配置文件中映射好。
work目录

work目录用来存放tomcat在运行时的编译后文件，例如JSP编译后的文件。

清空work目录，然后重启tomcat，可以达到清除缓存的作用。

2 Tomcat的配置文件

2.1 server.xml配置文件

[root@tomcat01 ~]# cat /apps/tomcat/conf/server.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--server表示tomcat一个实例，通过8005端口可以远程关闭tomcat服务-->

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

  <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />

  <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />

  <GlobalNamingResources>

    <!--base认证模块，所有站点都能使用，conf/tomcat-users.xml文件定义-->

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

  <!--http连接器，处理请求和响应。-->

  <Service name="Catalina">

    <!--连接器，用于接收用户请求，指定监听的端口-->

    <Connector port="8080" protocol="HTTP/1.1"

               connectionTimeout="20000"

               redirectPort="8443" />

    <!--HTTPS相关配置-->

    <Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"

               maxThreads="150" SSLEnabled="true">

        <UpgradeProtocol className="org.apache.coyote.http2.Http2Protocol" />

        <SSLHostConfig>

            <Certificate certificateKeystoreFile="conf/localhost-rsa.jks"

                         type="RSA" />

        </SSLHostConfig>

    </Connector>

    <!--ajp连接器，apapche代理tomcat使用mod_jk模块使用该协议-->

    <Connector protocol="AJP/1.3"

               address="::1"

               port="8009"

               redirectPort="8443" />

    <!--Engine引擎，用于处理用户请求-->

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

      <!--调用认证配置-->

      <Realm className="org.apache.catalina.realm.LockOutRealm">

        <Realm className="org.apache.catalina.realm.UserDatabaseRealm"

               resourceName="UserDatabase"/>

      </Realm>

      <!--host定义一个虚拟主机-->

      <Host name="localhost"  appBase="webapps"

            unpackWARs="true" autoDeploy="true">

        <Valve className="org.apache.catalina.authenticator.SingleSignOn" />

        <!--定义本虚拟主机的访问日志名称和格式-->

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

2.2 server.xml配置文件结构

conf/server.xml文件为tomcat的主配置文件，其整体层次结构如下：

<Server>

    <Service>

        <Connector />

        <Connector />

        <Engine>

            <Host>

                <Context /><!-- 现在常常使用自动部署，不推荐配置Context元素-->

            </Host>

        </Engine>

    </Service>

</Server>

以上各个核心组件的说明如下：

server

Server元素在最顶层，代表整个Tomcat容器，因此它必须是server.xml中唯一一个最外层的元素。一个Server元素中可以有一个或多个Service元素。

Server的主要任务，就是提供一个接口让客户端能够访问到这个Service集合，同时维护它所包含的所有的Service的声明周期，包括如何初始化、如何结束服务、如何找到客户端要访问的Service。
```
<Server port="8005" shutdown="SHUTDOWN">

其中shutdown属性表示关闭Server的指令；port属性表示Server接收shutdown指令的端口号，设为-1可以禁掉该端口。
```
service

Service的作用，是在Connector和Engine外面包了一层，把它们组装在一起，对外提供服务。一个Service可以包含多个Connector，但是只能包含一个Engine；其中Connector的作用是从客户端接收请求，Engine的作用是处理接收进来的请求。
```
<Service name="Catalina">
```

connector

Connector的主要功能，是接收连接请求，创建Request和Response对象用于和请求端交换数据；然后分配线程让Engine来处理这个请求，并把产生的Request和Response对象传给Engine。

通过配置Connector，可以控制请求Service的协议及端口号。

    <Connector port="8080" protocol="HTTP/1.1"

               connectionTimeout="20000"

               redirectPort="8443" />

<!--客户端可以通过8080端口号使用http协议访问Tomcat。其中，protocol属性规定了请求的协议，port规定了请求的端口号，redirectPort表示当强制要求https而请求是http时，重定向至端口号为8443的Connector，connectionTimeout表示连接的超时时间。  

在这个例子中，Tomcat监听HTTP请求，使用的是8080端口，而不是正式的80端口；实际上，在正式的生产环境中，Tomcat也常常监听8080端口，而不是80端口。这是因为在生产环境中，很少将Tomcat直接对外开放接收请求，而是在Tomcat和客户端之间加一层代理服务器(如nginx)，用于请求的转发、负载均衡、处理静态文件等；通过代理服务器访问Tomcat时，是在局域网中，因此一般仍使用8080端口。-->

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

<!--户端可以通过8009端口号使用AJP协议访问Tomcat。AJP协议负责和其他的HTTP服务器(如Apache)建立连接；在把Tomcat与其他HTTP服务器集成时，就需要用到这个连接器。之所以使用Tomcat和其他服务器集成，是因为Tomcat可以用作Servlet/JSP容器，但是对静态资源的处理速度较慢，不如Apache和IIS等HTTP服务器；因此常常将Tomcat与Apache等集成，前者作Servlet容器，后者处理静态资源，而AJP协议便负责Tomcat和Apache的连接。-->

engine

Engine组件在Service组件中有且只有一个；Engine是Service组件中的请求处理组件。Engine组件从一个或多个Connector中接收请求并处理，并将完成的响应返回给Connector，最终传递给客户端。

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

<!--

其中，name属性用于日志和错误信息，在整个Server中应该唯一。

defaultHost属性指定了默认的host名称，当发往本机的请求指定的host名称不存在时，一律使用defaultHost指定的host进行处理；因此，defaultHost的值，必须与Engine中的一个Host组件的name属性值匹配。

-->

host

Host是Engine的子容器。Engine组件中可以内嵌1个或多个Host组件，每个Host组件代表Engine中的一个虚拟主机。Host组件至少有一个，且其中一个的name必须与Engine组件的defaultHost属性相匹配。

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

<!--

其中：name属性指定虚拟主机的主机名，一个Engine中有且仅有一个Host组件的name属性与Engine组件的defaultHost属性相匹配；一般情况下，主机名需要是在DNS服务器中注册的网络名，但是Engine指定的defaultHost不需要。

unpackWARs指定了是否将代表Web应用的WAR文件解压；如果为true，通过解压后的文件结构运行该Web应用，如果为false，直接使用WAR文件运行Web应用。

Host的autoDeploy和appBase属性，与Host内Web应用的自动部署有关；此外，本例中没有出现的xmlBase和deployOnStartup属性，也与Web应用的自动部署有关；

-->

context

Context元素代表在特定虚拟主机上运行的一个Web应用，类似于nginx中的location。

Context是Host的子容器，每个Host中可以定义任意多的Context元素。

在上面配置文件的示例中，可以看到server.xml配置文件中并没有出现Context元素的配置。这是因为，Tomcat开启了自动部署，Web应用没有在server.xml中配置静态部署，而是由Tomcat通过特定的规则自动部署。

<Context path="/test" docBase="/code/test" reloadable="true"/>

<!--

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

path指定了访问该Web应用的上下文路径，当请求到来时，Tomcat根据Web应用的 path属性与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应用来处理。

需要注意的是，在自动部署场景下(配置文件位于xmlBase中)，不能指定path属性，path属性由配置文件的文件名、WAR文件的文件名或应用目录的名称自动推导出来。如扫描Web应用时，发现了xmlBase目录下的app1.xml，或appBase目录下的app1.WAR或app1应用目录，则该Web应用的path属性是”app1”。如果名称不是app1而是ROOT，则该Web应用是虚拟主机默认的Web应用，此时path属性推导为””。

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

上例中，访问http://www.tomcat.com/test会映射为/code/test

-->

2.3 WEB应用自动部署

要开启Web应用的自动部署，需要配置所在的虚拟主机；配置的方式就是前面提到的Host元素的deployOnStartup和autoDeploy属性。如果deployOnStartup和autoDeploy设置为true，则tomcat启动自动部署：当检测到新的Web应用或Web应用的更新时，会触发应用的部署(或重新部署)。二者的主要区别在于，deployOnStartup为true时，Tomcat在启动时检查Web应用，且检测到的所有Web应用视作新应用；autoDeploy为true时，Tomcat在运行时定期检查新的Web应用或Web应用的更新。除此之外，二者的处理相似。

通过配置deployOnStartup和autoDeploy可以开启虚拟主机自动部署Web应用；实际上，自动部署依赖于检查是否有新的或更改过的Web应用，而Host元素的appBase和xmlBase设置了检查Web应用更新的目录。

其中，appBase属性指定Web应用所在的目录，默认值是webapps，这是一个相对路径，代表Tomcat根目录下webapps文件夹。

xmlBase属性指定Web应用的XML配置文件所在的目录，默认值为conf/<engine_name>/<host_name>，例如前面的例子中，主机localhost的xmlBase的默认值是$TOMCAT_HOME/conf/Catalina/localhost。

一个Web应用可能包括以下文件：XML配置文件，WAR包，以及一个应用目录(该目录包含Web应用的文件结构)；其中XML配置文件位于xmlBase指定的目录，WAR包和应用目录位于appBase指定的目录。

Tomcat按照如下的顺序进行扫描，来检查应用更新：

A、扫描虚拟主机指定的xmlBase下的XML配置文件

B、扫描虚拟主机指定的appBase下的WAR文件

C、扫描虚拟主机指定的appBase下的应用目录

注意：应用目录要使用ROOT作为目录名，例如tomcat默认的WEB应用，即部署完tomcat后的主页文件：

[root@tomcat01 ~]# ll /apps/tomcat/webapps/ROOT/

asf-logo-wide.svg  bg-button.png      bg-middle.png      bg-nav.png         bg-upper.png       favicon.ico        index.jsp    RELEASE-NOTES.txt  tomcat.css         tomcat.svg         WEB-INF/

除了自动部署，我们也可以在server.xml中通过<context>元素静态部署Web应用。静态部署与自动部署是可以共存的。

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

2.4 配置文件各个组件的关联

各个组件的关系如下图：

当请求被发送到Tomcat所在的主机时，如何确定最终哪个Web应用来处理该请求呢？

根据协议和端口号选定Service和Engine

Service中的Connector组件可以接收特定端口的请求，因此，当Tomcat启动时，Service组件就会监听特定的端口。在之前的配置文件中，Catalina这个Service监听了8080端口（基于HTTP协议）和8009端口（基于AJP协议）。当请求进来时，Tomcat便可以根据协议和端口号选定处理请求的Service；Service一旦选定，Engine也就确定。

通过在Server中配置多个Service，可以实现通过不同的端口号来访问同一台机器上部署的不同应用。
根据域名或IP地址选定Host

Service确定后，Tomcat在Service中寻找名称与客户端请求的域名/IP地址匹配的Host处理该请求。如果没有找到，则使用Engine中指定的defaultHost来处理该请求。在前面的例子中，由于只有一个Host（name属性为localhost），因此该Service/Engine的所有请求都交给该Host处理。
根据URI选定Context/Web应用

Tomcat根据应用的path属性与URI的匹配程度来选择Web应用处理相应请求。

若应用为自动部署，没有context字段，则找到host后就去此虚拟主机中制定的appBase目录中，将解析产生的结果返回给用户。
举例

以请求http://localhost:8080/app1/index.jsp为例，首先通过协议和端口号（http和8080）选定Service；然后通过主机名（localhost）选定Host；然后通过uri（/app1/index.html）选定Web应用。

2.5 虚拟主机配置示例

以下配置了两个虚拟主机，分别是tomcat1.xuzhichao.com和tomcat2.xuzhichao.com，他们的资源目录分别是/data/tomcat/code1和/data/tomcat/code2，访问日志文件名分别是：tomcat1_access_log和tomcat2_access_log。

      <Host name="tomcat1.xuzhichao.com"  appBase="/data/tomcat/code1"

            unpackWARs="true" autoDeploy="true">

        <Valve className="org.apache.catalina.authenticator.SingleSignOn" />

        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"

               prefix="tomcat1_access_log" suffix=".txt"

               pattern="%h %l %u %t &quot;%r&quot; %s %b" />

      <Host name="tomcat2.xuzhichao.com"  appBase="/data/tomcat/code2"

            unpackWARs="true" autoDeploy="true">

        <Valve className="org.apache.catalina.authenticator.SingleSignOn" />

        <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"

               prefix="tomcat2_access_log" suffix=".txt"

               pattern="%h %l %u %t &quot;%r&quot; %s %b" />

2.6 tomcat日志文件

logs/catalina.out

该文件主要记录tomcat启动信息，若tomcat无法启动，参考此日志文件的启动报错。
logs/localhost.xxx.log

该文件主要记录tomcat的虚拟主机的客户端访问日志。