[转]/tomcat/conf/server.xml配置文件的源码解析

备注:

在把Java项目直接放到/tomcat/webapps目录下时,server.xml的代码是不变的,端口为8080

你可以通过修改这个8080端口进行配置,以及配置<host>里面的<Context>进行虚拟路径映射的配置

而nginx与之不同,nginx的nginx.conf文件中需要配置的地方更多<example>

 

下面正式开始 源码的详解


server.xml通过对各个元素的配置可以实现对tomcat中各个组件的控制。(元素对应组件)

 


Tomcat的核心组件

<Server>
  <Service>
    <Connector />
    <Connector />
    <Engine>
      <Host>
        <Context />

        <!-- 现在常常使用自动部署,不推荐配置Context元素,Context小节有详细说明 -->
      </Host>
    </Engine>
  </Service>
</Server>

 

(1)顶层元素:Server

Server是根元素,Service则代表一个Engine元素以及一组与之相连的Connector元素

(2)连接器:Connector

Connector代表了外部客户端发送请求到特定的Service接口

同时,也是外部客户端从特定Service接受响应的接口

(3)容器:Engine、Host、Context

容器的功能是处理Connector接收进来的请求,并产生相应的响应。Engine、Host和Context都是容器,但它们不是平行的关系,而是父子关系:Engine包含Host,Host包含Context。

一个Engine组件可以处理Service中的所有请求,

一个Host组件可以处理发向一个特定虚拟主机的所有请求,

一个Context组件可以处理一个特定Web应用的所有请求。

(4)内嵌组件:可以内嵌到容器中的组件

Server、Service、Connector、Engine、Host和Context是最重要的最核心的Tomcat组件,其他组件都可以归为内嵌组件。

 


 下面介绍各个核心组件的作用特点以及配置方式

(1)Server

Server元素在最顶层,代表整个Tomcat容器,因此它必须是server.xml中唯一一个最外层的元素。

Server的主要任务,就是提供一个接口让客户端能够访问到这个Service集合(一个Server元素中可以有一个或多个Service元素),同时维护它所包含的所有的Service的声明周期,包括如何初始化、如何结束服务、如何找到客户端要访问的Service。

 

(2)Service

Service的作用,是在Connector和Engine外面包了一层,把它们组装在一起,对外提供服务。

其中Connector的作用是从客户端接收请求,Engine的作用是处理接收进来的请求。

<Service name="Catalina">

<Connector port="8080" protocol="HTTP/1.1" redirectPort="8443" />

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

一个Service可以包含多个Connector,但是只能包含一个Engine

默认代码中Server中包含了一个名称为“Catalina”的Service,实际上,Tomcat可以提供多个Service,不同的Service监听不同的端口(由Connector控制请求Service的协议和端口号)

 

(3)Connector

Connector的主要功能,是接收连接请求,创建Request和Response对象用于和请求端交换数据;然后分配线程让Engine来处理这个请求,并把产生的Request和Response对象传给Engine。通过配置Connector,可以控制请求Service的协议及端口号。

<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />

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

A、

通过配置第1个Connector,客户端可以通过8080端口号使用http协议访问Tomcat。

其中,protocol属性规定了请求的协议,port规定了请求的端口号,redirectPort表示当强制要求https而请求是http时,重定向至端口号为8443的Connector,connectionTimeout表示连接的超时时间。

在这个例子中,Tomcat监听HTTP请求,使用的是8080端口,而不是正式的80端口(tomcat默认配置都是8080);实际上,在正式的生产环境中,Tomcat也常常监听8080端口,而不是80端口。

这是因为在生产环境中,很少将Tomcat直接对外开放接收请求,而是在Tomcat和客户端之间加一层代理服务器(如nginx),用于A-请求的转发(转发到不同的tomcat中的项目模块)、B-负载均衡、C-处理静态文件(而不用tomcat亲自处理静态文件造成浪费)等;注意,通过代理服务器访问Tomcat时,是在局域网中,因此一般仍使用8080端口。

B、

通过配置第2个Connector,客户端可以通过8009端口号使用AJP协议访问Tomcat。

AJP协议负责和其他的HTTP服务器(如Apache)建立连接;在把Tomcat与其他HTTP服务器集成时,就需要用到这个连接器。之所以使用Tomcat和其他服务器集成,是因为Tomcat可以用作Servlet/JSP容器,但是对静态资源的处理速度较慢,不如Apache和IIS等HTTP服务器;因此常常将Tomcat与Apache等集成,前者作Servlet容器,后者处理静态资源,而AJP协议便负责Tomcat和Apache的连接(不过现在都是使用Nginx处理静态资源)。

 

(4)Engine

Engine是Service组件中的请求处理组件。

Engine组件从一个或多个Connector中接收请求并处理,并将完成的响应返回给Connector,最终传递给客户端。

Engine包含Host,Host包含Context。

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

