天天看点

web.xml配置详解

在项目中总会遇到一些关于加载的优先级问题,近期也同样遇到过类似的,所以自己查找资料总结了下,下面有些是转载其他人的,毕竟人家写的不错,自己也就不重复造轮子了,只是略加点了自己的修饰。

        首先可以肯定的是,加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是:listener -> filter -> servlet

        同时还存在着这样一种配置节:context-param,它用于向 servletcontext 提供键值对,即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息,那么 context-param 配置节是不是应该写在 listener 配置节前呢?实际上 context-param 配置节可写在任意位置,因此真正的加载顺序为:context-param -> listener -> filter -> servlet

        对于某类配置节而言,与它们出现的顺序是有关的。以 filter 为例,web.xml 中当然可以定义多个 filter,与 filter 相关的一个配置节是 filter-mapping,这里一定要注意,对于拥有相同 filter-name 的 filter 和 filter-mapping 配置节而言,filter-mapping 必须出现在 filter 之后,否则当解析到 filter-mapping 时,它所对应的 filter-name 还未定义。web 容器启动时初始化每个 filter 时,是按照 filter 配置节出现的顺序来初始化的,当请求资源匹配多个 filter-mapping 时,filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 dofilter() 方法的。

        servlet 同 filter 类似 ,此处不再赘述。

       由此,可以看出,web.xml 的加载顺序是:context-param -> listener -> filter -> servlet ,而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。

web.xml文件详解

========================================================================

web.xml常用元素   

<web-app>   

<display-name></display-name>定义了web应用的名字   

<description></description> 声明web应用的描述信息   

<context-param></context-param> context-param元素声明应用范围内的初始化参数。   

<filter></filter> 过滤器元素将一个名字与一个实现javax.servlet.filter接口的类相关联。   

<filter-mapping></filter-mapping> 一旦命名了一个过滤器,就要利用filter-mapping元素把它与一个或多个servlet或jsp页面相关联。   

<listener></listener>servlet api的版本2.3增加了对事件监听程序的支持,事件监听程序在建立、修改和删除会话或servlet环境时得到通知。   

                     listener元素指出事件监听程序类。   

<servlet></servlet> 在向servlet或jsp页面制定初始化参数或定制url时,必须首先命名servlet或jsp页面。servlet元素就是用来完成此项任务的。   

<servlet-mapping></servlet-mapping> 服务器一般为servlet提供一个缺省的url:http://host/webappprefix/servlet/servletname。   

              但是,常常会更改这个url,以便servlet可以访问初始化参数或更容易地处理相对url。在更改缺省url时,使用servlet-mapping元素。   

<session-config></session-config> 如果某个会话在一定时间内未被访问,服务器可以抛弃它以节省内存。   

          可通过使用httpsession的setmaxinactiveinterval方法明确设置单个会话对象的超时值,或者可利用session-config元素制定缺省超时值。   

<mime-mapping></mime-mapping>如果web应用具有想到特殊的文件,希望能保证给他们分配特定的mime类型,则mime-mapping元素提供这种保证。   

<welcome-file-list></welcome-file-list> 指示服务器在收到引用一个目录名而不是文件名的url时,使用哪个文件。   

<error-page></error-page> 在返回特定http状态代码时,或者特定类型的异常被抛出时,能够制定将要显示的页面。   

<taglib></taglib> 对标记库描述符文件(tag libraryu descriptor file)指定别名。此功能使你能够更改tld文件的位置,   

                  而不用编辑使用这些文件的jsp页面。   

<resource-env-ref></resource-env-ref>声明与资源相关的一个管理对象。   

<resource-ref></resource-ref> 声明一个资源工厂使用的外部资源。   

<security-constraint></security-constraint> 制定应该保护的url。它与login-config元素联合使用   

<login-config></login-config> 指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。   

<security-role></security-role>给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素   

                   的role-name子元素中。分别地声明角色可使高级ide处理安全信息更为容易。   

<env-entry></env-entry>声明web应用的环境项。   

