web.xml文件详解

web.xml文件详解

一、web.xml文件介绍

1.web.xml文件的作用

web.xml主要用来配置Filter、Listener、Servlet等。但是要说明的是web.xml并不是必须的，一个web工程可以没有web.xml文件。

2.WEB容器的加载过程

WEB容器的加载顺序是：ServletContext-> context-param -> listener -> filter -> servlet。在web.xml文件中最好按照这种顺序配置这些元素，以兼容较低版本的Tomcat。

3.WEB容器的启动过程

WEB容器启动时，加载过程顺序如下：

1.启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取<listener>和<context-param>两个结点。

2.紧急着，容创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。

3.容器将<context-param>转换为键值对，并交给servletContext。

4.容器创建<listener>中的类实例，创建监听器。

二、web.xml配置元素

1.<web-app>根元素

web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在<web-app></web-app>之中，<web-app>是根节点。

<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"

     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

     http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">

</web-app>

2.<icon>Web应用图标

指出IDE和GUI工具用来表示Web应用的大图标和小图标。

<icon>

    <small-icon>/images/app_small.gif</small-icon>

    <large-icon>/images/app_large.gif</large-icon>

</icon>

3.<display-name>Web应用名称

提供GUI工具可能会用来标记这个特定的Web应用的一个名称。

<display-name>TomcatExample</display-name>

4.<disciption>Web应用描述

给出于此相关的说明性文本。

<disciption>TomcatExample servlets and JSP pages.</disciption>

5.<context-param>上下文参数

声明应用范围内的初始化参数。它用于向ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。

<context-param>

    <param-name>ContextParameter</para-name>

    <param-value>test</param-value>

    <description>Itis a test parameter.</description>

</context-param>

6.<filter>过滤器

将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。

<filter>

    <filter-name>setCharacterEncoding</filter-name>

    <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>

    <init-param>

        <param-name>encoding</param-name>

        <param-value>UTF-8</param-value>

    </init-param>

</filter>

