tomcat web.xml配置

关于Tomcat 中 web.xml 文件的配置问题：
1.下面的配置是合法的
    <servlet>
        <servlet-name>test</servlet-name>
        <servlet-class>test.MyServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>test</servlet-name>
        <url-pattern>/testServlet</url-pattern>
    </servlet-mapping>
<servlet>
        <servlet-name>mee</servlet-name>
        <servlet-class>test.TestServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>mee</servlet-name>
        <url-pattern>/Test</url-pattern>
    </servlet-mapping>
也就是说一个网站可以包含多个 Servlet 应用。
2.<servlet>完成Servlet 的名称 name 和 Servlet 的类之间的映射；
   <servlet-mapping>   则完成地址路径 url-pattern 和 servlet 的名称 name 之间的映射。
3.在编写 servlet 的 java 源文件的时候如果创建了包 test，则必须把这个servlet 的 class 文件放在相应 的文件夹里，比如：   ...ROOT\WEB-INF\classes\test 中。意思自己明白就好。
4.注意：引用 servlet 类的时候不要忘记路径的格式
    <servlet-mapping>
        <servlet-name>test</servlet-name>
        <url-pattern>/testServlet</url-pattern>
    </servlet-mapping>
这个是 Applet 文件中的格式 ：url=new URL(getCodeBase(),"/testServlet");

web.xml元素介绍


web.xml首先是肯定要包含它的schema.

<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
    version="2.4">

</web-app>

其它的元素都放在<web-app></web-app>之中。

<discription></discription> 是对站台的描述
<display-name></display-name> 定义站台的名称
<distributable/> 是指定该站台是否可分布式处理


<context-param></context-param> 用来设定web站台的环境参数，它包含两个子元素：
    <param-name></param-name> 用来指定参数的名称
    <param-value></param-value> 用来设定参数值

比如：
<context-param>
    <param-name>my_param</param-name>
    <param-value>hello</param-value>
</context-param>

在此设定的参数，可以在servlet中用 getServletContext().getInitParameter("my_param") 来取得


<filter></filter> 是用来声明filter的相关设定，它包含以下子元素：
    <filter-name></filter-name> 这当然就是指定filter的名字
    <filter-class></filter-class> 这是用来定义filter的类的名称
    <init-param></init-param> 用来定义参数，它有两个子元素：
        <param-name></param-name> 用来指定参数的名称
      <param-value></param-value> 用来设定参数值

比如：
<filter>
        <filter-name>setCharacterEncoding</filter-name>
        <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>GB2312</param-value>
        </init-param>
</filter>

与<filter></filter>同时使用的是<filter-mapping></filter-mapping> 用来定义filter所对应的URL，它有两个子元素：
    <filter-name></filter-name> 指定filter的名字
    <url-pattern></url-pattern> 指定filter所对应的URL

比如：
<filter-mapping>
        <filter-name>setCharacterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
</filter-mapping>


<listener></listener> 用来设定Listener接口，它的主要子元素为
    <listener-class></listener-class> 定义Listener的类名称

比如：
<listener>
    <listener-class>com.myTest.ContextListener</listener-class>
</listener>


<servlet></servlet> 用来声明一个servlet的数据，主要有以下子元素：
    <servlet-name></servlet-name> 指定servlet的名称
    <servlet-class></servlet-class> 指定servlet的类名称
    <jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径
    <init-param></init-param> 用来定义参数，和前面的<init-param>差不多

同样，与<servlet></servlet>一起使用的是<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素：
    <servlet-name></servlet-name> 指定servlet的名称
    <url-pattern></url-pattern> 指定servlet所对应的URL

比如：
<servlet>
        <servlet-name>ShoppingServlet</servlet-name>
        <servlet-class>com.myTest.ShoppingServlet</servlet-class>
</servlet>
   
<servlet-mapping>
        <servlet-name>ShoppingServlet</servlet-name>
        <url-pattern>/shop/ShoppingServlet</url-pattern>
</servlet-mapping>


<session-config></session-config> 用来定义web站台中的session参数，包含一个子元素：
    <session-timeout></session-timeout> 用来定义这个web站台所有session的有效期限，单位为                                                              分钟


<mime-mapping></mime-mapping> 定义某一个扩展名和某一个MIME Type做对映，包含两个                                                        子元素：
    <extension></extension> 扩展名的名称
    <mime-type></mime-type> MIME格式

