Spring MVC的web.xml配置详解

spring是目前最流行的框架。创建java web项目时，我们首先会遇到的配置文件就是web.xml，这是javaweb为我们封装的逻辑，不在今天的研究中。下面我们将简单讲讲web.xml中的配置。

一、一个空的web.xml

<?xml version="1.0" encoding="utf-8"?>
<web-app version="3.0" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
  xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
  xsi:schemalocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
  id="webapp_id">
</web-app>

二、标签介绍

web.xml中比较常见的标签以及其加载顺序为：

context-param > listener > filter > servlet

1、 <display-name>archetype created web application</display-name>

display-name 是标识项目的名称，这个不是很常用，可有可无的，或者说不需要我们去在意的东西。

2、 <context-param>

<context-param>
  <param-name>webapprootkey</param-name>
  <param-value>60000</param-value>
</context-param>

context-param 是web.xml首先加载的标签，其下子标签有param-name和param-value.

此所设定的参数,在jsp网页中可以使用下列方法来取得:

${initparam.webapprootkey}

若在servlet可以使用下列方法来获得:

string param_name=getservletcontext().getinitparamter(“webapprootkey”);

3、listener

<listener>
    <listener-class>org.springframework.web.context.request.requestcontextlistener</listener-class>
</listener>

listenter在项目开始的时候就注入进来，尽在context-param之后，所以正常我们将spring配置在listener 中，这样方法spring 初始化相关的bean。

4、filter

<filter>
    <filter-name>characterencodingfilter</filter-name>
    <filter-class>org.springframework.web.filter.characterencodingfilter</filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>utf-8</param-value>
    </init-param>
    <init-param>
      <param-name>forceencoding</param-name>
      <param-value>true</param-value>
    </init-param>
  </filter>

  <filter-mapping>
    <filter-name>characterencodingfilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

