tomcat的server.xml详解

文章目录1 概述1.1 Server元素1.1.1 tomcat部署多应用2 server.xml文件2.1 配置`Server`元素2.2 配置Service元素2.3 配置Engine元素2.4 配置Host元素2.5 配置Context元素2.6 配置Connector元素2.6.1 HttpConnector2.6.2 JKConnector1 概述Tomcat服务器是由一系列可配置的..

爱吃牛肉的大老虎

12873人浏览 · 2020-01-03 18:38:11

爱吃牛肉的大老虎 · 2020-01-03 18:38:11 发布

文章目录

1 概述
2 server.xml文件
3 标签汇总

1 概述

Tomcat服务器是由一系列可配置的组件构成，其核心组件是Catalina Servlet容器，它是所有其他Tomcat组件的顶层容器。Tomcat的组件可以在<CATALINA_HOME>/conf/server.xml文件中进行配置,每个Tomcat的组件在server.xml文件中对应一种配置元素.

1.1 tomcat安装目录介绍

tomcat安装目录介绍：

bin:其中存放各种不同平台开启与关闭Tomcat服务器的脚本文件
lib:存放tomcat与web应用的jar包，如果使用连接池，数据库驱动放置于此
conf:存放tomcat的配置文件，其中server.xml文件就在此处
webapps:web应用的发布目录
work:各web应用中由jsp转译生成的Java（servlet）文件存放的地方
logs:存放tomcat的运行日志
temp:存放tomcat运行时生成的临时文件的地方

在tomcat服务器的webapps目录中，存放的是当前服务器管理的项目。一个tomccat服务器可以管理和运行多个项目，每个项目是以独立的文件夹形式存放于webapps目录下
Tomcat服务器的默认端口号是8080，如果要更改此端口号，可以进入Tomcat安装目录\conf下，使用任意文本工具打开server.xml文件
有三处的port需要更改：

<Server port="8006" shutdown="SHUTDOWN">
<Connector port="8081" protocol="HTTP/1.1"
                   connectionTimeout="20000"
                   URIEncoding="UTF-8"（可以避免get提交中文乱码问题）
                   redirectPort="8443" />
<Connector port="8010" protocol="AJP/1.3" redirectPort="8443" />

第二个端口处添加的： URIEncoding="UTF-8"，可以避免get提交中文乱码问题，同时，在此目录中的tomcat-users.xml文件中，可以设置管理员的用户名和密码：

<user username="admin" password="在此输入密码" 
roles="admin,manager"/>

以下代码以XML的形式展示了各种Tomcat组件之间的关系

1.2 server.xml文件

server.xml样板文件内容：

<?xml version="1.0" encoding="utf-8" ?>
<Server port="8005" shutdown="SHUTDOWN">
	<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
	<Listener className="org.apache.catalina.core.JasperListener" />
	<Listener className="org.apache.catalina.mbeans.ServerLifecycleListener" />
	<Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
	<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>
	<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="SpringMVC">
			<Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase" />
			<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" 	
			     xmlNamespaceAware="false">
			<!--HelloMule-->
			<!--
				<Context path="/mule" docBase="/var/www/webapp/Mule"
				workDir="/var/www/webtemp/Mule" debug="5" reloadable="false"
				crossContext="true" />
			-->
			</Host>
			<Host name="SpringMVC" appBase="/var/www/webapp/SpringMVC"
				unpackWARs="true" autoDeploy="false" xmlValidation="false"
				xmlNamespaceAware="false" />
		</Engine>
	</Service>
</Server>

1.3 Server元素

代表了整个Catalina Servlet容器,它是Tomcat实例的顶层元素.可包含一个或多个<Service>元素.
<Service>元素—不同端口部署不同应用则复制多个Service，包含一个<Engine>元素,以及一个或多个<Connector>元素,这些<Connector>元素共享同一个<Engine>元素.

<Connector>元素代表和客户程序实际交互的组件,他负责接收客户请求,以及向客户返回响应结果.

<Engine>元素—虚拟主机，每个<Service>元素只能包含一个<Engine>元素. <Engine>元素处理在同一个<Service>中所有<Connector>元素接收到的客户请求.

<Host>元素一个<Engine>元素中可以包含多个<Host>元素.每个<Host>元素定义了一个虚拟主机,它可以包含一个或多个Web应用.

<Context>元素—同一端口部署多个应用则复制多个Context
每个<Context>元素代表了运行虚拟主机上的单个Web应用.一个<Host>元素中可以包含多个<Context>元素.
Tomcat服务器是由一系列可配置的组件构成,Tomcat的组件可以在<CATALINA_HOME>\conf\server.xml文件中进行配置,每个Tomcat组件和server.xml文件中的一种配置元素对应.下面就一些常用的元素做了介绍.关于server.xml的更多信息,可以参考Tomcat的文档:
<CATALINA_HOME>/webapps/tomcat-docs/config/index.html

2 server.xml文件

下面是server.xml文件的样例:

2.1 配置Server元素