<ejb-ref></ejb-ref>声明一个ejb的主目录的引用。   

< ejb-local-ref></ ejb-local-ref>声明一个ejb的本地主目录的应用。   

</web-app>   

相应元素配置   

1、web应用图标:指出ide和gui工具用来表示web应用的大图标和小图标   

<icon>   

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

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

</icon>   

2、web 应用名称:提供gui工具可能会用来标记这个特定的web应用的一个名称   

<display-name>tomcat example</display-name>   

3、web 应用描述: 给出于此相关的说明性文本   

<disciption>tomcat example servlets and jsp pages.</disciption>   

4、上下文参数:声明应用范围内的初始化参数。   

<context-param>   

    <param-name>contextparameter</para-name>   

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

    <description>it is a test parameter.</description>   

</context-param>   

在servlet里面可以通过getservletcontext().getinitparameter("context/param")得到   

5、过滤器配置:将一个名字与一个实现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>gb2312</param-value>   

        </init-param>   

</filter>   

<filter-mapping>   

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

</filter-mapping>   

6、监听器配置   

<listener>   

      <listerner-class>listener.sessionlistener</listener-class>   

</listener>   

7、servlet配置   

   基本配置   

   <servlet>   

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

      <servlet-class>snoopservlet</servlet-class>   

   </servlet>   

   <servlet-mapping>   

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

   </servlet-mapping>   

   高级配置   

      <init-param>   

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

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

      </init-param>   

      <run-as>   

         <description>security role for anonymous access</description>   

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

      </run-as>   

   元素说明   

     <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类中通过getinitparamenter(string name)方法访问初始化参数   

     <load-on-startup></load-on-startup>指定当web应用启动时,装载servlet的次序。   

                                 当值为正数或零时:servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet.   

                                 当值为负或未定义:servlet容器将在web客户首次访问这个servlet时加载它   

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

       <servlet-name></servlet-name> 指定servlet的名称   

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

8、会话超时配置(单位为分钟)   

   <session-config>   

      <session-timeout>120</session-timeout>   

   </session-config>   

9、mime类型配置   

   <mime-mapping>   

      <extension>htm</extension>   

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

   </mime-mapping>   

10、指定欢迎文件页配置   

   <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   

   <error-page>   

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

      <location>/notfound.jsp</location>   

   </error-page>   

上面配置了当系统发生404错误时,跳转到错误处理页面notfound.jsp。   

二、通过异常的类型配置error-page   

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

       <location>/error.jsp</location>   

上面配置了当系统发生java.lang.nullexception(即空指针异常)时,跳转到错误处理页面error.jsp   

12、tld配置   

   <taglib>   

       <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>   

       <taglib-location>/web-inf/jsp/debug-taglib.tld</taglib-location>   

   </taglib>   

   如果myeclipse一直在报错,应该把<taglib> 放到 <jsp-config>中   

   <jsp-config>   

      <taglib>   

          <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>   

          <taglib-location>/web-inf/pager-taglib.tld</taglib-location>   

      </taglib>   

   </jsp-config>   

13、资源管理对象配置   

   <resource-env-ref>   

       <resource-env-ref-name>jms/stockqueue</resource-env-ref-name>   

   </resource-env-ref>   

14、资源工厂配置   

   <resource-ref>   

       <res-ref-name>mail/session</res-ref-name>   

       <res-type>javax.mail.session</res-type>   

       <res-auth>container</res-auth>   

   </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>   

15、安全限制配置   

   <security-constraint>   

      <display-name>example security constraint</display-name>   

      <web-resource-collection>   

         <web-resource-name>protected area</web-resource-name>   

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

         <http-method>delete</http-method>   

         <http-method>get</http-method>   

         <http-method>post</http-method>   

         <http-method>put</http-method>   

      </web-resource-collection>   

      <auth-constraint>   

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

        <role-name>role1</role-name>   

      </auth-constraint>   

   </security-constraint>   