比如：
<mime-mapping>
    <extension>doc</extension>
    <mime-type>application/vnd.ms-word</mime-type>
</mime-mapping>
<mime-mapping>
    <extension>xls</extension>
    <mime-type>application/vnd.ms-excel</mime-type>
</mime-mapping>


<welcome-file-list></welcom-file-list> 用来定义首页的列单，包含一个子元素：
    <welcome-file></welcome-file> 指定首页的文件名称

比如：
<welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>index.html</welcome-file>
</welcom-file-list>


<error-page></error-page> 用来处理错误代码或异常的页面，有三个子元素：
    <error-code></error-code> 指定错误代码
    <exception-type></exception-type> 指定一个JAVA异常类型
    <location></location> 指定在web站台内的相关资源路径

比如：
<error-page>
    <error-code>404</error-code>
    <location>/error404.jsp</location>
</error-page>
<error-page>
    <exception-type>java.lang.Exception</exception-type>
    <location>/exception.jsp</location>
</error-page>


<taglib></taglib> 用来设定JSP网页所用到的Tag Library路径，有两个子元素：
    <taglib-uri></taglib-uri> 定义TLD文件的URI，在JSP网页中用taglib指令便可取得该URI的                                            TLD文件
    <taglib-location></taglib-location> 指定TLD文件相对于web站台的存放位置

比如：
<taglib>
    <taglib-uri>myTaglib</taglib-uri>
    <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
</taglib>


<resource-ref></resource-ref> 定义利用JNDI取得站台可利用的资源，有五个子元素：
    <description></description> 资源说明
    <rec-ref-name></rec-ref-name> 资源名称
    <res-type></res-type> 资源种类
    <res-auth></res-auth> 资源经由Application或Container来许可
    <res-sharing-scope></res-sharing-scope> 资源是否可以共享，有Shareable和Unshareable两个                                                                     值，默认为Shareable

比如，配置数据库连接池就可在此配置：
<resource-ref>
        <description>JNDI JDBC DataSource of shop</description>
        <res-ref-name>jdbc/sample_db</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
</resource-ref>



