zoukankan      html  css  js  c++  java
  • web.xml文件详解

    原文:https://www.cnblogs.com/Jimc/p/9565603.html

    目录:

      1. web.xml各版本区别

      2. web.xml配置详解

        2.1 java web项目启动加载顺序

        2.2 web.xml中定义的元素

    web.xml文件是Java Web项目中的一个配置文件,主要用于配置欢迎页、Filter、Listener、Servlet等,但并不是必须的,一个Java Web项目没有web.xml文件也是照样能跑起来的。

    1. web.xml各版本区别

    首先来看一下Tomcat官网的Servlet和JSP规范规范与的Apache Tomcat版本之间的对应关系,如图:

    从中可以清晰的看到不同版本的web.xml文件要使用相应版本的Tomcat服务器。

    下面是各版本的web.xml配置的头部声明:

    servlet2.3

    <?xml version="1.0" encoding="UTF-8"?>  
    <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
    <web-app>  
       
    </web-app>
    

    servlet2.4

    <?xml version="1.0" encoding="UTF-8"?>
    <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
             http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
             version="2.4">
     
    </web-app>
    
    

    servlet2.5

    <?xml version="1.0" encoding="UTF-8"?>
    <web-app 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_2_5.xsd"
           version="2.5">
       
    </web-app>
    
    

    servlet3.0

    <?xml version="1.0" encoding="UTF-8"?>
    <web-app 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"
             version="3.0">
              
    </web-app>
    

    servlet3.1

    <?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
             version="3.1">
            
    </web-app>
    

    servlet4.0

    <?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
             version="4.0">
      
    </web-app>
    

    Tomcat在激活、加载、部署web应用时,会解析加载${CATALINA_HOME}/conf目录下所有web应用通用的web.xml,然后解析加载web应用目录中的WEB-INF/web.xml。如果没有WEB-INF/web.xml文件,tomcat会输出找不到的消息,但仍然会部署并使用web应用程序,因此,这个web.xml并不是必要的,不过通常最好还是让每一个上线的web应用程序都有一个自己的WEB-INF/web.xml。

    conf/web.xml文件中的设定会应用于所有的web应用程序,而web应用程序的WEB-INF/web.xml中的设定只应用于该应用程序本身。

    2. web.xml配置详解

    2.1 java web项目启动加载顺序

    (1)启动WEB项目的时候,容器(如:Tomcat)会去读它的配置文件web.xml的两个节点:

      

    (2)容器创建一个ServletContext(上下文);

    (3)容器将转化为键值对,并交给ServletContext;

    (4)容器创建中的类实例,即创建监听;

    (5)容器初始化,web.xml中可以定义多个 filter,初始化每个 filter 时,是按照 filter 配置节出现的顺序来初始化的,当请求资源匹配多个 filter-mapping 时,filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的;

    (6)容器初始化, servlet 同 filter 类似。

    那么,web项目启动时,可以知道web.xml文件各个节点的加载顺序:context-param -> listener -> filter -> servlet

    2.2 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应用图标

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

    (2)Web 应用名称

    <display-name>App Name</display-name>
    

    (3)Web 应用描述

    <disciption>This is a app disciption.</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)过滤器配置

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

    (6)监听器配置

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

    (7)Servlet配置

    基本配置:

    <servlet> 
        <servlet-name>test</servlet-name> 
        <servlet-class>TestServlet</servlet-class> 
    </servlet> 
    <servlet-mapping> 
        <servlet-name>test</servlet-name> 
        <url-pattern>/test</url-pattern> 
    </servlet-mapping> 
    

    高级配置:

           <servlet-name>test</servlet-name> 
           <servlet-class>TestServlet</servlet-class> 
           <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> 
               <!--                  当Web应用启动时,装载Servlet的次序
                     当值为正数或零时:Servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet. 
                     当值为负或未定义:Servlet容器将在Web客户首次访问这个servlet时加载它 
                -->
        <load-on-startup>1</load-on-startup>
       </servlet> 
       <servlet-mapping> 
           <servlet-name>test</servlet-name> 
           <url-pattern>/test</url-pattern> 
       </servlet-mapping>         
    

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

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

    (9)MIME类型配置

    <mime-mapping> 
        <extension>html</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)配置错误页面

    方法1:通过错误码来配置error-page

    <error-page> 
        <error-code>404</error-code> 
        <location>/404.jsp</location> 
    </error-page> 
    

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

    方法2:通过异常类型配置error-page

    <error-page> 
        <exception-type>java.lang.NullException</exception-type> 
        <location>/error.jsp</location> 
    </error-page> 
    

    上面的配置当系统发生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> 
    

    配置数据库连接池就可在此配置:

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

    (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> 
    
  • 相关阅读:
    Nginx日志定时切割脚本
    阿里大于短信接口
    阿里云Linux系统挂载数据盘
    阿里云 OSS+CDN
    值得一学的几条谷歌搜索技巧
    【转】makefile语法规则
    【转】GCC使用简介
    网络编程中常见地址结构与转换(IPv4/IPv6)
    【转】adns解析库——域名解析实例(C++、linux)
    【转】什么是自动化测试
  • 原文地址:https://www.cnblogs.com/zbm-gg/p/13394190.html
Copyright © 2011-2022 走看看