美文网首页
Java Web学习笔记(二):web.xml 配置文件

Java Web学习笔记(二):web.xml 配置文件

作者: 简单一点点 | 来源:发表于2019-07-24 22:39 被阅读0次

    web.xml 配置文件

    Web工程可以使用web.xml添加相关的配置信息。

    web.xml配置项

    下面分别介绍一下web.xml中的各个配置项。

    web-app

    <web-app>是配置文件的根标签,web.xml的模式文件是由Sun公司定义的,它必须标明web.xml使用的是哪个模式文件。

    其中Servlet 3.0中的web.xml模板如下所示。

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

    display-name

    <display-name>标签表明了Web应用的名称。

    <display-name>WykWebDemo</display-name>
    

    welcome-list-file

    <welcome-file-list>定义首页文件,其中包含子元素welcome-list,每个定义一个首页,可以定义多个。

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

    context-param

    <context-param>用来声明应用范围(整个WEB项目)内的上下文初始化参数。param-name设定上下文的参数名称,必须是唯一名称;param-value 设定的参数名称的值。

    比如在Spring MVC中经常使用如下配置。

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/applicationContext.xml</param-value>
    </context-param>
    

    context-param声明的参数,可以通过如下方式获取:

    • 在JSP中,可以通过${initParam.contextConfigLocation} 获取。
    • 在Servlet中,通过如下代码:
    String paramValue=getServletContext().getInitParameter("contextConfigLocation");
    

    servlet

    <servlet>用来声明一个servlet的数据,主要有以下子元素:

    servlet-name

    指定servlet的名称。

    servlet-class

    servlet的类名称。

    jsp-file

    指定web站台中的某个JSP网页的完整路径

    init-param

    定义初始化参数,可有多个init-param。在servlet类中通过ServletConfig对象传入init函数,通过 getInitParamenter(String name)方法访问初始化参数.

    下面看一个初始化数据库连接参数的例子。

    web.xml中的servlet配置如下。

    <servlet>
        <servlet-name>myServlet</servlet-name>
        <servlet-class>*.myservlet</servlet-class>
        <init-param>
            <param-name>driver</param-name>
            <param-value>com.mysql.jdbc.Driver</param-value>
        </init-param>
        <init-param>
            <param-name>url</param-name>
            <param-value>jdbc:mysql://localhost:3306/myDatabase</param-value>
        </init-param>
        <init-param>
            <param-name>username</param-name>
            <param-value>tang</param-value>
        </init-param>
        <init-param>
            <param-name>passwd</param-name>
            <param-value>whu</param-value>
        </init-param>
    </servlet>
    

    在代码中调用方式如下:

    public void init(ServletConfig config) throws SevletException{
        super(config);
        String driver = config.getInitParameter("driver");
        String url = config.getInitParameter("url");
        String username = config.getInitParameter("username");
        String passwd = config.getInitParameter("passwd");
        try{
            Class.forName(driver).newInstance();
            this.conn = DriverManager.getConnection(url, username, passwd);
            System.out.println("Connection successful...");
        } catch(SQLExceprion se){
            System.out.println("se");
        } catch(Exception e){
            e.printStackTrace():
        }
        
    }
    

    load-on-startup

    指定当Web应用启动时,装载Servlet的次序。当值为正数或零时:Servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet。当值为负或未定义:Servlet容器将在Web客户首次访问这个servlet时加载它。

    serlvet-mapping

    用来定义servlet所对应的URL,包含两个子元素。

    <servlet>
        <servlet-name>wykServlet</servlet-name>
        <servlet-class>*.Wykservlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>wykServlet</servlet-name>
        <url-pattern>/wykServlet</url-pattern>
    </servlet-mapping>
    

    serlvet-mapping不是必须的,程序可以根据类名和文件名自动映射。

    servlet-name

    servlet名称,必须是在servlet标签中定义过的名称。

    url-pattern

    servlet对应的url。如果请求的url能够匹配该url-pattern,则使用servlet-name指定的servlet处理该请求。

    url-pattern匹配规则按照优先级从高到低排列:

    1. 精确匹配:类似于/myServlet的精确路径
    2. 通配符匹配:/*或/wyk/*
    3. 扩展名匹配:*.html,*.jpg ,.do ,.action之类的
    4. 默认匹配(/)——当之前匹配都不成功时

    需要注意的是:/*.action这种匹配式是错误的,容器无法识别同时拥有两种匹配规则的pattern。

    filter

    filter用来配置过滤器。

    <filter>
        <display-name>FilterDemo1</display-name>
        <filter-name>FilterDemo1</filter-name>
        <filter-class>com.demo.filter.FilterDemo1</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    
    <filter-mapping>
        <filter-name>FilterDemo1</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    

    filter-name

    过滤器的名称,不能为空。

    filter-class

    过滤器的类名。

    init-param

    设置过滤器的初始化参数,可以包含多个,子元素param-name指定参数名,param-value指定参数值。

    filter-mapping

    用来设置过滤器所拦截的资源,一个Filter拦截的资源可通过两种方式来指定:Servlet名称和资源访问的请求路径。

    filter-name

    用于设置过滤器的名称。该值必须是在filter元素中声明过的过滤器的名字。

    url-pattern

    设置过滤器所拦截的请求路径(过滤器关联的URL样式)。

    <filter-mapping>
        <filter-name>FilterDemo02</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    ```  
    #### servlet-name
    
    指定过滤器所拦截的Servlet名称。
    
    ```xml
    <filter-mapping>
        <filter-name>testFilter</filter-name>
        <servlet-name>ProductServlet</servlet-name>
    </filter-mapping>
    

    dispatcher

    指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以设置多个。可选值包括:

    • REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用,该值为默认值。
    • INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
    • FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
    • ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
    <filter-mapping>
        <filter-name>testFilter</filter-name>
        <servlet-name>ProductServlet</servlet-name>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
    </filter-mapping>
    

    listener

    用来注册一个监听器,包含一个子元素listenr-class,用来指定监听器的类名。

    <listener>    
        <listener-class>    
            com.wyk.LogListener    
        </listener-class>    
    </listener>  
    

    session-config

    用来设置session相关参数,子元素session-timeout用来设置session超时时间,单位是分钟。

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

    error-page

    用来配置错误页面,可以通过资源error-code指定HTTP错误码,也可以通过资源exception-type指定异常类型。

    <error-page> 
        <error-code>500</error-code> 
        <location>/WEB-INF/exception/500.jsp</location> 
    </error-page> 
    <error-page> 
        <exception-type>java.lang.Exception</exception-type> 
        <location>/WEB-INF/exception/error.jsp</location> 
    </error-page> 
    

    mime-mapping

    定义一个扩展名和一个MIME TYPE做映射,包含两个子元素:extension指定扩展名,mime-type指定MIME格式。

    <mime-mapping> 
        <extension>doc</extension>
        <mime-type>application/msword</mime-type> 
    </mime-mapping> 
    

    初始化过程

    Web工程的启动过程:

    1. 在启动Web项目时,Web容器(比如Tomcat)会读web.xml配置文件中的两个节点<listener>和<contex-param>。
    2. 接着容器会创建一个ServletContext(上下文),应用范围内即整个WEB项目都能使用这个上下文。
    3. 然后容器会将读取到<context-param>转化为键值对,并交给ServletContext。
    4. 容器创建<listener>中的类实例,即创建监听器。
    5. 在监听的类中会有一个contextInitialized(ServletContextEvent event)初始化方法,在这个方法中可以通过event.getServletContext().getInitParameter("contextConfigLocation")来得到context-param设定的值。在这个类中还必须有一个contextDestroyed(ServletContextEvent event)销毁方法.用于关闭应用前释放资源,比如说数据库连接的关闭。
    6. 得到这个context-param的值之后,你就可以做一些操作了.注意,这个时候你的WEB项目还没有完全启动完成.这个动作会比所有的Servlet都要早。

    注解配置

    待补充。。。

    相关文章

      网友评论

          本文标题:Java Web学习笔记(二):web.xml 配置文件

          本文链接:https://www.haomeiwen.com/subject/hszwlctx.html