<Server>元素代表了整个Catalina Servler容器,它是Tomcat实例的顶层元素,由org.apache.catalina.Server接口来定义.<Server>元素中可以包含一个或者多个<Service>元素,但<Server>元素不能作为任何其他元素的子元素.范例代码中定义的<Server>元素如下:

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

className:指定实现org.apache.catalina.Server接口的类,默认值为org.apache.catalina.core.StandardServer.
port:指定Tomcat服务器监听shutdown命令的端口.终止Tomcat服务运行时,必须在Tomcat服务器所在的机器上发出Shutdown命令.该属性是必须设定的.
shutdown:指定终止Tomcat服务器运行时,发给Tomcat服务器的shutdown监听端口的字符串.该属性是必须设定的.

2.2 配置Service元素

<Service>元素由org.apache.catalina.Service接口定义,它包含一个<Engine>元素,以及一个或多个<Connector>元素,这些<Connector>元素共享一个<Engine>元素. 例如,在范例文件中配置了两个<Service>元素

          <Service     name="Catalina">

className：指定实现org.apache.catalina.Service接口的类,默认值为org.apache.catalina.core.StandardService.
name定义Service的名字.

2.3 配置Engine元素

<Engine>元素由org.apahe.catalina.Engine接口定义.
每个<Service>元素只能包括一个<Engine>元素. <Engine>元素处理在同一个<Service>中所有<Connector>元素接收到的客户请求.
例如,在范例server.xml文件中配置了以下的<Engine>元素:

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

className:指定实现org.apache.catalina.Engine接口的类,默认值为org.apache.catalina.core.StandardEngine.
name:定义Engine的名字.
defaultHost:指定缺省的处理请求的主机名，它至少与其中的一个host元素的name属性值是一样的

在<Engine>元素中可以包含如下的子元素:<Logger>,<Realm>,<Valve>,<Host>

2.4 配置Host元素

<Host>元素由org.apache.catalina.Host接口定义.一个<Engine>元素可以包含多个<Host>元素.每个<Host>元素定义了一个虚拟主机,它可以包含一个或多个Web应用.
例如,在样例server.xml中配置了以下<Host>元素:

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

className:指定实现org.apache.catalina.Host接口的类,默认值为org.apache.catalina.core.StandardHost.
appBase:指定虚拟主机的目录,可以指定绝对目录,也可以指定相对于<CATALINA_HOME>的相对目录.如果此项没有设定,默认值为<CATALINA_HOME>/webapps.
unpackWARs:如果此项设为true,表示将把Web应用的WAR文件先展开为开放目录结构后再运行.如果设为false,将直接运行WAR文件.
autoDeploy:如果此项设为true,表示当Tomcat服务器处于运行状态时,能够监测appBase下的文件,如果有新的Web应用加入进来,会自动发布这个Web应用.
alias:指定虚拟主机的别名,可以指定多个别名.
deployOnStartup:如果此项设为true,表示Tomcat服务器启动时会自动发布appBase目录下的所有Web应用,
如果Web应用在server.xml中没有相应的<Context>元素,将采用Tomcat默认的Context. deployOnStartup的默认值为true.
name:定义虚拟主机的名字.

在<Host>元素中可以包含如下的子元素:<Logger>, <Realm>,<Valve>,<Context>

2.5 配置Context元素

<Context>元素由org.apache.catalina.Context接口定义.
<Context>元素是使用最频繁的元素.每个<Context>元素代表了运行在虚拟主机上的单个Web应用. 一个<Host>元素中可以包含多个<Context>元素. 例如,在样例server.xml文件中配置了以下<Context>元素:

　　　<Context path="/sample" docBase="sample" debug="0" reloadable="true">

className:指定实现org.apache.catalina.Context接口的类,默认值为org.apache.catalina.core.StandardContext.
path:指定访问该Web应用的URL入口.
docBase:指定Web应用的文件路径.可以给定绝对路径,也可以给定相对于Host的appBase属性的相对路径.如果Web应用采用开放目录结构,那就指定Web应用的根目录;如果Web应用是个WAR文件,那就指定WAR文件的路径.
reloadable:如果这个属性设为true,Tomcat服务器在运行状态下会监视在WEB-INF/class和WEB-INF/lib目录下CLASS文件的改动.如果检测到有calss文件被更新,服务器会自动重新加载Web应用.
cookies:指定是否通过Cookie来支持Session,默认为true.
useNaming:指定是否支持JNDI,默认为true.

在<Context>元素中可以包含如下的子元素:<Logger>,<Realm>,<Valve>,<Resource>,<ResourceParams>

但是在tomcat 5.5之后
不推荐在server.xml中进行配置，而是在/conf/context.xml中进行独立的配置。因为 server.xml 是不可动态重加载的资源，服务器一旦启动了以后，要修改这个文件，就得重启服务器才能重新加载。而 context.xml文件则不然，tomcat服务器会定时去扫描这个文件。一旦发现文件被修改（时间戳改变了），就会自动重新加载这个文件，而不需要重启服务器

2.6 appbase和docbase区别

