1、启动一个WEB项目的时候,WEB容器会去读取它的配置文件web.xml,读取
2、紧急着,容创建一个ServletContext(servlet上下文),这个web项目的所有部分都将共享这个上下文。
3、容器将
4、容器创建
二 Load-on-startup
Load-on-startup 元素在web应用启动的时候指定了servlet被加载的顺序,它的值必须是一个整数。如果它的值是一个负整数或是这个元素不存在,那么容器会在该servlet被调用的时候,加载这个servlet 。如果值是正整数或零,容器在配置的时候就加载并初始化这个servlet,容器必须保证值小的先被加载。如果值相等,容器可以自动选择先加载谁。
在servlet的配置当中,
标记容器是否在启动的时候就加载这个servlet。
当值为0或者大于0时,表示容器在应用启动时就加载这个servlet;
当是一个负数时或者没有指定时,则指示容器在该servlet被选择时才加载。
正数的值越小,启动该servlet的优先级越高。
三 加载顺序
首先可以肯定的是,加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是:ServletContext -> 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 的加载顺序是:ServletContext -> context-param -> listener -> filter -> servlet ,而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。
四 web.xml文件详解
我将自己知道的web.xml的元素整理了一下:
web.xml首先是肯定要包含它的schema.
1 <web-app xmlns="http://java.sun.com/xml/ns/j2ee" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" 4 version="2.4"> 5 6 web-app>
其它的元素都放在
1 <context-param> 2 <param-name>my_paramparam-name> 3 <param-value>helloparam-value> 4 context-param>
在此设定的参数,可以在servlet中用 getServletContext().getInitParameter("my_param") 来取得
比如:
1 <filter> 2 <filter-name>setCharacterEncodingfilter-name> 3 <filter-class>com.myTest.setCharacterEncodingFilterfilter-class> 4 <init-param> 5 <param-name>encodingparam-name> 6 <param-value>GB2312param-value> 7 init-param> 8 filter>
与
比如:
1 <filter-mapping> 2 <filter-name>setCharacterEncodingfilter-name> 3 <url-pattern>/*url-pattern> 4 filter-mapping>
比如:
1 <listener> 2 <listener-class>com.myTest.ContextListenerlistener-class> 3 listener>
同样,与
比如:
1 <servlet> 2 <servlet-name>ShoppingServletservlet-name> 3 <servlet-class>com.myTest.ShoppingServletservlet-class> 4 servlet> 5 6 <servlet-mapping> 7 <servlet-name>ShoppingServletservlet-name> 8 <url-pattern>/shop/ShoppingServleturl-pattern> 9 servlet-mapping>
比如:
1 <mime-mapping> 2 <extension>docextension> 3 <mime-type>application/vnd.ms-wordmime-type> 4 mime-mapping> 5 <mime-mapping> 6 <extension>xlsextension> 7 <mime-type>application/vnd.ms-excelmime-type> 8 mime-mapping>
比如:
1 <welcome-file-list> 2 <welcome-file>index.jspwelcome-file> 3 <welcome-file>index.htmlwelcome-file> 4 welcom-file-list>
比如:
1 <error-page> 2 <error-code>404error-code> 3 <location>/error404.jsplocation> 4 error-page> 5 <error-page> 6 <exception-type>java.lang.Exceptionexception-type> 7 <location>/exception.jsplocation> 8 error-page>
比如:
1 <taglib> 2 <taglib-uri>myTaglibtaglib-uri> 3 <taglib-location>/WEB-INF/tlds/MyTaglib.tldtaglib-location> 4 taglib>
比如,配置数据库连接池就可在此配置:
1 <resource-ref> 2 <description>JNDI JDBC DataSource of shopdescription> 3 <res-ref-name>jdbc/sample_dbres-ref-name> 4 <res-type>javax.sql.DataSourceres-type> 5 <res-auth>Containerres-auth> 6 resource-ref>
其中
1.
2.
3.
4.
5.
6.
7.
8.
一个简单的
1 <jsp-config> 2 <taglib> 3 <taglib-uri>Taglibtaglib-uri> 4 <taglib-location>/WEB-INF/tlds/MyTaglib.tldtaglib-location> 5 taglib> 6 <jsp-property-group> 7 <description>Special property group for JSP Configuration JSP example.description> 8 <display-name>JSPConfigurationdisplay-name> 9 <url-pattern>/jsp/* url-pattern> 10 <el-ignored>trueel-ignored> 11 <page-encoding>GB2312page-encoding> 12 <scripting-invalid>truescripting-invalid> 13 <include-prelude>/include/prelude.jspfinclude-prelude> 14 <include-coda>/include/coda.jspfinclude-coda> 15 jsp-property-group> 16 jsp-config>
配置web.xml来限制对某些servlet的请求
有时我们只希望通过认证的用户才能请求某些servlet的话,就可以在web.xml中来进行相应的配置,来达到此目的。
这就要用到
1 xml version='1.0' encoding='utf-8'?> 2 <tomcat-users> 3 <role rolename="tomcat"/> 4 <role rolename="manager"/> 5 <role rolename="admin"/> 6 <user username="tomcat" password="tomcat" roles="tomcat"/> 7 <user username="both" password="tomcat" roles="tomcat,manager"/> 8 <user username="admin" password="admin" roles="admin"/> 9 tomcat-users>
此XML片段包括一个tomcat-users根元素,它包含一个或多个role和user元素。
然后在Web应用程序的web.xml中创建security-constraint、login-config和security-role元素。
1 <security-constraint> 2 <web-resource-collection> 3 <web-resource-name>HelloServletweb-resource-name> 4 <url-pattern>/HelloServleturl-pattern> 5 <http-method>GEThttp-method> 6 <http-method>POSThttp-method> 7 web-resource-collection> 8 <auth-constraint> 9 <description>This applies only to the "tomcat" security roledescription> 10 <role-name>adminrole-name> 11 auth-constraint> 12 <user-data-constraint> 13 <transport-guarantee>NONEtransport-guarantee> 14 user-data-constraint> 15 security-constraint> 16 17 <login-config> 18 <auth-method>BASICauth-method> 19 login-config> 20 <security-role> 21 <role-name>adminrole-name> 22 security-role>
其中security-constraint元素包含一个或多个web-resource-collection元素,它是描述Web应用程序中的哪些web资源受到指定安全限制的保护。http-method元素指定安全限制覆盖的HTTP方法。上面的例子中,当我们对/HelloServlet的GET或POST请求时将触发配置的安全机制。 auth-constraint元素用于描述允许访问Web组件的安全角色。此例中安全角色的例子有tomcat、manager、admin。而只有当作为admin角色的用户才可以访问HelloServlet。
Web应用程序通过login-config元素来认证用户,并确认该用户是否为正确的角色。 longin-config包含的transport-guarantee子元素用来指定认证方法,BASIC是一种常见的Web认证方式,浏览器给用户提示一个对话框,要求输入用户名和密码,随后Tomcat将给出的用户名和密码与tomcat-users.xml中的用户名和密码进行比较,然后使用前面的security-constraint配置来确定用户是否可访问受保护的servlet。
(除BASIC外,还可以是FORM、CLIENT-CERT、DIGEST等)
其实这种认证方法实际上有两个步骤: 1、检查提供的用户名和密码是否正确。 2、判断用户是否映射到特定的安全角色。例如,用户可能提供了正确的用户名和密码,但没有映射到特定的安全角色,也将被禁止访问特定的Web资源。
五 相应元素配置
1、Web应用图标:指出IDE和GUI工具用来表示Web应用的大图标和小图标
1 <icon> 2 <small-icon>/images/app_small.gifsmall-icon> 3 <large-icon>/images/app_large.giflarge-icon> 4 icon>
2、Web 应用名称:提供GUI工具可能会用来标记这个特定的Web应用的一个名称
< display-name>Tomcat Example
3、Web 应用描述: 给出于此相关的说明性文本
< disciption>Tomcat Example servlets and JSP pages.
4、上下文参数:声明应用范围内的初始化参数。
1 <context-param> 2 <param-name>ContextParameterpara-name> 3 <param-value>testparam-value> 4 <description>It is a test parameter.description> 5 context-param>
在servlet里面可以通过getServletContext().getInitParameter("context/param")得到
5、过滤器配置:将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。
1 <filter> 2 <filter-name>setCharacterEncodingfilter-name> 3 <filter-class>com.myTest.setCharacterEncodingFilterfilter-class> 4 <init-param> 5 <param-name>encodingparam-name> 6 <param-value>GB2312param-value> 7 init-param> 8 filter> 9 <filter-mapping> 10 <filter-name>setCharacterEncodingfilter-name> 11 <url-pattern>/*url-pattern> 12 filter-mapping>
6、监听器配置
1 <listener> 2 <listerner-class>listener.SessionListenerlistener-class> 3 listener>
7、Servlet配置
基本配置
1 <servlet> 2 <servlet-name>snoopservlet-name> 3 <servlet-class>SnoopServletservlet-class> 4 servlet> 5 <servlet-mapping> 6 <servlet-name>snoopservlet-name> 7 <url-pattern>/snoopurl-pattern> 8 servlet-mapping>
高级配置
1 <servlet> 2 <servlet-name>snoopservlet-name> 3 <servlet-class>SnoopServletservlet-class> 4 <init-param> 5 <param-name>fooparam-name> 6 <param-value>barparam-value> 7 init-param> 8 <run-as> 9 <description>Security role for anonymous accessdescription> 10 <role-name>tomcatrole-name> 11 run-as> 12 servlet> 13 <servlet-mapping> 14 <servlet-name>snoopservlet-name> 15 <url-pattern>/snoopurl-pattern> 16 servlet-mapping>
元素说明
当值为正数或零时:Servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet.
当值为负或未定义:Servlet容器将在Web客户首次访问这个servlet时加载它
8、会话超时配置(单位为分钟)
1 <session-config> 2 <session-timeout>120session-timeout> 3 session-config>
9、MIME类型配置
1 <mime-mapping> 2 <extension>htmextension> 3 <mime-type>text/htmlmime-type> 4 mime-mapping>
10、指定欢迎文件页配置
1 <welcome-file-list> 2 <welcome-file>index.jspwelcome-file> 3 <welcome-file>index.htmlwelcome-file> 4 <welcome-file>index.htmwelcome-file> 5 welcome-file-list>
11、配置错误页面
一、 通过错误码来配置error-page
1 <error-page> 2 <error-code>404error-code> 3 <location>/NotFound.jsplocation> 4 error-page>
上面配置了当系统发生404错误时,跳转到错误处理页面NotFound.jsp。
二、通过异常的类型配置error-page
1 <error-page> 2 <exception-type>java.lang.NullExceptionexception-type> 3 <location>/error.jsplocation> 4 error-page>
上面配置了当系统发生java.lang.NullException(即空指针异常)时,跳转到错误处理页面error.jsp
12、TLD配置
1 <taglib> 2 <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri> 3 <taglib-location>/WEB-INF/jsp/debug-taglib.tldtaglib-location> 4 taglib>
如果MyEclipse一直在报错,应该把
1 <jsp-config> 2 <taglib> 3 <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri> 4 <taglib-location>/WEB-INF/pager-taglib.tldtaglib-location> 5 taglib> 6 jsp-config>
13、资源管理对象配置
1 <resource-env-ref> 2 <resource-env-ref-name>jms/StockQueueresource-env-ref-name> 3 resource-env-ref>
14、资源工厂配置
1 <resource-ref> 2 <res-ref-name>mail/Sessionres-ref-name> 3 <res-type>javax.mail.Sessionres-type> 4 <res-auth>Containerres-auth> 5 resource-ref>
配置数据库连接池就可在此配置:
1 <resource-ref> 2 <description>JNDI JDBC DataSource of shopdescription> 3 <res-ref-name>jdbc/sample_dbres-ref-name> 4 <res-type>javax.sql.DataSourceres-type> 5 <res-auth>Containerres-auth> 6 resource-ref>
15、安全限制配置
1 <security-constraint> 2 <display-name>Example Security Constraintdisplay-name> 3 <web-resource-collection> 4 <web-resource-name>Protected Areaweb-resource-name> 5 <url-pattern>/jsp/security/protected/*url-pattern> 6 <http-method>DELETEhttp-method> 7 <http-method>GEThttp-method> 8 <http-method>POSThttp-method> 9 <http-method>PUThttp-method> 10 web-resource-collection> 11 <auth-constraint> 12 <role-name>tomcatrole-name> 13 <role-name>role1role-name> 14 auth-constraint> 15 security-constraint>
16、登陆验证配置
1 <login-config> 2 <auth-method>FORMauth-method> 3 <realm-name>Example-Based Authentiation Arearealm-name> 4 <form-login-config> 5 <form-login-page>/jsp/security/protected/login.jspform-login-page> 6 <form-error-page>/jsp/security/protected/error.jspform-error-page> 7 form-login-config> 8 login-config>
17、安全角色:security-role元素给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。
1 <security-role> 2 <role-name>tomcatrole-name> 3 security-role>
18、Web环境参数:env-entry元素声明Web应用的环境项
1 <env-entry> 2 <env-entry-name>minExemptionsenv-entry-name> 3 <env-entry-value>1env-entry-value> 4 <env-entry-type>java.lang.Integerenv-entry-type> 5 env-entry>
19、EJB 声明
1 <ejb-ref> 2 <description>Example EJB referencedecription> 3 <ejb-ref-name>ejb/Accountejb-ref-name> 4 <ejb-ref-type>Entityejb-ref-type> 5 <home>com.mycompany.mypackage.AccountHomehome> 6 <remote>com.mycompany.mypackage.Accountremote> 7 ejb-ref>
20、本地EJB声明
1 <ejb-local-ref> 2 <description>Example Loacal EJB referencedecription> 3 <ejb-ref-name>ejb/ProcessOrderejb-ref-name> 4 <ejb-ref-type>Sessionejb-ref-type> 5 <local-home>com.mycompany.mypackage.ProcessOrderHomelocal-home> 6 <local>com.mycompany.mypackage.ProcessOrderlocal> 7 ejb-local-ref>
21、配置DWR
1 <servlet> 2 <servlet-name>dwr-invokerservlet-name> 3 <servlet-class>uk.ltd.getahead.dwr.DWRServletservlet-class> 4 servlet> 5 <servlet-mapping> 6 <servlet-name>dwr-invokerservlet-name> 7 <url-pattern>/dwr/*url-pattern> 8 servlet-mapping>
22、配置Struts
1 <display-name>Struts Blank Applicationdisplay-name> 2 <servlet> 3 <servlet-name>actionservlet-name> 4 <servlet-class> 5 org.apache.struts.action.ActionServlet 6 servlet-class> 7 <init-param> 8 <param-name>detailparam-name> 9 <param-value>2param-value> 10 init-param> 11 <init-param> 12 <param-name>debugparam-name> 13 <param-value>2param-value> 14 init-param> 15 <init-param> 16 <param-name>configparam-name> 17 <param-value>/WEB-INF/struts-config.xmlparam-value> 18 init-param> 19 <init-param> 20 <param-name>applicationparam-name> 21 <param-value>ApplicationResourcesparam-value> 22 init-param> 23 <load-on-startup>2load-on-startup> 24 servlet> 25 <servlet-mapping> 26 <servlet-name>actionservlet-name> 27 <url-pattern>*.dourl-pattern> 28 servlet-mapping> 29 <welcome-file-list> 30 <welcome-file>index.jspwelcome-file> 31 welcome-file-list> 32 33 34 <taglib> 35 <taglib-uri>struts-beantaglib-uri> 36 <taglib-location>/WEB-INF/tld/struts-bean.tldtaglib-location> 37 taglib> 38 <taglib> 39 <taglib-uri>struts-htmltaglib-uri> 40 <taglib-location>/WEB-INF/tld/struts-html.tldtaglib-location> 41 taglib> 42 <taglib> 43 <taglib-uri>struts-nestedtaglib-uri> 44 <taglib-location>/WEB-INF/tld/struts-nested.tldtaglib-location> 45 taglib> 46 <taglib> 47 <taglib-uri>struts-logictaglib-uri> 48 <taglib-location>/WEB-INF/tld/struts-logic.tldtaglib-location> 49 taglib> 50 <taglib> 51 <taglib-uri>struts-tilestaglib-uri> 52 <taglib-location>/WEB-INF/tld/struts-tiles.tldtaglib-location> 53 taglib>
23、配置Spring(基本上都是在Struts中配置的)
1 2 <context-param> 3 <param-name>contextConfigLocationparam-name> 4 <param-value> 5 6 /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml 7 param-value> 8 context-param> 9 10 11 12 <listener> 13 <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class> 14 listener> 15 16 <listener> 17 <listener-class> 18 org.springframework.web.context.request.RequestContextListener 19 listener-class> 20 listener>
其他说明:
web.xml 文件中一般包括 servlet, spring, filter, listenr的配置。那么他们是按照一个什么顺序加载呢?加载顺序会影响对spring bean 的调用。
比如filter 需要用到 bean ,但是加载顺序是 先加载filter 后加载spring,则filter中初始化操作中的bean为null;
首先可以肯定 加载顺序与他们在web.xml 文件中的先后顺序无关。
web.xml 中 listener 和 serverlet 的加载顺序为 先 listener 后serverlet
最终得出结果:先 listener >> filter >> servlet >> spring
所以,如果过滤器中要使用到 bean,可以将spring 的加载 改成 Listener的方式
1 <listener> 2 <listener-class> 3 org.springframework.web.context.ContextLoaderListener 4 listener-class> 5 listener>
关于他们的内部执行顺序,也需要注意,如下面文章中遇到的问题
web.xml的filter执行顺序导致的乱码,切记!
发现引起bug的原因是web.xml的下面几行:
1 <filter-mapping> 2 <filter-name>SecurityFilterfilter-name> 3 <url-pattern>*.dourl-pattern> 4 filter-mapping> 5 6 <filter-mapping> 7 <filter-name>CharacterEncodingfilter-name> 8 <url-pattern>*.dourl-pattern> 9 filter-mapping> 10 11 <filter-mapping> 12 <filter-name>CharacterEncodingfilter-name> 13 <url-pattern>*.jspurl-pattern> 14 filter-mapping>
根据servlet2.3规范filter执行是按照web.xml配置的filter-mapping先后顺序进行执行,所以上面的配置会导致遇见*.do的url请求,先进行SecurityFilter的过滤器处理,这时候没有做编码处理,已经是乱码,到下面的filter处理时已经时乱码,再做编码处理已经没有用处。
修正方式,调整filter-mapping顺序,如下:
1 <filter-mapping> 2 <filter-name>CharacterEncodingfilter-name> 3 <url-pattern>*.dourl-pattern> 4 filter-mapping> 5 6 <filter-mapping> 7 <filter-name>CharacterEncodingfilter-name> 8 <url-pattern>*.jspurl-pattern> 9 filter-mapping> 10 11 <filter-mapping> 12 <filter-name>SecurityFilterfilter-name> 13 <url-pattern>*.dourl-pattern> 14 filter-mapping>