其中,name属性用于日志和错误信息,在整个Server中应该唯一。defaultHost属性指定了默认的host名称,当发往本机的请求指定的host名称不存在时,一律使用defaultHost指定的host进行处理;因此,defaultHost的值,必须与Engine中的一个Host组件(其中的一个,不是所有的)的name属性值匹配。<Host name="localhost"

 

(5)Host

Host是Engine的子容器。

Engine组件中可以内嵌1个或多个Host组件,每个Host组件代表Engine中的一个虚拟主机

Host组件至少有一个,且其中一个的name必须与Engine组件的defaultHost属性相匹配

 

重点:Host的作用

Host组件是虚拟主机的作用,是运行多个Web应用(一个Context代表一个Web应用),并负责安装、展开、启动和结束每个Web应用。

Host组件代表的虚拟主机,对应了服务器中一个网络名实体(如”www.test.com”,或IP地址”116.25.25.25”);为了使用户可以通过网络名(即域名)连接Tomcat服务器,这个名字应该在DNS服务器上注册。

客户端通常使用主机名来标识它们希望连接的服务器;该主机名也会包含在HTTP请求头中。Tomcat从HTTP头中提取出主机名,寻找名称匹配的主机。如果没有匹配,请求将发送至默认主机。因此默认主机不需要是在DNS服务器中注册的网络名,因为任何与所有Host名称不匹配的请求,都会路由至默认主机,即defaultHost属性。

 

重点:Host的配置

<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应用的自动部署有关

 

(6)Context

Context元素代表在特定虚拟主机上运行的一个Web应用,比如放在Webapps下的某一个应用。

每个Web应用都是基于WAR文件,或WAR文件解压后对应的目录(这里称为应用目录)。

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

注意:在例子中,可以看到server.xml配置文件中并没有出现Context元素的配置。这是因为,Tomcat开启了自动部署,Web应用没有在server.xml中配置静态部署,而是由Tomcat通过特定的规则自动部署。除非我们需要作虚拟映射,不然一般都是选择自动部署。

 

重点:web应用自动部署

A、Host的配置

配置的方式就是前面提到的Host元素的deployOnStartup和autoDeploy属性。

如果deployOnStartup和autoDeploy设置为true,则tomcat启动自动部署:当检测到新的Web应用或Web应用的更新时,会触发应用的部署(或重新部署)。

二者的主要区别在于,deployOnStartup为true时,Tomcat在启动时检查Web应用,且检测到的所有Web应用视作新应用;

autoDeploy为true时,Tomcat在运行时定期检查新的Web应用或Web应用的更新。除此之外,二者的处理相似。(一般设置autoDeploy的属性值为true

 

通过配置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。

 

B、检查Web应用更新

一个Web应用可能包括以下文件:XML配置文件,WAR包,以及一个应用目录(该目录包含Web应用的文件结构);

其中XML配置文件位于xmlBase指定的目录,(打包好的web项目war包被自动部署的时候会把xml配置文件放到xmlBase指定的目录中

WAR包和应用目录位于appBase指定的目录。

 

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

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

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

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

备注:在进行手动修改这些目录下的文件时,tomcat会自动扫描进行重新刷新部署,无需重新启动tomcat

 

C、<Context>元素的配置【重点中的重点】

Context元素最重要的属性是pathdocBase,此外reloadable也比较常用。(通常配置的时候需要配置这三个属性)

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属性推导为””

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

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

 

实例:

1 <Context docBase="D:\Program Files\app1.war" reloadable="true"/>

在该例子中,docBase位于Host的appBase目录之外;path属性没有指定,而是根据app1.xml自动推导为”app1”;由于是在开发环境下,因此reloadable设置为true,便于开发调试。

 

备注:最典型的自动部署

当我们安装完Tomcat后,$TOMCAT_HOME/webapps目录下有几个目录,比如doc、examples、host-manager、ROOT

当我们启动Tomcat后,可以使用http://localhost:8080/来访问Tomcat,其实访问的就是ROOT对应的Web应用;

我们也可以通过http://localhost:8080/docs来访问docs应用,同理我们可以访问examples/host-manager/manager这几个Web应用

 

重点:server.xml中静态部署Web应用

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

静态部署与自动部署是可以共存的。

在实际应用中,并不推荐使用静态部署,因为server.xml 是不可动态重加载的资源,服务器一旦启动了以后,要修改这个文件,就得重启服务器才能重新加载

而自动部署可以在Tomcat运行时通过定期的扫描来实现,不需要重启服务器。

 

server.xml中使用Context元素配置Web应用,Context元素应该位于Host元素中。举例如下:

1 <Context path="/" docBase="D:\Program Files \app1.war" reloadable="true"/>

 


 了解更多的组件,以及它们之间的关系

比如Listener、GlobalNamingResource、Realm、Valve等

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

posted @ 2018-06-08 02:16  hoanfir  阅读(231)  评论(0编辑  收藏  举报