appbase和docbase都是指向应用目录
appbase这个目录表示，这个目录下的子目录自动部署为应用，这个目录下的.war文件自动解压缩并部署为应用，而docbase只是指向了某个应用目录，可以和appbase没有关系

默认情况下（appBase=webapps，无Context标签），会把webapps目录下的war包解压到webapps目录，要带包名访问
appBase指定目录下的war包都会被自动解压为对应的包，例如demo.war会被解压到demo目录下。
war包位置，是根据appBase + docBase来确定的
war包解压的目录，是根据appBase + path来确定的，path为/则默认会解压到ROOT目录，path="/a"，则会解压在a目录。
ROOT或a目录所在的目录，是appBase来确定的。如果appBase=""，则在tomcat根目录；如果appBase=“webapps”，则目录生成在webapps目录下
如果docbase是绝对路径，那么appbase就无效

2.7 配置Connector元素

<Connector>元素由org.apache.catalina.Connector接口定义.<Connector>元素代表与客户程序实际交互的组件,它负责接收客户的请求,以及向客户返回响应结果.例如,在样例server.xml文件中配置了两个<Connector>元素:

<Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"   URIEncoding="UTF-8"
               redirectPort="8443" />

<Connector prot="8009" enableLookups="false" redirectPort="8443" debug="0"　protocol="AJP/1.3"/>

第一个<Connector>元素定义了一个HTTP Connector,它通过8080端口接收HTTP请求;
第二个<Connector>元素定义了一个JK Connector,它通过8009端口接收由其他HTTP服务器(如Apache服务器)转发过来的客户请求.

所有的<Connector>元素都具有一些共同的属性,这些属性如下:

        <Connector     port="8080"
                     maxThreads="150"     minSpareThreads="25"     maxSpareThreads="75"
                     enableLookups="false"     redirectPort="8443"     acceptCount="100"
                     debug="0"     connectionTimeout="20000"  
                     disableUploadTimeout="true"     />

className:指定实现org.apache.catalina.Connector 接口的类,默认值为org.apache.catalina.core.StandardConnector.
enableLookups:如果设为true,表示支持域名解析,可以把IP地址解析为主机名.Web应用调用request.getRemostHost方法将返回客户的主机名.该属性默认值为true.
redirectPort:指定转发端口.如果当前端口只支持non-SSL请求,在需要安全通信的场合,将把客户请求转发到基于SSL的redirectPort的端口.

2.7.1 HttpConnector

HttpConnector的属性描述如下:

calssName :指定实现org.apache.catalina.Connector接口的类,默认值为org.apache.coyote.tomcat5.CoyoteConnector.
enableLookups:同上.
redirectPort:同上.
prot:设定TCP/IP断口号,默认为8080.
address:如果服务器有两个以上IP地址,该属性可以设定端口监听的IP地址,默认情况下,端口会监听服务器上所有IP地址.
bufferSize:设定由端口创建的输入流的缓存大小,默认值为2048byte.
protocol:设定HTTP协议,默认值为HTTP/1.1.
maxThreads:设定处理客户请求的线程的最大数目,这个值也决定了服务器可以同时响应客户请求的最大数目,默认值为200.
acceptCount:设定在监听端口队列中的最大客户请求数,默认值为10.如果队列已满,客户请求将被拒绝.
connectionTimeout:定义建立客户连接超时的时间,以毫秒为单位.如果设置为-1,表示不限制建立客户连接的时间.

2.7.2 JKConnector

JK Connector的属性如下:

className:指定实现org.apache.catalina.Connector接口的类,默认值为org.apache.coyote.tomact5.CoyoteCnnector.
enableLookups:同上.
redirectPort:同上.
port:设定AJP端口号.
protocol:必须设定为AJP/1.3协议

2.7.3 线程池Executor

Executor元素代表Tomcat中的线程池，可以由其他组件共享使用；要使用该线程池，组件需要通过executor属性指定该线程池。

Executor是Service元素的内嵌元素。一般来说，使用线程池的是Connector组件；为了使Connector能使用线程池，Executor元素应该放在Connector前面。Executor与Connector的配置举例如下：

<Executor 
	name="tomcatThreadPool" 
	namePrefix ="catalina-exec-" 
	maxThreads="150" 
	minSpareThreads="4" />
<Connector 
	executor="tomcatThreadPool" 
	port="8080" 
	protocol="HTTP/1.1" 
	connectionTimeout="20000" 
	redirectPort="8443" 
	acceptCount="1000" />

Executor的主要属性包括：

name：该线程池的标记
maxThreads：线程池中最大活跃线程数，默认值200（Tomcat7和8都是）
minSpareThreads：线程池中保持的最小线程数，最小值是25
maxIdleTime：线程空闲的最大时间，当空闲超过该值时关闭线程（除非线程数小于minSpareThreads），单位是ms，默认值60000（1分钟）
daemon：是否后台线程，默认值true
threadPriority：线程优先级，默认值5
namePrefix：线程名字的前缀，线程池中线程名字为：namePrefix+线程编号