web.xml文件配置详解

本人在写web程序中，开始对web.xml文件要写什么，怎么写等有疑问，因此在查看了几篇博客后，总结如下

----------------------------------------------------------------------------------------------

每个javaEE工程中都有web.xml文件，那么它的作用是什么呢？它是每个web.xml工程都必须的吗？

一个web中可以没有web.xml文件，也就是说，web.xml文件并不是web工程必须的。

web.xml文件是用来初始化配置信息：比如Welcome页面、servlet、servlet-mapping、filter、listener、启动加载级别、或者各种框架等。

当你的web工程没用到这些时，你可以不用web.xml文件来配置你的Application。

----------------------------------------------------------------------------------------------

每个xml文件都有定义它书写规则的Schema文件，也就是说javaEE的定义web.xml所对应的xml Schema文件中定义了多少种标签元素，web.xml中就可以出现它所定义的标签元素，也就具备哪些特定的功能。web.xml的模式文件是由Sun 公司定义的，每个web.xml文件的根元素为<web-app>中，必须标明这个web.xml使用的是哪个模式文件。如：
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
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">
</web-app>

web.xml的模式文件中定义的标签并不是定死的，模式文件也是可以改变的，一般来说，随着web.mxl模式文件的版本升级，里面定义的功能会越来越复杂，标签元素的种类肯定也会越来越多，但有些不是很常用的，我们只需记住一些常用的并知道怎么配置就可以了。

------------------------------------------------------------------------------------------------------------

下面列出web.xml我们常用的一些标签元素及其功能：

1、指定欢迎页面，例如： <welcome-file-list>

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

</welcome-file-list>

PS：指定了2个欢迎页面，显示时按顺序从第一个找起，如果第一个存在，就显示第一个，后面的不起作用。如果第一个不存在，就找第二个，以此类推。

关于欢迎页面：

访问一个网站时，默认看到的第一个页面就叫欢迎页，一般情况下是由首页来充当欢迎页的。一般情况下，我们会在web.xml中指定欢迎页。但 web.xml并不是一个Web的必要文件，没有web.xml，网站仍然是可以正常工作的。只不过网站的功能复杂起来后，web.xml的确有非常大用处，所以，默认创建的动态web工程在WEB-INF文件夹下面都有一个web.xml文件。

------------------------------------------------------------------------------------------------------------

2、命名与定制URL。

我们可以为Servlet和JSP文件命名并定制URL,其中定制URL是依赖命名的，命名必须在定制URL前。

下面拿Servlet来举例：

<servlet>
<servlet-name>servlet1</servlet-name>
<servlet-class>org.whatisjava.TestServlet</servlet-class>

</servlet>

<servlet-mapping>
<servlet-name>servlet1</servlet-name>
<url-pattern>*.do</url-pattern>

</servlet-mapping>

---------------------------------------------------------------------------------------------

元素说明：

1. <servlet></servlet> 用来声明一个servlet的数据，主要有以下子元素：

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

1.2 <servlet-class></servlet-class> 指定servlet的类名称

2. <jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径

3.<init-param></init-param> 用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数

4. <load-on-startup></load-on-startup>指定当Web应用启动时，装载Servlet的次序。
当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet.

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

5.<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素

5.1 <servlet-name></servlet-name> 指定servlet的名称
5.2 <url-pattern></url-pattern> 指定servlet所对应的URL

------------------------------------------------------------------------------------------------------------

3、定制初始化参数

可以定制servlet、JSP、Context的初始化参数，然后可以再servlet、JSP、Context中获取这些参数值。

下面用servlet来举例：
<servlet>
    <servlet-name>servlet1</servlet-name>
    <servlet-class>org.whatisjava.TestServlet</servlet-class>
    <init-param>
          <param-name>userName</param-name>
          <param-value>Daniel</param-value>
    </init-param>
    <init-param>
          <param-name>E-mail</param-name>
          <param-value>125485762@qq.com</param-value>
    </init-param>
</servlet>

经过上面的配置，在servlet中能够调用getServletConfig().getInitParameter("param1")获得参数名对应的值。

------------------------------------------------------------------------------------------------------------

4、指定错误处理页面

可以通过“异常类型”或“错误码”来指定错误处理页面。

<error-page>
    <error-code>404</error-code>
    <location>/error404.jsp</location>
</error-page>
-----------------------------
<error-page>
    <exception-type>java.lang.Exception<exception-type>
    <location>/exception.jsp<location>

</error-page>

------------------------------------------------------------------------------------------------------------

5、设置过滤器

比如设置一个编码过滤器，过滤所有资源

<filter>
<filter-name>XXXCharaSetFilter</filter-name> （自行定义）
<filter-class> net.test.CharSetFilter </filter-class>

</filter>

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

------------------------------------------------------------------------------------------------------------

6、设置监听器：
<listener>
<listener-class>net.test.XXXLisenet</listener-class>
</listener>

------------------------------------------------------------------------------------------------------------

7、设置会话(Session)过期时间。

其中时间以分钟为单位，假如设置60分钟超时：

<session-config>
<session-timeout>60</session-timeout>
</session-config>

除了这些标签元素之外，还可以往web.xml中添加很多标签元素，由于不常用省略。

------------------------------------------------------------------------------------------------------------

8. 配置spring框架

当我们使用spring框架的时候，需要在web.xml中添加spring的加载配置文件，使得正常创建ApplicationContext 实例.

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>

/WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml
</param-value>
</context-param>

具体细节请参考：https://blog.****.net/qq_36098284/article/details/80690639

------------------------------------------------------------------------------------------------------------

9.配置springMVC框架

------------------------------------------------------------------------------------------------------------

如果是用myeclipse编辑web.xml，在设计模式下能看到web.xml中都可以编辑哪些元素，很方便，如下图。

web.xml文件配置详解