web.xml配置文件

2020-07-26  本文已影响0人  A_一只小菜鸟

一、web.xml是什么？

首先 web.xml 是java web 项目的一个重要的配置文件，但是web.xml文件并不是Java web工程必须的。
web.xml文件是用来配置：欢迎页、servlet、listener、filter等的。当你的web工程没用到这些时，你可以不用web.xml文件来配置你的web工程。
所在位置 项目名/web/WEB-INFO/web.xml，如下图所示:


1261122-20180811214923785-313436624.png

web.xml能做的事情：
其实，web.xml的模式(Schema)文件中定义了多少种标签元素，web.xml中就可以出现它的模式文件所定义的标签元素，它就能拥有定义出来的那些功能。
web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个web.xml使用的是哪个模式文件。如：
web.xml 配置文件 具体的内容


1261122-20180811214956353-509285906.png

二、Web.xml详解：

1.web.xml加载过程（步骤）

首先简单讲一下，web.xml的加载过程。当启动一个WEB项目时，容器包括（JBoss、Tomcat等）首先会读取项目web.xml配置文件里的配置，当这一步骤没有出错并且完成之后，项目才能正常地被启动起来。

  1. 启动WEB项目的时候，容器首先会去它的配置文件web.xml读取两个节点: <listener></listener>和<context-param></context-param>。
  2. 紧接着，容器创建一个ServletContext（application），这个WEB项目所有部分都将共享这个上下文。
  3. 容器以<context-param></context-param>的name作为键，value作为值，将其转化为键值对，存入ServletContext。
  4. 容器创建<listener></listener>中的类实例，根据配置的class类路径<listener-class>来创建监听，在监听中会有contextInitialized(ServletContextEvent args)初始化方法，启动Web应用时，系统调用Listener的该方法，在这个方法中获得：
ServletContextapplication=ServletContextEvent.getServletContext();

context-param的值就是application.getInitParameter("context-param的键");得到这个context-param的值之后，你就可以做一些操作了。

  1. 举例：你可能想在项目启动之前就打开数据库，那么这里就可以在<context-param>中设置数据库的连接方式（驱动、url、user、password），在监听类中初始化数据库的连接。这个监听是自己写的一个类，除了初始化方法，它还有销毁方法，用于关闭应用前释放资源。比如:说数据库连接的关闭，此时，调用contextDestroyed(ServletContextEvent args)，关闭Web应用时，系统调用Listener的该方法。
  2. 接着，容器会读取<filter></filter>，根据指定的类路径来实例化过滤器。
  3. 以上都是在WEB项目还没有完全启动起来的时候就已经完成了的工作。如果系统中有Servlet，则Servlet是在第一次发起请求的时候被实例化的，而且一般不会被容器销毁，它可以服务于多个用户的请求。所以，Servlet的初始化都要比上面提到的那几个要迟。
  4. 总的来说，web.xml的加载顺序是:<context-param>-><listener>-><filter>-><servlet>。其中，如果web.xml中出现了相同的元素，则按照在配置文件中出现的先后顺序来加载。
  5. 对于某类元素而言，与它们出现的顺序是有关的。以<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>类似，此处不再赘述。

ps:javaEE项目Servlet中读取web.xml中context-param 和 init-param参数

大概代码：
web.xml

<servlet>   
<servlet-name>ServletHeader</servlet-name>      
<servlet-class>com.xx.study.servlet.ServletHeader</servlet-class> 
<init-param>        
<param-name>servletParam</param-name>       
<param-value>servlet init-param 初始化参数</param-value>     
</init-param>  
</servlet>     
<context-param>     
<param-name>contextParam</param-name>   
<param-value>context Param 参数</param-value>  
</context-param>

ServletHeader 中 init() 方法

@Override
public void init(ServletConfig config) throws ServletException {
String contextParam = config.getInitParameter("contextParam");
String servletParam = config.getInitParameter("servletParam");
// 结果：  contextParam:null    servletParam: servlet init-param 初始化参数 
String contextParam2 = config.getServletContext().getInitParameter("contextParam"); 
String servletParam2 = config.getServletContext().getInitParameter("servletParam");
//结果：   contextParam2:context Param 参数   servletParam2: null}

结果分析:
1、 <init-param> 是 <servlet> 子元素，直接用 config.getInitParameter("xx"); 就可以获取到。
2、 <context-param> 是 <web-app> 根节点的下级元素，作用域是在整个ServletContext 范围内，需要 servletContext.getInitParameter("xx"); 才能获取到。
3、且 ServletContext 范围参数和 ServletConifg 范围参数不互通。
总结:
1、获取 <servlet> 标签下的 <init-param> 属性值： servletConifg.getInitParameter("xx");
2、获取<web-app>下面的<context-param>属性值：servletContext.getInitParameter("xx");
3、注意获取属性值的方法名是一样的，但是调用的对象不一样。 （servlet范围和Application范围的区别）

2.web.xml标签详解

1、schema

web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在<web-app></web-app>之中。

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" 
    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">
</web-app>
2、<icon>Web应用图标

指出IDE和GUI工具用来表示Web应用的大图标和小图标

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

3、<display-name>Web应用名称
提供GUI工具可能会用来标记这个特定的Web应用的一个名称

<display-name>Tomcat Example</display-name>

4、<disciption>Web应用描述
给出于此相关的说明性文本

<disciption>Tomcat Example servlets and JSP pages.</disciption>

5、<context-param>上下文参数
声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。

<context-param>
    <param-name>ContextParameter</para-name>
    <param-value>test</param-value>
    <description>It is a test parameter.</description>
</context-param>

6、<filter>过滤器
将一个名字与一个实现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>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>setCharacterEncoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

7、<listener>监听器

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

8、<servlet>
<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，包含两个子元素
<url-pattern></url-pattern> 指定servlet所对应的URL

<!-- 基本配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>
<!-- 高级配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</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>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>

9、<session-config>会话超时配置
单位为分钟。

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

10、<mime-mapping>

<mime-mapping>
    <extension>htm</extension>
    <mime-type>text/html</mime-type>
</mime-mapping>

11、<welcome-file-list>欢迎文件页

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

12、<error-page>错误页面

<!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->
<error-page>
    <error-code>404</error-code>
    <location>/NotFound.jsp</location>
</error-page>
<!-- 2、通过异常的类型配置error-page。当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面。 -->
<error-page>
    <exception-type>java.lang.NullException</exception-type>
    <location>/error.jsp</location>
</error-page>

说明：
意思就是Http的状态码返回404,500错误，就跳转到指定的location页面。exception-type就是指web应用抛出了指定的异常就跳转到指定的location页面。
13、mime-mapping

<mime-mapping>
    <extension>pdf</extension>
    <mime-type>application/pdf</mime-type>
</mime-mapping>

说明：
Http协议提供了MIME因特网邮件扩展扩展，其允许邮件处理文本、图片、视频等文件。MIME扩展中会使用一种称为多部分对象集合的方法来容纳多份不同类型的数据。

上一篇 下一篇

猜你喜欢

热点阅读