web.xml配置详解.docx

Web.XML 配置详解 转载于每一个站的WEB-INF下都有一个web.xml的设定文件，它提供了我们站台的配置设定. web.xml定义：.站台的名称和说明.针对环境参数(Context)做初始化工作.Servlet的名称和映射.Session的设定.Tag library的对映.JSP网页设定.Mime Type处理.错误处理.利用JDNI取得站台资源要了解web.xml的设定值，必须了解它的schema,从web.xml中知道它的schema是由Sum Microsystems公司定制的，如果你想更为详细的了解它，可以到 这是一般在写XML时所做的声明,定义了XML的版本，编码格式,还有重要的指明schema的来源,为/web-app_2_4.xsd.,_站台描述对站台做出描述.站台名称定义站台的名称.icon元素包含small-icon和large-icon两个子元素.用来指定web站台中小图标和大图标的路径./路径/smallicon.gifsmall-icon元素应指向web站台中某个小图标的路径,大小为16 X 16 pixel,但是图象文件必须为GIF或JPEG格式,扩展名必须为:.gif或.jpg./路径/largeicon-jpglarge-icon元素应指向web站台中某个大图表路径,大小为32 X 32 pixel,但是图象文件必须为GIF或JPEG的格式,扩展名必须为; gif或jpg.范例:Develop ExampleJSP 2.0 Tech Books Examples /images/small.gif /images/large.gir_distributable 元素为空标签,它的存在与否可以指定站台是否可分布式处理.如果web.xml中出现这个元素,则代表站台在开发时已经被设计为能在多个JSP Container 之间分散执行.范例:_context-param 元素用来设定web站台的环境参数(context),它包含两个子元素:param-name和param-value.参数名称设定Context名称值设定Context名称的值范例: param_name param_value此所设定的参数,在JSP网页中可以使用下列方法来取得:$initParam.param_name若在Servlet可以使用下列方法来获得:String param_name=getServletContext().getInitParamter(param_name);_filter元素用来声明filter的相关设定.filter元素除了下面介绍的的子元素之外,还包括介绍过的,其用途一样.Filter的名称定义Filter的名称.Filter的类名称定义Filter的类名称.例如:com.foo.hello范例: setCharacterEncoding coreservlet.javaworld.CH11.SetCharacterEncodingFilter encoding GB2312 _filter-mapping 元素的两个主要子元素filter-name和url-pattern.用来定义Filter所对应的URL.Filter的名称定义Filter的名称.URLFilter所对应的RUL.例如:/Filter/HelloServlet的名称定义servlet的名称.REQUEST|INCLUDE|FORWARD|ERROR设定Filter对应的请求方式,有RQUEST,INCLUDE,FORWAR,ERROR四种,默认为REQUEST.范例: GZIPEncoding /*_listener元素用来定义Listener接口,它的主要子元素为Listener的类名称定义Listener的类名称.例如: com.foo.hello范例: coreservlet.javaworld.CH11.ContenxtListener_servlet-mapping元素包含两个子元素servlet-name和url-pattern.用来定义servlet所对应URL.Servlet的名称定义Servlet的名称.Servlet URL定义Servlet所对应的RUL.例如:/Servlet/Hello范例: LoginChecker /LoginChecker_session-config包含一个子元素session-timeout.定义web站台中的session参数.分钟定义这个web站台所有session的有效期限.单位为分钟.范例: 20_mime-mapping包含两个子元素extension和mime-type.定义某一个扩展名和某一MIME Type做对映.扩展名名称扩展名称MIME格式MIME格式.范例: doc application/vnd.ms-word xls application/vnd.ms-excel ppt application/vnd.ms-powerpoint_welcome-file-list包含一个子元素welcome-file.用来定义首页列单.用来指定首页文件名称welcome-file用来指定首页文件名称.我们可以用指定几个首页,而服务器会依照设定的顺序来找首页.范例: index.jsp index.htm_error-page元素包含三个子元素error-code,exception-type和location.将错误代码(Error Code)或异常(Exception)的种类对应到web站台资源路径.错误代码HTTP Error code,例如: 404Exception一个完整名称的Java异常类型/路径在web站台内的相关资源路径范例: 404 /error404.jsp java.lang.Exception /except.jsp_jsp-config元素主要用来设定JSP的相关配置,包括和两个子元素.其中元素在JSP 1.2时就已经存在了;而是JSP 2.0新增的元素.taglib元素包含两个子元素taglib-uri和taglib-location.用来设定JSP网页用到的Tag Library路径.URI taglib-uri定义TLD文件的URI,JSP网页的taglib指令可以经由这个URI存取到TLD文件./WEB-INF/lib/xxx.tld TLD文件对应Web站台的存放位置.jsp-property-group元素包含8个元素,分别为:Description此设定的说明Name此设定的名称URL设定值所影响的范围,如:/CH2 或者/*.jsptrue|false若为true,表示不支持EL语法.true|false若为true表示不支持语法.encoding设定JSP网页的编码.jspf设置JSP网页的抬头,扩展名为.jspf.jspf设置JSP网页的结尾,扩展名为.jspf范例: Taglib /WEB-INF/tlds/MyTaglib.tld Special property group for JSP Configuration JSP example. JSPConfiguration /* true GB2312 true ._resource-ref元素包括五个子元素description,res-ref-name,res-type,res-auth,res-sharing-scope.利用JNDI取得站台可利用资源.说明资源说明资源名称资源名称资源种类资源种类Application|Container资源由Application或Container来许可Shareable|Unshareable资源是否可以共享.默认值为 Shareable范例: JNDI JDBC DataSource of JSPBook jdbc/sample_db javax.sql.DataSoruce Container本文来自CSDN博客，转载请标明出处：Web.xml配置详解关键字: web.xml 配置 j2ee 1 定义头和根元素部署描述符文件就像所有XML文件一样，必须以一个XML头开始。这个头声明可以使用的XML版本并给出文件的字符编码。DOCYTPE声明必须立即出现在此头之后。这个声明告诉服务器适用的servlet规范的版本（如2.2或2.3）并指定管理此文件其余部分内容的语法的DTD(Document Type Definition，文档类型定义)。所有部署描述符文件的顶层（根）元素为web-app。请注意，XML元素不像HTML，他们是大小写敏感的。因此，web-App和WEB-APP都是不合法的，web-app必须用小写。2 部署描述符文件内的元素次序XML 元素不仅是大小写敏感的，而且它们还对出现在其他元素中的次序敏感。例如，XML头必须是文件中的第一项，DOCTYPE声明必须是第二项，而web- app元素必须是第三项。在web-app元素内，元素的次序也很重要。服务器不一定强制要求这种次序，但它们允许（实际上有些服务器就是这样做的）完全拒绝执行含有次序不正确的元素的Web应用。这表示使用非标准元素次序的web.xml文件是不可移植的。下面的列表给出了所有可直接出现在web-app元素内的合法元素所必需的次序。例如，此列表说明servlet元素必须出现在所有servlet-mapping元素之前。请注意，所有这些元素都是可选的。因此，可以省略掉某一元素，但不能把它放于不正确的位置。l icon icon元素指出IDE和GUI工具用来表示Web应用的一个和两个图像文件的位置。l display-name display-name元素提供GUI工具可能会用来标记这个特定的Web应用的一个名称。l description description元素给出与此有关的说明性文本。l context-param context-param元素声明应用范围内的初始化参数。l filter 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。l filter-mapping 一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。l listener servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。l servlet 在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。l servlet-mapping 服务器一般为servlet提供一个缺省的URL：http:/host/webAppPrefix/servlet/ServletName。但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。l session-config 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。l mime-mapping 如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。l welcom-file-list welcome-file-list元素指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。l error-page error-page元素使得在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。l taglib taglib元素对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。l resource-env-ref resource-env-ref元素声明与资源相关的一个管理对象。l resource-ref resource-ref元素声明一个资源工厂使用的外部资源。l security-constraint security-constraint元素制定应该保护的URL。它与login-config元素联合使用l login-config 用login-config元素来指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。l security-role security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。l env-entry env-entry元素声明Web应用的环境项。l ejb-ref ejb-ref元素声明一个EJB的主目录的引用。l ejb-local-ref ejb-local-ref元素声明一个EJB的本地主目录的应用。3 分配名称和定制的UL在web.xml中完成的一个最常见的任务是对servlet或JSP页面给出名称和定制的URL。用servlet元素分配名称，使用servlet-mapping元素将定制的URL与刚分配的名称相关联。3.1 分配名称为了提供初始化参数，对servlet或JSP页面定义一个定制URL或分配一个安全角色，必须首先给servlet或JSP页面一个名称。可通过 servlet元素分配一个名称。最常见的格式包括servlet-name和servlet-class子元素（在web-app元素内），如下所示：Xml代码 1. 2. Test3. moreservlets.TestServlet4. Test moreservlets.TestServlet 这表示位于WEB-INF/classes/moreservlets/TestServlet的servlet已经得到了注册名Test。给 servlet一个名称具有两个主要的含义。首先，初始化参数、定制的URL模式以及其他定制通过此注册名而不是类名引用此servlet。其次,可在 URL而不是类名中使用此名称。因此，利用刚才给出的定义，URL http:/host/webAppPrefix/servlet/Test 可用于 http:/host/webAppPrefix/servlet/moreservlets.TestServlet 的场所。请记住：XML元素不仅是大小写敏感的，而且定义它们的次序也很重要。例如，web-app元素内所有servlet元素必须位于所有servlet- mapping元素（下一小节介绍）之前，而且还要位于5.6节和5.11节讨论的与过滤器或文档相关的元素（如果有的话）之前。类似地，servlet 的servlet-name子元素也必须出现在servlet-class之前。5.2节部署描述符文件内的元素次序将详细介绍这种必需的次序。例如，程序清单5-1给出了一个名为TestServlet的简单servlet，它驻留在moreservlets程序包中。因为此servlet是扎根在一个名为deployDemo的目录中的Web应用的组成部分，所以TestServlet.class放在deployDemo/WEB- INF/classes/moreservlets中。程序清单5-2给出将放置在deployDemo/WEB-INF/内的web.xml文件的一部分。此web.xml文件使用servlet-name和servlet-class元素将名称Test与TestServlet.class相关联。图 5-1和图5-2分别显示利用缺省URL和注册名调用TestServlet时的结果。程序清单5-1 TestServlet.javaJava代码 1. packagemoreservlets; 2. 3. importjava.io.*; 4. importjavax.servlet.*; 5. importjavax.servlet.http.*; 6. 7. publicclassTestServletextendsHttpServlet 8. publicvoiddoGet(HttpServletRequestrequest, 9. HttpServletResponseresponse) 10. throwsServletException,IOException 11. response.setContentType(text/html); 12. PrintWriterout=response.getWriter(); 13. Stringuri=request.getRequestURI(); 14. out.println(ServletUtilities.headWithTitle(TestServlet)+n+URI:+urin+); 15. 16. package moreservlets;import java.io.*;import javax.servlet.*;import javax.servlet.http.*;public class TestServlet extends HttpServlet public void doGet(HttpServletRequest request,HttpServletResponse response)throws ServletException, IOException response.setContentType(text/html); PrintWriter out = response.getWriter(); String uri = request.getRequestURI(); out.println(ServletUtilities.headWithTitle(Test Servlet) +n +URI: + uri n +); 程序清单5-2 web.xml（说明servlet名称的摘录）Xml代码 1. 2. !DOCTYPEweb-app 3. PUBLIC-/SunMicrosystems,Inc./DTDWebApplication2.3/EN 4. 5. 6. 7. 8. Test9. moreservlets.TestServlet10. 11. 12. !DOCTYPE web-appPUBLIC -/Sun Microsystems, Inc./DTD Web Application 2.3/EN Test moreservlets.TestServlet3.2 定义定制的URL大多数服务器具有一个缺省的serlvet URL：http:/host/webAppPrefix/servlet/packageName.ServletName。虽然在开发中使用这个URL很方便，但是我们常常会希望另一个URL用于部署。例如，可能会需要一个出现在Web应用顶层的URL（如，http: /host/webAppPrefix/Anyname），并且在此URL中没有servlet项。位于顶层的URL简化了相对URL的使用。此外，对许多开发人员来说，顶层URL看上去比更长更麻烦的缺省URL更简短。事实上，有时需要使用定制的URL。比如，你可能想关闭缺省URL映射，以便更好地强制实施安全限制或防止用户意外地访问无初始化参数的servlet。如果你禁止了缺省的URL，那么你怎样访问servlet呢？这时只有使用定制的URL了。为了分配一个定制的URL，可使用servlet-mapping元素及其servlet-name和url-pattern子元素。Servlet- name元素提供了一个任意名称，可利用此名称引用相应的servlet；url-pattern描述了相对于Web应用的根目录的URL。url- pattern元素的值必须以斜杠（/）起始。下面给出一个简单的web.xml摘录，它允许使用URL http:/host/webAppPrefix/UrlTest而不是http:/host/webAppPrefix/servlet/Test或http: /host/webAppPrefix/servlet/moreservlets.TestServlet。请注意，仍然需要XM