2、web.xml文件元素详解
下面的列表给出了所有可直接出现在web-app元素内的合法元素的次序。例如,此列表说明servlet元素必须出现在所有servlet-mapping元素之 前。请注意,所有这些元素都是可选的。
(1) <icon>Web应用图标
指出IDE和GUI工具用来表示Web应用的
应用的大图标和小图标
的位置
<icon>
<small-icon>/images/app_small.gif</small-icon>
<large-icon>/images/app_large.gif</large-icon>
</icon>
(2) <display-name> Web应用名称
提供GUI工具可能会用来标记这个特定的Web应用的一个名称
<display>my webapp</display>
(3) <description> Web应用说明
给出于此相关的说明性文本
<description> This is my first webapp</description>
(4) <context-param>上下文参数
声明应用范围内的初始化参数。它用于向 ServletContext提供键值对,即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。
<context-param>
<param-name>ContextParameter</param-name>
<param-value>test</param-value>
<description>It is a test parameter.</description>
</context-param>
(5) <filter> and <filter-mapping> 过滤器
<filter> 将一个名字与一个实现javaxs.servlet.Filter接口的类相关联
<filter-mapping> 一旦命名了一个过滤器,就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。
<filter>
<filter-name>myTestFilter</filter-name>
<filter-class>com.myTest.MyTestFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>myTestFilter<filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
(6) <listener> 监听器
将一个名字与一个实现了相应Listener接口的类相关联
servlet API的版本2.3增加了对事件监听程序的支持,事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。
<listener>
<listener-class>com.listener.SessionListener</listener-class>
</listener>
(7) <servlet> and <servlet-mapping> 定制URL
在向servlet或JSP页面制定初始化参数或定制URL时,必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。
服务器一般为servlet提供一个缺省的URL:
"http://host/webAppPrefix/servlet/ServletName">http://host/webAppPrefix/servlet/ServletName</a>。但是,常常会更改这个URL,以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时,使用servlet-mapping元素。
<servlet></servlet> 用来声明一个servlet的数据,主要有以下子元素:
a. <servlet-name></servlet-name> 指定servlet的名称
b. <servlet-class></servlet-class> 指定servlet的类名称
c. <jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径
d. <init-param></init-param> 用来定义参数,可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数
e. <load-on-startup></load-on-startup>指定当Web应用启动时,装载Servlet的次序。当值为正数或零时:Servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet。当值为负或未定义:Servlet容器将在Web客户首次访问这个servlet时加载它。
f. <servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL,包含两个子元素
g. <servlet-name></servlet-name> 指定servlet的名称
h. <url-pattern></url-pattern> 指定servlet所对应的URL
<servlet>
<servlet-name>testServlet</servlet-name>
<servlet-class>com.testservlet.TestServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>testServlet</servlet-name>
<url-pattern>/test/testServlet</url-pattern>
</servlet-mapping>
(8) <session-config> 会话超时配置 (单位:分钟)
如果某个会话在一定时间内未被访问,服务器可以抛弃它以节省内存。可通过使用HttpSession的setMaxInactiveInterval方法 明确设置单个会话对象的超时值,或者可利用session-config元素制定缺省超时值。
<session-config>
<session-timeout>120</session-timeout>
</session-config>
(9): <mime-mapping>
如果Web应用具有想到特殊的文件,希望能保证给他们分配特定的MIME类型,则mime-mapping元素提供这种保证
<mime-mapping>
<extension>htm</extension>
<mime-type>text/html</mime-type>
</mime-mapping>
(10) <welcome-file-list>欢迎文件页
指示服务器在收到引用一个目录名而不是文件名的URL时,使用哪个文
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
</welcome-file-list>
(11) <error-page> 错误页面
使得在返回特定HTTP状态代码时,或者特定类型的异常被抛出时,能够制定将要显示的页面。
<error-page>
<error-code>404</error-code>
<location>/NotFound.jsp</location>
</error-page>
<error-page>
<error-type>java.lang.NullException</error-type>
<location>/error.jsp</location>
</error-page>
(12) <jsp-config>设置jsp
<jsp-config> 包括 <taglib> 和 <jsp-property-group> 两个子元素。其中<taglib> 元素在JSP 1.2 时就已经存在;而<jsp-property-group> 是JSP 2.0 新增的元素。
<taglib>元素对标记库描述符文件(Tag Libraryu Descriptor file)指定别名。此功能使你能够更改TLD文件的位置,而不用编辑使用这些文件的JSP页面。
<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
对于Web 应用程式来说,Scriptlet 是个不乐意被见到的东西,因为它会使得HTML 与Java 程式码交相混杂,对于程式的维护来说相当的麻烦,必要的时候,可以在web.xml 中加上<script-invalid> 标签,设定所有的JSP 网页都不可以使用Scriptlet。
<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 JSP Configuration 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>
(13) <resource-env-ref>
指定对管理对象的servlet引用的声明,该对象与servlet环境中的资源相关联
<resource-env-ref>
<resource-env-ref-name>资源名</resource-env-ref-name>
<resource-env-ref-type>查找资源时返回的资源类名</resource-env-ref-type>
</resource-env-ref>
<resource-env-ref-name>:资源的名称 相对于
Java:comp/env >>context
<resource-env-ref-type>:当web应用查找该资源的时候,返回的Java类名的全称
(14) <resource-ref>
声明一个资源工厂使用的外部资源
(15) <security-constraint>
制定应该保护的URL。它与login-config元素联合使用
(16) <login-config>
用login-config元素来指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用
(17) <security-role>
security-role元素给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。
(18) <env-entry>
env-entry元素声明Web应用的环境项
(19) <ejb-ref>
ejb-ref元素声明一个EJB的主目录的引用
ejb-local-ref元素声明一个EJB的本地主目录的应用