16、登陆验证配置   

   <login-config>   

     <auth-method>form</auth-method>   

     <realm-name>example-based authentiation area</realm-name>   

     <form-login-config>   

        <form-login-page>/jsp/security/protected/login.jsp</form-login-page>   

        <form-error-page>/jsp/security/protected/error.jsp</form-error-page>   

     </form-login-config>   

   </login-config>   

17、安全角色:security-role元素给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。   

    分别地声明角色可使高级ide处理安全信息更为容易。   

<security-role>   

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

</security-role>   

18、web环境参数:env-entry元素声明web应用的环境项   

<env-entry>   

     <env-entry-name>minexemptions</env-entry-name>   

     <env-entry-value>1</env-entry-value>   

     <env-entry-type>java.lang.integer</env-entry-type>   

</env-entry>   

19、ejb 声明   

<ejb-ref>   

     <description>example ejb reference</decription>   

     <ejb-ref-name>ejb/account</ejb-ref-name>   

     <ejb-ref-type>entity</ejb-ref-type>   

     <home>com.mycompany.mypackage.accounthome</home>   

     <remote>com.mycompany.mypackage.account</remote>   

</ejb-ref>   

20、本地ejb声明   

<ejb-local-ref>   

     <description>example loacal ejb reference</decription>   

     <ejb-ref-name>ejb/processorder</ejb-ref-name>   

     <ejb-ref-type>session</ejb-ref-type>   

     <local-home>com.mycompany.mypackage.processorderhome</local-home>   

     <local>com.mycompany.mypackage.processorder</local>   

</ejb-local-ref>   

21、配置dwr   

<servlet>   

      <servlet-name>dwr-invoker</servlet-name>   

      <servlet-class>uk.ltd.getahead.dwr.dwrservlet</servlet-class>   

</servlet>   

<servlet-mapping>   

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

</servlet-mapping>   

22、配置struts   

    <display-name>struts blank application</display-name>   

    <servlet>   

        <servlet-name>action</servlet-name>   

        <servlet-class>   

            org.apache.struts.action.actionservlet   

        </servlet-class>   

            <param-name>detail</param-name>   

            <param-value>2</param-value>   

            <param-name>debug</param-name>   

            <param-name>config</param-name>   

            <param-value>/web-inf/struts-config.xml</param-value>   

            <param-name>application</param-name>   

            <param-value>applicationresources</param-value>   

        <load-on-startup>2</load-on-startup>   

    </servlet>   

    <servlet-mapping>   

        <url-pattern>*.do</url-pattern>   

    </servlet-mapping>   

    <welcome-file-list>   

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

    </welcome-file-list>   

    <!-- struts tag library descriptors -->   

    <taglib>   

        <taglib-uri>struts-bean</taglib-uri>   

        <taglib-location>/web-inf/tld/struts-bean.tld</taglib-location>   

    </taglib>   

        <taglib-uri>struts-html</taglib-uri>   

        <taglib-location>/web-inf/tld/struts-html.tld</taglib-location>   

    <taglib-uri>struts-nested</taglib-uri>   

    <taglib-location>/web-inf/tld/struts-nested.tld</taglib-location>   

        <taglib-uri>struts-logic</taglib-uri>   

        <taglib-location>/web-inf/tld/struts-logic.tld</taglib-location>   

        <taglib-uri>struts-tiles</taglib-uri>   

        <taglib-location>/web-inf/tld/struts-tiles.tld</taglib-location>   

23、配置spring(基本上都是在struts中配置的)   

   <!-- 指定spring配置文件位置 -->   

   <context-param>   

      <param-name>contextconfiglocation</param-name>   

      <param-value>   

       <!--加载多个spring配置文件 -->   

        /web-inf/applicationcontext.xml, /web-inf/action-servlet.xml   

      </param-value>   

   </context-param>   

   <!-- 定义spring监听器,加载spring -->   

     <listener-class>org.springframework.web.context.contextloaderlistener</listener-class>   

     <listener-class>   

       org.springframework.web.context.request.requestcontextlistener   

     </listener-class>   

</listener>