Java的Web项目中Web.xml配置文件元素详解
16lz
2021-01-22
<?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">
<!--WEB应用的名字-->
<display-name>my-servlet</display-name>
<!--WEB应用的描述信息-->
<description>Tomcat Example servlets and JSP pages.</description>
<!--Web应用图标：指出IDE和GUI工具用来表示Web应用的大图标和小图标-->
<icon>
<small-icon>/images/app_small.gif</small-icon>
<large-icon>/images/app_large.gif</large-icon>
</icon>
<!--应用范围内的初始化参数-->
<context-param>
<param-name>version</param-name>
<param-value>1.0</param-value>
<description>version value</description>
</context-param>
<!--过滤器配置-->
<filter>
<filter-name>setCharacterEncoding</filter-name>
<filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>GB2312</param-value>
</init-param>
</filter>
<!--关联过滤器和servlet/JSP页面-->
<filter-mapping>
<filter-name>setCharacterEncoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!--监听器配置: servlet API的版本2.3增加了对事件监听程序的支持. 事件监听程序在建立、修改和删除会话或servlet环境时得到通知。 Listener元素指出事件监听程序类-->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!--Servlet配置-->
<servlet>
<servlet-name>servlet名称</servlet-name>
<servlet-class>servlet类全路径</servlet-class>
<init-param>
<param-name>参数名</param-name>
<param-value>参数值</param-value>
</init-param>
<run-as>
<description>Security role for anonymous access</description>
<role-name>tomcat</role-name>
</run-as>
<load-on-startup>指定当Web应用启动时，装载Servlet的次序</load-on-startup>
</servlet>
<!--服务器一般为servlet提供一个缺省的URL:http://host/webAppPrefix/servlet/ServletName。但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素-->
<servlet-mapping>
<servlet-name>servlet名称</servlet-name>
<url-pattern>映射路径</url-pattern>
</servlet-mapping>
<!--会话超时配置（单位为分钟）: 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值 -->
<session-config>
<session-timeout>120</session-timeout>
</session-config>
<!--MIME类型配置: 如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证-->
<mime-mapping>
<extension>htm</extension>
<mime-type>text/html</mime-type>
</mime-mapping>
<!--指定欢迎文件页配置: 指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件-->
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
</welcome-file-list>
<!--配置错误页面-->
<!--通过特定HTTP状态代码来配置: 当系统发生404错误时，跳转到错误处理页面NotFound.jsp-->
<error-page>
<error-code>404</error-code>
<location>/NotFound.jsp</location>
</error-page>
<!--通过指定异常的类型配置: 当系统发生指定异常时，跳转到错误处理页面error.jsp-->
<error-page>
<exception-type>java.lang.NullException</exception-type>
<location>/error.jsp</location>
</error-page>
<!--TLD配置: 对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面-->
<taglib>
<taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>
<taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location>
</taglib>
<!--如果开发工具一直在报错,应该把<taglib> 放到 <jsp-config>中-->
<!--资源管理对象配置: 声明与资源相关的一个管理对象-->
<resource-env-ref>
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
</resource-env-ref>
<!--资源工厂配置: 声明一个资源工厂使用的外部资源-->
<resource-ref>
<res-ref-name>mail/Session</res-ref-name>
<res-type>javax.mail.Session</res-type>
<res-auth>Container</res-auth>
</resource-ref>
<!--配置数据库连接池就可在此配置-->
<resource-ref>
<description>JNDI JDBC DataSource of shop</description>
<res-ref-name>jdbc/sample_db</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
</resource-ref>
<!--安全限制配置: 制定应该保护的URL。它与login-config元素联合使用-->
<security-constraint>
<display-name>Example Security Constraint</display-name>
<web-resource-collection>
<web-resource-name>Protected Area</web-resource-name>
<url-pattern>/jsp/security/protected/*</url-pattern>
<http-method>DELETE</http-method>
<http-method>GET</http-method>
<http-method>POST</http-method>
<http-method>PUT</http-method>
</web-resource-collection>
<auth-constraint>
<role-name>tomcat</role-name>
<role-name>role1</role-name>
</auth-constraint>
</security-constraint>
<!--登陆验证配置: 指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用-->
<login-config>
<auth-method>FORM</auth-method>
<realm-name>Example-Based Authentiation Area</realm-name>
<form-login-config>
<form-login-page>/jsp/security/protected/login.jsp</form-login-page>
<form-error-page>/jsp/security/protected/error.jsp</form-error-page>
</form-login-config>
</login-config>
<!--安全角色：给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易-->
<security-role>
<role-name>tomcat</role-name>
</security-role>
<!--Web应用环境参数-->
<env-entry>
<env-entry-name>minExemptions</env-entry-name>
<env-entry-value>1</env-entry-value>
<env-entry-type>java.lang.Integer</env-entry-type>
</env-entry>
<!--声明一个EJB的主目录的引用-->
<ejb-ref>
<description>Example EJB reference</description>
<ejb-ref-name>ejb/Account</ejb-ref-name>
<ejb-ref-type>Entity</ejb-ref-type>
<home>com.mycompany.mypackage.AccountHome</home>
<remote>com.mycompany.mypackage.Account</remote>
</ejb-ref>
<!--声明一个EJB的本地主目录的应用-->
<ejb-local-ref>
<description>Example Loacal EJB reference</description>
<ejb-ref-name>ejb/ProcessOrder</ejb-ref-name>
<ejb-ref-type>Session</ejb-ref-type>
<local-home>com.mycompany.mypackage.ProcessOrderHome</local-home>
<local>com.mycompany.mypackage.ProcessOrder</local>
</ejb-local-ref>
</web-app>