web工程中的web.xml文件有什么作用呢?它是每个web.xml工程都必须的吗?
一个web中完全可以没有web.xml文件,也就是说,web.xml文件并不是web工程必须的。
那什么时候需要,什么时候可以不需要呢?
要想回答上面的问题,得先了解web.xml文件使用来干什么的。web.xml文件是用来配置:欢迎页、servlet、filter等的。当你的web工程没用到这些时,你可以不用web.xml文件来配置你的web工程。
那么web.xml能做的所有事情都有那些?
其实,web.xml的模式(Schema)文件中定义了多少种标签元素,web.xml中就可以出现它的模式文件所定义的标签元素,它就能拥有定义出来的那些功能。web.xml的模式文件是由Sun公司定义的,每个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>index.jspwelcome-file> <welcome-file>index1.jspwelcome-file> welcome-file-list>
上面的例子指定了2个欢迎页面,显示时按顺序从第一个找起,如果第一个存在,就显示第一个,后面的不起作用。如果第一个不存在,就找第二个,以此类推。
关于欢迎页面:
访问一个网站时,默认看到的第一个页面就叫欢迎页,一般情况下是由首页来充当欢迎页的。一般情况下,我们会在web.xml中指定欢迎页。但web.xml并不是一个Web的必要文件,没有web.xml,网站仍然是可以正常工作的。只不过网站的功能复杂起来后,web.xml的确有非常大用处,所以,默认创建的动态web工程在WEB-INF文件夹下面都有一个web.xml文件。
对于tomcat来说,当你只指定一个web的根名,没有指定具体页面,去访问时一个web时,如果web.xml文件中配置了欢迎页,那么就返回指定的那个页面作为欢迎页,而在文中没有web.xml文件,或虽然有web.xml,但web.xml也没指定欢迎页的情况下,它默认先查找index.html文件,如果找到了,就把index.html作为欢迎页还回给浏览器。如果没找到index.html,tomcat就去找index.jsp。找到index.jsp就把它作为欢迎页面返回。而如果index.html和index.jsp都没找到,又没有用web.xml文件指定欢迎页面,那此时tomcat就不知道该返回哪个文件了,它就显示The requested resource (/XXX) is not available的页面。其中XXX表示web的根名。但如果你指定了具体页面,是可以正常访问的。
2、命名与定制URL
我们可以为Servlet和JSP文件命名并定制URL,其中定制URL是依赖一命名的,命名必须在定制URL前。下面拿serlet来举例:
(1)为Servlet命名:
<servlet> <servlet-name>servlet1servlet-name> <servlet-class>net.test.TestServletservlet-class> servlet>
(2)为Servlet定制URL:
<servlet-mapping> <servlet-name>servlet1servlet-name> <url-pattern>*.dourl-pattern> servlet-mapping>
3、定制初始化参数:
可以定制servlet、JSP、Context的初始化参数,然后可以再servlet、JSP、Context中获取这些参数值。下面哪servlet来举例:
<servlet> <servlet-name>servlet1servlet-name> <servlet-class>net.test.TestServletservlet-class> <init-param> <param-name>userNameparam-name> <param-value>Tommyparam-value> init-param> <init-param> <param-name>E-mailparam-name> <param-value>[email protected]param-value> init-param> servlet>
经过上面的配置,在servlet中能够调用getServletConfig().getInitParameter("param1")获得参数名对应的值。
4、指定错误处理页面,可以通过“异常类型”或“错误码”来指定错误处理页面。
<error-page> <error-code>404error-code> <location>/error404.jsplocation> error-page>
<error-page> <exception-type>java.lang.Exception<exception-type> <location>/exception.jsp<location> error-page>
5、设置过滤器:比如设置一个编码过滤器,过滤所有资源
<filter> <filter-name>XXXCharaSetFilterfilter-name> <filter-class>net.test.CharSetFilterfilter-class> filter> <filter-mapping> <filter-name>XXXCharaSetFilterfilter-name> <url-pattern>/*url-pattern> filter-mapping>
6、设置监听器:
<listener> <listener-class>net.test.XXXLisenetlistener-class> listener>
7、设置会话(Session)过期时间,其中时间以分钟为单位,假如设置60分钟超时:
<session-config> <session-timeout>60session-timeout> session-config>
除了这些标签元素之外,还可以往web.xml中添加那些标签元素呢,那些标签元素都能起什么作用呢?我们只要去查看web.xml的模式文件就能知道。直接看模式文件看不懂,可以找一些中文教程来看看。
web.xml加载顺序
一、
1、启动一个WEB项目的时候,WEB容器会去读取它的配置文件web.xml,读取
2、紧急着,容创建一个ServletContext(servlet上下文),这个web项目的所有部分都将共享这个上下文。
3、容器将
4、容器创建
二、
load-on-startup 元素在web应用启动的时候指定了servlet被加载的顺序,它的值必须是一个整数。如果它的值是一个负整数或是这个元素不存在,那么容器会在该servlet被调用的时候,加载这个servlet 。如果值是正整数或零,容器在配置的时候就加载并初始化这个servlet,容器必须保证值小的先被加载。如果值相等,容器可以自动选择先加载谁。
在servlet的配置当中,
标记容器是否在启动的时候就加载这个servlet。
当值为0或者大于0时,表示容器在应用启动时就加载这个servlet;
当是一个负数时或者没有指定时,则指示容器在该servlet被选择时才加载。
正数的值越小,启动该servlet的优先级越高。
三、
在项目中总会遇到一些关于加载的优先级问题,近期也同样遇到过类似的,所以自己查找资料总结了下,下面有些是转载其他人的,毕竟人家写的不错,自己也就不重复造轮子了,只是略加点了自己的修饰。
首先可以肯定的是,加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是:listener ->filter -> servlet 同时还存在着这样一种配置节:context-param,它用于向 ServletContext 提供键值对,即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息,那么 context-param 配置节是不是应该写在 listener 配置节前呢?实际上context-param 配置节可写在任意位置,因此真正的加载顺序为:context-param ->listener -> filter -> servlet
对于某类配置节而言,与它们出现的顺序是有关的。以 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 类似,此处不再赘述。
由此,可以看出,web.xml 的加载顺序是:context-param -> listener -> filter-> servlet ,而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。
web.xml文件详解
web.xml常用元素
<web-app> <display-name>display-name> <description>description> <context-param>context-param> <filter>filter> <filter-mapping>filter-mapping> <listener>listener> <servlet>servlet> <servlet-mapping>servlet-mapping> <session-config>session-config> <mime-mapping>mime-mapping> <welcome-file-list>welcome-file-list> <error-page>error-page> <taglib>taglib> <resource-env-ref>resource-env-ref> <resource-ref>resource-ref> <security-constraint>security-constraint> <login-config>login-config> <security-role>security-role> <env-entry>env-entry> <ejb-ref>ejb-ref> < ejb-local-ref> ejb-local-ref> web-app>
相应元素配置
1、Web应用图标:指出IDE和GUI工具用来表示Web应用的大图标和小图标
<icon> <small-icon>/images/app_small.gifsmall-icon> <large-icon>/images/app_large.giflarge-icon> icon>
2、Web 应用名称:提供GUI工具可能会用来标记这个特定的Web应用的一个名称
<display-name>Tomcat Exampledisplay-name>
3、Web 应用描述:给出于此相关的说明性文本
<disciption>Tomcat Example servlets and JSP pages.disciption>
4、上下文参数:声明应用范围内的初始化参数。
<context-param> <param-name>ContextParameterpara-name> <param-value>testparam-value> <description>It is a test parameter.description> context-param>
在servlet里面可以通过getServletContext().getInitParameter("context/param")得到
5、过滤器配置:将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。
<filter> <filter-name>setCharacterEncodingfilter-name> <filter-class>com.myTest.setCharacterEncodingFilterfilter-class> <init-param> <param-name>encodingparam-name> <param-value>GB2312param-value> init-param> filter> <filter-mapping> <filter-name>setCharacterEncodingfilter-name> <url-pattern>/*url-pattern> filter-mapping>
6、监听器配置
<listener> <listerner-class>listener.SessionListenerlistener-class> listener>
7、Servlet配置
基本配置
<servlet> <servlet-name>snoopservlet-name> <servlet-class>SnoopServletservlet-class> servlet> <servlet-mapping> <servlet-name>snoopservlet-name> <url-pattern>/snoopurl-pattern> servlet-mapping>
高级配置
<servlet> <servlet-name>snoopservlet-name> <servlet-class>SnoopServletservlet-class> <init-param> <param-name>fooparam-name> <param-value>barparam-value> init-param> <run-as> <description>Security role for anonymous accessdescription> <role-name>tomcatrole-name> run-as> servlet> <servlet-mapping> <servlet-name>snoopservlet-name> <url-pattern>/snoopurl-pattern> servlet-mapping>
元素说明
<servlet> <servlet-name>servlet-name> <url-pattern>url-pattern> <servlet-mapping>servlet-mapping> <servlet-class>servlet-class> <jsp-file>jsp-file> <init-param>init-param> <load-on-startup> load-on-startup> servlet>
8、会话超时配置(单位为分钟)
<session-config> <session-timeout>120session-timeout> session-config>
9、MIME类型配置
<mime-mapping> <extension>htmextension> <mime-type>text/htmlmime-type> mime-mapping>
10、指定欢迎文件页配置(启动页配置)
<welcome-file-list> <welcome-file>index.jspwelcome-file> <welcome-file>index.htmlwelcome-file> <welcome-file>index.htmwelcome-file> welcome-file-list>
11、配置错误页面
一、通过错误码来配置error-page
<error-page> <error-code>404error-code> <location>/NotFound.jsplocation> error-page>
上面配置了当系统发生404错误时,跳转到错误处理页面NotFound.jsp。
二、通过异常的类型配置error-page
<error-page> <exception-type>java.lang.NullExceptionexception-type> <location>/error.jsplocation> error-page>
上面配置了当系统发生java.lang.NullException(即空指针异常)时,跳转到错误处理页面error.jsp
12、TLD配置
<taglib> <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri> <taglib-location>/WEB-INF/jsp/debug-taglib.tldtaglib-location> taglib>
如果MyEclipse一直在报错,应该把
<jsp-config> <taglib> <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri> <taglib-location>/WEB-INF/pager-taglib.tldtaglib-location> taglib> jsp-config>
13、资源管理对象配置
<resource-env-ref> <resource-env-ref-name>jms/StockQueueresource-env-ref-name> resource-env-ref>
14、资源工厂配置
<resource-ref> <res-ref-name>mail/Sessionres-ref-name> <res-type>javax.mail.Sessionres-type> <res-auth>Containerres-auth> resource-ref>
配置数据库连接池就可在此配置:
<resource-ref> <description>JNDI JDBC DataSource of shopdescription> <res-ref-name>jdbc/sample_dbres-ref-name> <res-type>javax.sql.DataSourceres-type> <res-auth>Containerres-auth> resource-ref>
15、安全限制配置
<security-constraint> <display-name>Example Security Constraintdisplay-name> <web-resource-collection> <web-resource-name>Protected Areaweb-resource-name> <url-pattern>/jsp/security/protected/*url-pattern> <http-method>DELETEhttp-method> <http-method>GEThttp-method> <http-method>POSThttp-method> <http-method>PUThttp-method> web-resource-collection> <auth-constraint> <role-name>tomcatrole-name> <role-name>role1role-name> auth-constraint> security-constraint>
16、登陆验证配置
<login-config> <auth-method>FORMauth-method> <realm-name>Example-Based Authentiation Arearealm-name> <form-login-config> <form-login-page>/jsp/security/protected/login.jspform-login-page> <form-error-page>/jsp/security/protected/error.jspform-error-page> form-login-config> login-config>
17、安全角色:
security-role元素给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。
<security-role> <role-name>tomcatrole-name> security-role>
18、Web环境参数:
env-entry元素声明Web应用的环境项
<env-entry> <env-entry-name>minExemptionsenv-entry-name> <env-entry-value>1env-entry-value> <env-entry-type>java.lang.Integerenv-entry-type> env-entry>
19、EJB 声明
<ejb-ref> <description>Example EJB referencedecription> <ejb-ref-name>ejb/Accountejb-ref-name> <ejb-ref-type>Entityejb-ref-type> <home>com.mycompany.mypackage.AccountHomehome> <remote>com.mycompany.mypackage.Accountremote> ejb-ref>
20、本地EJB声明
<ejb-local-ref> <description>Example Loacal EJB referencedecription> <ejb-ref-name>ejb/ProcessOrderejb-ref-name> <ejb-ref-type>Sessionejb-ref-type> <local-home>com.mycompany.mypackage.ProcessOrderHomelocal-ho me> <local>com.mycompany.mypackage.ProcessOrderlocal> ejb-local-ref>
21、配置DWR
<servlet> <servlet-name>dwr-invokerservlet-name> <servlet-class>uk.ltd.getahead.dwr.DWRServletservlet-class> servlet> <servlet-mapping> <servlet-name>dwr-invokerservlet-name> <url-pattern>/dwr/*url-pattern> servlet-mapping>
22、配置Struts
<display-name>Struts Blank Applicationdisplay-name> <servlet> <servlet-name>actionservlet-name> <servlet-class>org.apache.struts.action.ActionServletservlet-class> <init-param> <param-name>detailparam-name> <param-value>2param-value> init-param> <init-param> <param-name>debugparam-name> <param-value>2param-value> init-param> <init-param> <param-name>configparam-name> <param-value>/WEB-INF/struts-config.xmlparam-value> init-param> <init-param> <param-name>applicationparam-name> <param-value>ApplicationResourcesparam-value> init-param> <load-on-startup>2load-on-startup> servlet> <servlet-mapping> <servlet-name>actionservlet-name> <url-pattern>*.dourl-pattern> servlet-mapping> <welcome-file-list> <welcome-file>index.jspwelcome-file> welcome-file-list> <taglib> <taglib-uri>struts-beantaglib-uri> <taglib-location>/WEB-INF/tld/struts-bean.tldtaglib-location> taglib> <taglib> <taglib-uri>struts-htmltaglib-uri> <taglib-location>/WEB-INF/tld/struts-html.tldtaglib-location> taglib> <taglib> <taglib-uri>struts-nestedtaglib-uri> <taglib-location>/WEB-INF/tld/struts-nested.tldtaglib-location> taglib> <taglib> <taglib-uri>struts-logictaglib-uri> <taglib-location>/WEB-INF/tld/struts-logic.tldtaglib-location> taglib> <taglib> <taglib-uri>struts-tilestaglib-uri> <taglib-location>/WEB-INF/tld/struts-tiles.tldtaglib-location> taglib>
23、配置Spring
<listener> <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class> listener> <context-param> <param-name>contextConfigLocationparam-name> <param-value>classpath:spring/applicationContext.xmlparam-value> context-param> <filter> <filter-name>encodingFilterfilter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class> <init-param> <param-name>encodingparam-name> <param-value>UTF-8param-value> init-param> <init-param> <param-name>forceEncodingparam-name> <param-value>trueparam-value> init-param> filter> <filter-mapping> <filter-name>encodingFilterfilter-name> <url-pattern>/*url-pattern> filter-mapping>
24、Spring MVC Servlet配置
<servlet> <servlet-name>springservlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class> <init-param> <param-name>contextConfigLocationparam-name> <param-value>classpath:spring/springmvc.xmlparam-value> init-param> <load-on-startup>1load-on-startup> servlet> <servlet-mapping> <servlet-name>springservlet-name> <url-pattern>*.actionurl-pattern> servlet-mapping>
25、Log4j日志配置
<context-param> <param-name>log4jConfigLocationparam-name> <param-value>classpath:log4j.propertiesparam-value> context-param> <context-param> <param-name>webAppRootKeyparam-name> <param-value>SLSaleSystem.rootparam-value> context-param> <listener> <listener-class>org.springframework.web.util.Log4jConfigListenerlistener-class> listener>