filter起到一个过滤的作用，在servlet执行前后，像上面的配置就是在过滤servlet前将编码转换utf-8,filter-mapping 则是将filter和url路径进行映射。其中init-param则是将初始化需要的参数传入到filter-class中从而进行初始化。filter和filter-mapping中的name必须是相同的，才能起到映射的作用，而filter-mapping 中的url-pattern则是匹配请求路径的。上面‘/*'表示过滤所有请求的servlet,如果写成‘/zxh',则过滤http://localhost:8080/项目名/zxh这个请求。

5、servlet

  <servlet> 
    <!-- 配置dispatcherservlet --> 
    <servlet-name>springmvc</servlet-name> 
    <servlet-class>org.springframework.web.servlet.dispatcherservlet</servlet-class> 
      <!-- 指定spring mvc配置文件位置 不指定使用默认情况 --> 
      <init-param>   
        <param-name>contextconfiglocation</param-name>
        <param-value>classpath:spring/spring-mvc.xml</param-value>
      </init-param> 
    <!-- 设置启动顺序 --> 
    <load-on-startup>1</load-on-startup> 
  </servlet>

  <!-- servlet 匹配映射 -->
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>*.zxh</url-pattern>
  </servlet-mapping>

servlet和filter类似，需要先指定servlet对应的class类，然后将这个类和utl路径请求地址进行映射。这里不多说了。

以上就是web.xml文件中出现最多的几个标签。其他的比如:

6、欢迎页

<welcome-file-list>
    <welcome-file>login.jsp</welcome-file>
  </welcome-file-list>

7、错误页

  <!-- 后台程序异常错误跳转页面 -->
  <error-page> 
    <exception-type>java.lang.throwable</exception-type> 
    <location>/views/error.jsp</location> 
  </error-page> 

  <!-- 500跳转页面-->
  <error-page> 
    <error-code>500</error-code> 
    <location>/views/500.jsp</location> 
  </error-page> 

  <!-- 404跳转页面 -->
  <error-page> 
    <error-code>404</error-code> 
    <location>/views/404.jsp</location> 
  </error-page>

三、示例

1、spring 框架解决字符串编码问题：过滤器 characterencodingfilter（filter-name）

2、在web.xml配置监听器contextloaderlistener（listener-class）
contextloaderlistener的作用就是启动web容器时，自动装配applicationcontext的配置信息。因为它实现了servletcontextlistener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。

3、部署applicationcontext的xml文件：contextconfiglocation（context-param下的param-name）

4、dispatcherservlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标controller(我们写的action)来处理。

dispatcherservlet（servlet-name、servlet-class、init-param、param-name(contextconfiglocation)、param-value）
在dispatcherservlet的初始化过程中，框架会在web应用的 web-inf文件夹下寻找名为[servlet-name]-servlet.xml 的配置文件，生成文件中定义的bean

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

  <!-- 在spring框架中是如何解决从页面传来的字符串的编码问题的呢？
  下面我们来看看spring框架给我们提供过滤器characterencodingfilter 
   这个过滤器就是针对于每次浏览器请求进行过滤的，然后再其之上添加了父类没有的功能即处理字符编码。 
   其中encoding用来设置编码格式，forceencoding用来设置是否理会 request.getcharacterencoding()方法，设置为true则强制覆盖之前的编码格式。--> 
  <filter> 
    <filter-name>characterencodingfilter</filter-name> 
    <filter-class>org.springframework.web.filter.characterencodingfilter</filter-class> 
    <init-param> 
      <param-name>encoding</param-name> 
      <param-value>utf-8</param-value> 
    </init-param> 
    <init-param> 
      <param-name>forceencoding</param-name> 
      <param-value>true</param-value> 
    </init-param> 
  </filter> 
  <filter-mapping> 
    <filter-name>characterencodingfilter</filter-name> 
    <url-pattern>/*</url-pattern> 
  </filter-mapping> 
  <!-- 项目中使用spring 时，applicationcontext.xml配置文件中并没有beanfactory，要想在业务层中的class 文件中直接引用spring容器管理的bean可通过以下方式--> 
  <!--1、在web.xml配置监听器contextloaderlistener--> 
  <!--contextloaderlistener的作用就是启动web容器时，自动装配applicationcontext的配置信息。因为它实现了servletcontextlistener这个接口，在web.xml配置这个监听器，启动容器时，就会默认执行它实现的方法。 
  在contextloaderlistener中关联了contextloader这个类，所以整个加载配置过程由contextloader来完成。 
  它的api说明 
  第一段说明contextloader可以由 contextloaderlistener和contextloaderservlet生成。 
  如果查看contextloaderservlet的api，可以看到它也关联了contextloader这个类而且它实现了httpservlet这个接口 
  第二段，contextloader创建的是 xmlwebapplicationcontext这样一个类，它实现的接口是webapplicationcontext->configurablewebapplicationcontext->applicationcontext-> 
  beanfactory这样一来spring中的所有bean都由这个类来创建 
   iuploaddatafilemanager uploadmanager = (iuploaddatafilemanager)  contextloaderlistener.getcurrentwebapplicationcontext().getbean("uploadmanager");
   --> 
  <listener> 
    <listener-class>org.springframework.web.context.contextloaderlistener</listener-class> 
  </listener> 
  <!--2、部署applicationcontext的xml文件--> 
  <!--如果在web.xml中不写任何参数配置信息，默认的路径是"/web-inf/applicationcontext.xml， 
  在web-inf目录下创建的xml文件的名称必须是applicationcontext.xml。 
  如果是要自定义文件名可以在web.xml里加入contextconfiglocation这个context参数： 
  在<param-value> </param-value>里指定相应的xml文件名，如果有多个xml文件，可以写在一起并以“,”号分隔。 
  也可以这样applicationcontext-*.xml采用通配符，比如这那个目录下有applicationcontext-ibatis-base.xml， 
  applicationcontext-action.xml，applicationcontext-ibatis-dao.xml等文件，都会一同被载入。 
  在contextloaderlistener中关联了contextloader这个类，所以整个加载配置过程由contextloader来完成。--> 
  <context-param> 
    <param-name>contextconfiglocation</param-name> 
    <param-value>classpath:spring/applicationcontext.xml</param-value> 
  </context-param> 

  <!--如果你的dispatcherservlet拦截"/"，为了实现rest风格，拦截了所有的请求，那么同时对*.js,*.jpg等静态文件的访问也就被拦截了。--> 
  <!--方案一：激活tomcat的defaultservlet来处理静态文件--> 
  <!--要写在dispatcherservlet的前面， 让 defaultservlet先拦截请求，这样请求就不会进入spring了，我想性能是最好的吧。--> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.css</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.swf</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.gif</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.jpg</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.png</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.js</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.html</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.xml</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.json</url-pattern> 
  </servlet-mapping> 
  <servlet-mapping> 
    <servlet-name>default</servlet-name> 
    <url-pattern>*.map</url-pattern> 
  </servlet-mapping> 
  <!--使用spring mvc,配置dispatcherservlet是第一步。dispatcherservlet是一个servlet,,所以可以配置多个dispatcherservlet--> 
  <!--dispatcherservlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标controller(我们写的action)来处理。--> 
  <servlet> 
    <servlet-name>dispatcherservlet</servlet-name><!--在dispatcherservlet的初始化过程中，框架会在web应用的 web-inf文件夹下寻找名为[servlet-name]-servlet.xml 的配置文件，生成文件中定义的bean。--> 
    <servlet-class>org.springframework.web.servlet.dispatcherservlet</servlet-class> 
    <!--指明了配置文件的文件名，不使用默认配置文件名，而使用dispatcher-servlet.xml配置文件。--> 
    <init-param> 
      <param-name>contextconfiglocation</param-name> 
      <!--其中<param-value>**.xml</param-value> 这里可以使用多种写法--> 
      <!--1、不写,使用默认值:/web-inf/<servlet-name>-servlet.xml--> 
      <!--2、<param-value>/web-inf/classes/dispatcher-servlet.xml</param-value>--> 
      <!--3、<param-value>classpath*:dispatcher-servlet.xml</param-value>--> 
      <!--4、多个值用逗号分隔--> 
      <param-value>classpath:spring/dispatcher-servlet.xml</param-value> 
    </init-param> 
    <load-on-startup>1</load-on-startup><!--是启动顺序，让这个servlet随servletp容器一起启动。--> 
  </servlet> 
  <servlet-mapping> 
    <!--这个servlet的名字是dispatcher，可以有多个dispatcherservlet，是通过名字来区分的。每一个dispatcherservlet有自己的webapplicationcontext上下文对象。同时保存的servletcontext中和request对象中.--> 
    <!--applicationcontext是spring的核心，context我们通常解释为上下文环境，我想用“容器”来表述它更容易理解一些，applicationcontext则是“应用的容器”了:p，spring把bean放在这个容器中，在需要的时候，用getbean方法取出--> 
    <servlet-name>dispatcherservlet</servlet-name> 
    <!--servlet拦截匹配规则可以自已定义，当映射为@requestmapping("/user/add")时，为例,拦截哪种url合适？--> 
    <!--1、拦截*.do、*.htm， 例如：/user/add.do,这是最传统的方式，最简单也最实用。不会导致静态文件（jpg,js,css）被拦截。--> 
    <!--2、拦截/，例如：/user/add,可以实现现在很流行的rest风格。很多互联网类型的应用很喜欢这种风格的url。弊端：会导致静态文件（jpg,js,css）被拦截后不能正常显示。 --> 
    <url-pattern>/</url-pattern> <!--会拦截url中带“/”的请求。--> 
  </servlet-mapping> 

  <welcome-file-list><!--指定欢迎页面--> 
    <welcome-file>login.html</welcome-file> 
  </welcome-file-list> 
  <error-page> <!--当系统出现404错误，跳转到页面nopage.html--> 
    <error-code>404</error-code> 
    <location>/nopage.html</location> 
  </error-page> 
  <error-page> <!--当系统出现java.lang.nullpointerexception，跳转到页面error.html--> 
    <exception-type>java.lang.nullpointerexception</exception-type> 
    <location>/error.html</location> 
  </error-page> 
  <session-config><!--会话超时配置，单位分钟--> 
    <session-timeout>360</session-timeout> 
  </session-config> 
</web-app>

四、spring加载

通过上面的了解，我们可以看出spring核心配置文件就是listener那块。在监听之前我们已经通过context-param将spring配置文件传到上下文中了(application)。下面我们就来看看spring是如何工作的吧

第一步：

点开listener源码，我们发现他有下面几个方法。和继承的关系。我们发现他实现了contextloaderlistener这个接口，这个接口在参数设置好之后自动执行contextinitialized方法的。

那么我们来看看contextinitialized方法

public webapplicationcontext initwebapplicationcontext(servletcontext servletcontext) {
    if (servletcontext.getattribute(webapplicationcontext.root_web_application_context_attribute) != null) {
      throw new illegalstateexception(
          "cannot initialize context because there is already a root application context present - " +
          "check whether you have multiple contextloader* definitions in your web.xml!");
    }

    log logger = logfactory.getlog(contextloader.class);
    servletcontext.log("initializing spring root webapplicationcontext");
    if (logger.isinfoenabled()) {
      logger.info("root webapplicationcontext: initialization started");
    }
    long starttime = system.currenttimemillis();

    try {
      // store context in local instance variable, to guarantee that
      // it is available on servletcontext shutdown.
      if (this.context == null) {
        this.context = createwebapplicationcontext(servletcontext);
      }
      if (this.context instanceof configurablewebapplicationcontext) {
        configurablewebapplicationcontext cwac = (configurablewebapplicationcontext) this.context;
        if (!cwac.isactive()) {
          // the context has not yet been refreshed -> provide services such as
          // setting the parent context, setting the application context id, etc
          if (cwac.getparent() == null) {
            // the context instance was injected without an explicit parent ->
            // determine parent for root web application context, if any.
            applicationcontext parent = loadparentcontext(servletcontext);
            cwac.setparent(parent);
          }
          configureandrefreshwebapplicationcontext(cwac, servletcontext);
        }
      }
      servletcontext.setattribute(webapplicationcontext.root_web_application_context_attribute, this.context);

      classloader ccl = thread.currentthread().getcontextclassloader();
      if (ccl == contextloader.class.getclassloader()) {
        currentcontext = this.context;
      }
      else if (ccl != null) {
        currentcontextperthread.put(ccl, this.context);
      }

      if (logger.isdebugenabled()) {
        logger.debug("published root webapplicationcontext as servletcontext attribute with name [" +
            webapplicationcontext.root_web_application_context_attribute + "]");
      }
      if (logger.isinfoenabled()) {
        long elapsedtime = system.currenttimemillis() - starttime;
        logger.info("root webapplicationcontext: initialization completed in " + elapsedtime + " ms");
      }

      return this.context;
    }
    catch (runtimeexception ex) {
      logger.error("context initialization failed", ex);
      servletcontext.setattribute(webapplicationcontext.root_web_application_context_attribute, ex);
      throw ex;
    }
    catch (error err) {
      logger.error("context initialization failed", err);
      servletcontext.setattribute(webapplicationcontext.root_web_application_context_attribute, err);
      throw err;
    }
  }

仔细研究官方解释，就是在这里初始化application，这里会用到contextclass+contextconfiglocation两个参数，如果contextclass在context-param提供了，我们就会根据这一个class去初始化application，很显然我们正常配置都没有配这个，而是配置了后者，配置了后者就会去根据contextconfiglocation中提供的配置文件去解析然后创建相关的bean和application操作，这个方法的最后会执行configureandrefreshwebapplicationcontext方法。这个方法就是在根据contextconfiglocation提供的配置文件中创建相关的bean。

五、springmvc 加载

springmvc其实和spring是一样的，但是他不用再程序开始时访问

  <servlet> 
    <!-- 配置dispatcherservlet --> 
    <servlet-name>springmvc</servlet-name> 
    <servlet-class>org.springframework.web.servlet.dispatcherservlet</servlet-class> 
      <!-- 指定spring mvc配置文件位置 不指定使用默认情况 --> 
      <init-param>   
        <param-name>contextconfiglocation</param-name>
        <param-value>classpath:spring/spring-mvc.xml</param-value>
      </init-param> 
    <!-- 设置启动顺序 --> 
    <load-on-startup>1</load-on-startup> 
  </servlet>

  <!-- servlet 匹配映射 -->
  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>*.zxh</url-pattern>
  </servlet-mapping>

看dispatcherservlet源码中对contextconfiglocation参数的解释

上面明确指出我们这个参数给xmlwebapplicationcontext类的，我们在进入xmlwebapplicationcontext类看看究竟。

这样我们很容易理解为什么springmvc默认的配置文件会在web-inf/application.xml中的吧。

在dispatcherservlet中有一个初始化方法，这里就初始化配置中一些东西，比如说文件上传适配器的配置等等。

protected void initstrategies(applicationcontext context) {
    initmultipartresolver(context);
    initlocaleresolver(context);
    initthemeresolver(context);
    inithandlermappings(context);
    inithandleradapters(context);
    inithandlerexceptionresolvers(context);
    initrequesttoviewnametranslator(context);
    initviewresolvers(context);
    initflashmapmanager(context);
  }

总结

spring+springmvc在配置中主要就是上面的两个配置，当然spring的强大不是我们一两天能够研究来的，我上面只是简单的研究讨论了一下。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。