<jsp-config> 包括<taglib> 和<jsp-property-group> 两个子元素。
   
     其中<taglib>元素在JSP 1.2时就已经存在；而<jsp-property-group>是JSP 2.0 新增的元素。
     <jsp-property-group>元素主要有八个子元素，它们分别为：
   
     1.<description>：设定的说明；
     2.<display-name>：设定名称；
     3.<url-pattern>：设定值所影响的范围，如：/CH2 或 /*.jsp；
     4.<el-ignored>：若为true，表示不支持EL 语法；
     5.<scripting-invalid>：若为true，表示不支持<% scripting %>语法；
     6.<page-encoding>：设定JSP 网页的编码；
     7.<include-prelude>：设置JSP 网页的抬头，扩展名为.jspf；
     8.<include-coda>：设置JSP 网页的结尾，扩展名为.jspf。


一个简单的<jsp-config>元素完整配置：

<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>
配置web.xml来限制对某些servlet的请求

有时我们只希望通过认证的用户才能请求某些servlet的话，就可以在web.xml中来进行相应的配置，来达到此目的。

这就要用到<security-constraint></security-constraint>元素。
对于tomcat，中web.xml使用security-constraint元素需要在位于<Tomcat-installation-directory>/conf/tomcat-users.xml的XML文件中创建用户名和密码。比如下面的这个tomcat-users.xml文件：

<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
<role rolename="tomcat"/>
<role rolename="manager"/>
<role rolename="admin"/>
<user username="tomcat" password="tomcat" roles="tomcat"/>
<user username="both" password="tomcat" roles="tomcat,manager"/>
<user username="admin" password="admin" roles="admin"/>
</tomcat-users>

此XML片段包括一个tomcat-users根元素，它包含一个或多个role和user元素。


然后在Web应用程序的web.xml中创建security-constraint、login-config和security-role元素。

<security-constraint>
    <web-resource-collection>
        <web-resource-name>HelloServlet</web-resource-name>
        <url-pattern>/HelloServlet</url-pattern>
        <http-method>GET</http-method>
        <http-method>POST</http-method>
    </web-resource-collection>
    <auth-constraint>
        <description>This applies only to the "tomcat" security role</description>
        <role-name>admin</role-name>
    </auth-constraint>
    <user-data-constraint>
        <transport-guarantee>NONE</transport-guarantee>
    </user-data-constraint>
</security-constraint>

<login-config>
    <auth-method>BASIC</auth-method>
</login-config>
<security-role>
    <role-name>admin</role-name>
</security-role>

其中security-constraint元素包含一个或多个web-resource-collection元素，它是描述Web应用程序中的哪些web资源受到指定安全限制的保护。http-method元素指定安全限制覆盖的HTTP方法。上面的例子中，当我们对/HelloServlet的GET或POST请求时将触发配置的安全机制。
auth-constraint元素用于描述允许访问Web组件的安全角色。此例中安全角色的例子有tomcat、manager、admin。而只有当作为admin角色的用户才可以访问HelloServlet。

Web应用程序通过login-config元素来认证用户，并确认该用户是否为正确的角色。
longin-config包含的transport-guarantee子元素用来指定认证方法，BASIC是一种常见的Web认证方式，浏览器给用户提示一个对话框，要求输入用户名和密码，随后Tomcat将给出的用户名和密码与tomcat-users.xml中的用户名和密码进行比较，然后使用前面的security-constraint配置来确定用户是否可访问受保护的servlet。

（除BASIC外，还可以是FORM、CLIENT-CERT、DIGEST等）

其实这种认证方法实际上有两个步骤：
1、检查提供的用户名和密码是否正确。
2、判断用户是否映射到特定的安全角色。例如，用户可能提供了正确的用户名和密码，但没有映射到特定的安全角色，也将被禁止访问特定的Web资源。



原文地址：http://hi.baidu.com/lmaw/blog/item/620bc0f49a774d6addc474dc.html




Web.xml配置描述符的用法:

display-name元素提供GUI工具可能会用来标记这个特定的Web应用的一个名称
description元素给出与此有关的说明性文本
context-param元素声明应用范围内的初始化参数。
filter 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联
filter-mapping 命名一个过滤器后，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。
listener servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或          servlet环境时得到通知。Listener元素指出事件监听程序类。
servlet 在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。
servlet-mapping 服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。
session-config 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。可通过使用HttpSession的setMaxInactiveInterval方法 明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。
mime-mapping 如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。
welcome-file-list元素指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。
error-page元素使得在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。
taglib元素对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。
resource-env-ref 元素声明与资源相关的一个管理对象。
resource-ref 元素声明一个资源工厂使用的外部资源。
security-constraint 元素制定应该保护的URL。它与login-config元素联合使用
login-config元素来指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。
security-role 元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。
env-entry 元素声明Web应用的环境项。
ejb-ref 元素声明一个EJB的主目录的引用。
ejb-local-ref 元素声明一个EJB的本地主目录的应用。

评论

2 楼 zhyl2010 2011-10-24  

 

YYang5968 写道

我有一个问题
我未用tomcat部署项目时,读取src/rhms/action/xml/action.xml文件完全可以读取,可是部署到tomcat之后就报错了:"
C:\Program Files\Genuitec\Common\plugins\com.genuitec.eclipse.easie.tomcat.myeclipse_8.5.0.me201003121946\tomcat\bin\rhms\action\xml\action.xml (系统找不到指定的路径。)"
我用的是MyEclipse自带的tomcat,说是找不到action.xml文件,读取不了,我把action.xml文件移到"
C:\Program Files\Genuitec\Common\plugins\com.genuitec.eclipse.easie.tomcat.myeclipse_8.5.0.me201003121946\tomcat\bin\action.xml"
还是报错,还是原来那个错,不知道为什么,望知道解决方法后立刻告知我,谢谢了

最好不要用自带的tomcat，问题比较多，自己单独下载一个吧

1 楼 YYang5968 2011-10-14  

我有一个问题
我未用tomcat部署项目时,读取src/rhms/action/xml/action.xml文件完全可以读取,可是部署到tomcat之后就报错了:"
C:\Program Files\Genuitec\Common\plugins\com.genuitec.eclipse.easie.tomcat.myeclipse_8.5.0.me201003121946\tomcat\bin\rhms\action\xml\action.xml (系统找不到指定的路径。)"
我用的是MyEclipse自带的tomcat,说是找不到action.xml文件,读取不了,我把action.xml文件移到"
C:\Program Files\Genuitec\Common\plugins\com.genuitec.eclipse.easie.tomcat.myeclipse_8.5.0.me201003121946\tomcat\bin\action.xml"
还是报错,还是原来那个错,不知道为什么,望知道解决方法后立刻告知我,谢谢了