<filter-mapping>

    <filter-name>setCharacterEncoding</filter-name>

    <url-pattern>/*</url-pattern>

</filter-mapping>

7.<listener>监听器

<listener>

    <listerner-class>com.listener.SessionListener</listener-class>

</listener>

8.<servlet>

<servlet>用来声明一个servlet的数据，主要有以下子元素：

<servlet-name>指定servlet的名称

<servlet-class>指定servlet的类名称

<jsp-file>指定web站台中的某个JSP网页的完整路径

<init-param>用来定义参数，可有多个init-param。

<load-on-startup>当值为正数或零时，从小到大加载。否则第一次访问时加载。

<servlet-mapping>用来定义servlet所对应的URL，包含两个子元素

<servlet-name>指定servlet的名称

<url-pattern>指定servlet所对应的URL

 

<!-- 基本配置 -->

<servlet>

    <servlet-name>snoop</servlet-name>

    <servlet-class>SnoopServlet</servlet-class>

</servlet>

<servlet-mapping>

    <servlet-name>snoop</servlet-name>

    <url-pattern>/snoop</url-pattern>

</servlet-mapping>

<!-- 高级配置 -->

<servlet>

    <servlet-name>snoop</servlet-name>

    <servlet-class>SnoopServlet</servlet-class>

    <init-param>

        <param-name>foo</param-name>

        <param-value>bar</param-value>

    </init-param>

    <run-as>

        <description>Securityrole for anonymous access</description>

        <role-name>tomcat</role-name>

    </run-as>

</servlet>

<servlet-mapping>

    <servlet-name>snoop</servlet-name>

    <url-pattern>/snoop</url-pattern>

</servlet-mapping>

9.<session-config>会话超时配置

<session-config>

    <session-timeout>120</session-timeout><!-- 单位为分钟 -->

</session-config>

10.<mime-mapping>

<mime-mapping>

    <extension>htm</extension>

    <mime-type>text/html</mime-type>

</mime-mapping>

11.<welcome-file-list>欢迎文件页

<welcome-file-list>

    <welcome-file>index.jsp</welcome-file>

    <welcome-file>index.html</welcome-file>

</welcome-file-list>

12.<error-page>错误页面

<!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->

<error-page>

    <error-code>404</error-code>

    <location>/NotFound.jsp</location>

</error-page>

<!-- 2、通过异常的类型配置error-page。（即空指针异常）时，跳转到错误处理页面。 -->

<error-page>

    <exception-type>java.lang.NullException</exception-type>

    <location>/error.jsp</location>

</error-page>

13.<jsp-config>设置jsp

<jsp-config>包括 <taglib>和<jsp-property-group>两个子元素。其中<taglib>元素在JSP1.2时就已经存在；而<jsp-property-group> 是JSP 2.0 新增的元素。

<jsp-property-group> 元素主要有八个子元素，它们分别为：

<description>：设定的说明

<display-name>：设定名称

<url-pattern>：设定值所影响的范围，如： /CH2 或 /*.jsp

<el-ignored>：若为 true，表示不支持 EL 语法

<scripting-invalid>：若为 true，表示不支持 <%scripting %>语法

<page-encoding>：设定 JSP 网页的编码

<include-prelude>：设置 JSP 网页的抬头，扩展名为 .jspf

<include-coda>：设置 JSP 网页的结尾，扩展名为 .jspf

<jsp-config>

    <taglib>

       <taglib-uri>Taglib</taglib-uri>

       <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>

    </taglib>

    <jsp-property-group>

       <description>Special property group for JSPConfiguration JSP example.</description>

       <display-name>JSPConfiguration</display-name>

       <url-pattern>/jsp/* </url-pattern>

       <el-ignored>true</el-ignored>

       <page-encoding>GB2312</page-encoding>

       <scripting-invalid>true</scripting-invalid>

       <include-prelude>/include/prelude.jspf</include-prelude>

       <include-coda>/include/coda.jspf</include-coda>

    </jsp-property-group>

</jsp-config>

对于Web 应用程式来说，Scriptlet 是个不乐意被见到的东西，因为它会使得HTML 与Java 程式码交相混杂，对于程式的维护来说相当的麻烦，必要的时候，可以在web.xml中加上<script-invalid> 标签，设定所有的JSP 网页都不可以使用Scriptlet。

 

server.xml文件详解

一、server.xml文件介绍

1.server.xml作用

Server.xml配置文件用于对整个容器进行相关的配置。

2.server.xml文件的配置元素列表

<Server>元素：是整个配置文件的根元素。表示整个Catalina容器。

<Connector>元素：连接器，负责接收客户的请求，以及向客户端回送响应的消息。

<Engine>元素：为特定的Service处理所有的请示。每个Service只能包含一个Engine元素，它负       责接收和处理此Service所有的连接器收到的请求，向连接发回响应，并最终显示在客户端。          <Engine>至少有一个<Host>元素，必须至少有一个<Host>属性的名字与defaultHost指定的名      字相匹配。

<Host>元素：表示一个虚拟主机，为特定的虚拟主机处理所有请求

<context>元素：一个WEB应用程序，处理当前WEB应用程序的所有请求，每一个<Context>必须使用      唯一的上下文路径。

<Logger>元素：表示日志，调试和错误信息。

<Realm>元素：表示存放用户名，密码及role 的数据库。

<Valve>元素：功能与Logger 差不多，其prefix 和suffix属性解释和Logger 中的一样。

二、server.xml配置元素详解

1.<Server>元素

作用：是整个配置文件的根元素。表示整个Catalina容器。

属性：

className：实现了org.apache.catalina.Server接口的类名，标准实现类是                                     org.apache.catalina.core.StandardServer类。

Port：Tomcat服务器监听用于关闭Tomcat服务器的命令（必须）

Shutdown：发送到端口上用于关闭Tomcat服务器的命令。

示例：<Server port ="8005" shutdown="SHUTDOWN" />

2.<Connector>元素

作用：连接器，负责接收客户的请求，以及向客户端回送响应的消息。

HTTP连接器：

属性：

allowTrace：是否允许HTTP的TRACE方法，默认为false

emptySessionPath：如果设置为true，用户的所有路径都将设置为/，默认为false。

enableLookups：调用request、getRemoteHost()执行DNS查询，以返回远程主机的主机名，如果设                     置为false，则直接返回IP地址。

maxPostSize：指定POST方式请求的最大量，没有指定默认为2097152。

protocol：值必须为HTTP1.1，如果使用AJP处理器，该值必须为AJP/1.3

proxyName：如这个连接器正在一个代理配置中被使用，指定这个属性，在request.getServerName()                    时返回

redirectPort：如连接器不支持SSL请求，如收到SSL请求，Catalina容器将会自动重定向指定的端                    口号，让其进行处理。

scheme：设置协议的名字，在request.getScheme()时返回，SSL连接器设为”https”，默认为”http”

secure：在SSL连接器可将其设置为true，默认为false

URIEncoding：用于解码URL的字符编码，没有指定默认值为ISO-8859-1

useBodyEncodingForURI：主要用于Tomcat4.1.x中，指示是否使用在contentType中指定的编码来                           取代URIEncoding，用于解码URI查询参数，默认为false

xpoweredBy：为true时，Tomcat使用规范建议的报头表明支持Servlet的规范版本，默认为false

acceptCount：当所有的可能处理的线程都正在使用时，在队列中排队请求的最大数目。当队列已满，                   任何接收到的请求都会被拒绝，默认值为10

bufferSize：设由连接器创建输入流缓冲区的大小，以字节为单位。默认情况下，缓存区大的大小为                2048字节

compressableMimeType：MIME的列表，默认以逗号分隔。默认值是text/html，text/xml，text/plain

compression：指定是否对响应的数据进行压缩。off：表示禁止压缩、on：表示允许压缩（文本将被                压缩）、force：表示所有情况下都进行压缩，默认值为off

connectionTimeout：设置连接的超时值，以毫秒为单位。默认值为60000=60秒

disableUploadTimeOut：允许Servlet容器，正在执行使用一个较长的连接超时值，以使Servlet有                较长的时间来完成它的执行，默认值为false

maxHttpHeaderSize：HTTP请求和响应头的最大量，以字节为单位，默认值为4096字节

maxKeepAliveRequest：服务器关闭之前，客户端发送的流水线最大数目。默认值为100

maxSpareThreads：允许存在空闲线程的最大数目，默认值为50

minSpareThreads：设当连接器第一次启协创建线程的数目，确保至少有这么多的空闲线程可用。默                 认值为4

port：服务端套接字监听的TCP端口号，默认值为8080（必须）

socketBuffer：设Socket输出缓冲区的大小(以字节为单位)，-1表示禁止缓冲，默认值为9000字节

toNoDelay：为true时，可以提高性能。默认值为true

threadPriority：设JVM中请求处理线程优先级。默认值为NORMAL-PRIORITY

示例：

<Connector port="8080"maxHttpHeaderSize="8192"maxThreads="150"

minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443"

acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true"/>

AJP连接器：

用于将Apache与Tomcat集成在一起，当Apache接收到动态内容请求时，通过在配置中指定的端口号将请求发送给在此端口号上监听的AJP连接器组件。

属性：

backlog：当所有可能的请求处理线程都在使用时，队列中排队的请求最大数目。默认为10，当队列           已满，任何请求都将被拒绝

maxSpareThread：允许存在空闲线程的最大数目，默认值为50

maxThread：最大线程数，默认值为200

minSpareThreads：设当连接器第一次启动时创建线程的数目，确保至少有这么多的空闲线程可用，            默认值为4

port：服务端套接字的TCP端口号，默认值为8089（必须）

topNoDelay：为true时，可以提高性能，默认值为true

soTimeout：超时值

示例：

<Connector port="8089"enableLookups="false"redirectPort="8443"protocol="AJP/1.3"/>

3.<Engine>元素

作用：为特定的Service处理所有的请示。每个Service只能包含一个Engine元素，它负责接收和处理此Service所有的连接器收到的请求，向连接发回响应，并最终显示在客户端。<Engine>至少有一个<Host>元素，必须至少有一个<Host>属性的名字与defaultHost指定的名字相匹配。

属性：

className：实现org.apache.catalina.Engine接口，默认实现类为                                              org.apache.catalina.core.StandardEngine类

defaultHost：默认主机名，值必须与<Service>的name值相匹配

name：指定Engine的逻辑名字（必须）

jvmRoute：在负载匀衡中使用的标识符，必须唯一

示例：<Engine name="Cataline" defaultHost="localhst"/>

4.<Host>元素

作用：表示一个虚拟主机，为特定的虚拟主机处理所有请求

属性：

appBase：设定应用程序的基目录，绝对路径或相对于%CATALINA_HOME%的路径名

autoDeploy：指示Tomcat运行时，如有新的WEB程序加开appBase指定的目录下，是否为自动布署，                   默认值为true

className：实现了org.apache.catalina.Host接口的类，标准实现类为                                         org.apache.catalina.core.StandardHost类

deployOnStartup：Tomcat启动时，是否自动部署appBase属性指定目录下所有的WEB应用程序，默                认值为true

name：虚拟主机的网络名（必须）

标准Host实现类org.apahce.catalina.core.StandardHost支持的附加属性：

deployXML：为false将不会解析WEB应用程序内部的context.xml，默认值为true

unPackWARs：虚拟主机指定临时读写使用的目录的路径名，不设，Tomcat会在                                %CATALINA_HOME%/work目录下提供一个合适的目录。

示例：

<Host name="localhst" appBase="webapps" unpackWARs="true" autoDeploy="true"

xmlValidation="false" xmlNamespaceAware="false">

配置虚拟主机：

<Hostname="xxx" appBase="c:/test">

     <Contentpath="xxx"docBase="e:/abe"/>

</Hostname>

5.<context>元素

作用：一个WEB应用程序，处理当前WEB应用程序的所有请求，每一个<Context>必须使用唯一的上下文路径。

属性：

className：实现了org.apache.catalina.Context接口的类，标准实现类                                         org.apache.catalina.core.StandardContext类

cookies：是否将Cookie应用于Session，默认值为true

crossContext：是否允许跨域访问，为true时，在程序内调用ServletContext.getContext()方法将                    返回一个虚拟主机上其它web程序的请求调度器。默认值为false，调 径用                      getContext()返回为null

docBase：绝对路径或相对于Host的appBase 属性的相对路径

privileged：为true，允许Web应用程序使用容器的Servlet

path：指定上下文路径。一个虚拟主机中，上下文路径必须唯一

reloadable：为true，Tomcat运行时，如果WEB-INF/classes和WEB-INF/lib目录中有改变，Tomcat              会自动重新加载该WEB应用程序。虽方便，但开销也大，默认值为false，我们在调用可              以打开，发布后再关闭。

cacheMaxSize：静态资源缓存最大值，以KB为单位，默认值为10240KB

cachingAllowed：是否允许静态资源缓存，默认为true

caseSensitive：默认为true,资源文件名大小写敏感，如果为false大小写不敏感

unpackWAR：默认为true

workDir：为WEB应用程序内部的Servlet指定临时读写的目录路径名。如没有设置，则Tomcat会在           %CATALINA_HOME%/work目录下提供一个合适的目录

示例：<Content path="/abc" docBase="d:/xyz" reloadable="true"/>