关于deployment descripter（web.xml）的认识

Posted 2021-02-13 hamac

 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>

其它的元素都放在<web-app></web-app>之中。

<discription></discription> 是对站台的描述 <display-name></display-name> 定义站台的名称 <distributable/> 是指定该站台是否可分布式处理

<context-param></context-param> 用来设定web站台的环境参数，它包含两个子元素：     <param-name></param-name> 用来指定参数的名称     <param-value></param-value> 用来设定参数值。比如：

1 <context-param>
2      <param-name>my_param</param-name>
3      <param-value>hello</param-value>
4  </context-param>

在此设定的参数，可以在servlet中用 getServletContext().getInitParameter("my_param") 来取得

<filter></filter> 是用来声明filter的相关设定，它包含以下子元素：     

　　<filter-name></filter-name> 这当然就是指定filter的名字     

　　<filter-class></filter-class> 这是用来定义filter的类的名称  

   

<init-param></init-param> 用来定义参数，它有两个子元素：        

　　<param-name></param-name> 用来指定参数的名称        

　　<param-value></param-value> 用来设定参数值。

比如：

1 <filter>
2          <filter-name>setCharacterEncoding</filter-name>
3          <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
4          <init-param>
5              <param-name>encoding</param-name>
6              <param-value>GB2312</param-value>
7          </init-param>
8  </filter>

与<filter></filter>同时使用的是<filter-mapping></filter-mapping> 用来定义filter所对应的URL，它有两个子元素：     

　　<filter-name></filter-name> 指定filter的名字     

　　<url-pattern></url-pattern> 指定filter所对应的URL。

比如：

1 <filter-mapping>
2          <filter-name>setCharacterEncoding</filter-name>
3          <url-pattern>/*</url-pattern>
4  </filter-mapping>

<listener></listener> 用来设定Listener接口，它的主要子元素为     

　　<listener-class></listener-class> 定义Listener的类名称

比如：

1 <listener>
2      <listener-class>com.myTest.ContextListener</listener-class> 
3  </listener>

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

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

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

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

　　<init-param></init-param> 用来定义参数，和前面的<init-param>差不多

同样，与<servlet></servlet>一起使用的是<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素：     

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

　　<url-pattern></url-pattern> 指定servlet所对应的URL

比如：

1 <servlet>
2          <servlet-name>ShoppingServlet</servlet-name>
3          <servlet-class>com.myTest.ShoppingServlet</servlet-class>
4  </servlet>
5      
6  <servlet-mapping>
7          <servlet-name>ShoppingServlet</servlet-name>
8          <url-pattern>/shop/ShoppingServlet</url-pattern>
9  </servlet-mapping>

<session-config></session-config> 用来定义web站台中的session参数，包含一个子元素：     

　　<session-timeout></session-timeout> 用来定义这个web站台所有session的有效期限，单位为分钟

<mime-mapping></mime-mapping> 定义某一个扩展名和某一个MIME Type做对映，包含两个子元素：     

　　<extension></extension> 扩展名的名称     

　　<mime-type></mime-type> MIME格式

比如：

1 <mime-mapping>
2      <extension>doc</extension>
3      <mime-type>application/vnd.ms-word</mime-type>
4  </mime-mapping> 
5  <mime-mapping>
6      <extension>xls</extension>
7      <mime-type>application/vnd.ms-excel</mime-type>
8  </mime-mapping>

<welcome-file-list></welcom-file-list> 用来定义首页的列单，包含一个子元素：     

　　<welcome-file></welcome-file> 指定首页的文件名称

比如：

1 <welcome-file-list>
2      <welcome-file>index.jsp</welcome-file>
3      <welcome-file>index.html</welcome-file>
4  </welcom-file-list>

<error-page></error-page> 用来处理错误代码或异常的页面，有三个子元素：     

　　<error-code></error-code> 指定错误代码     

　　<exception-type></exception-type> 指定一个JAVA异常类型     

　　<location></location> 指定在web站台内的相关资源路径

比如：

1 <error-page>
2      <error-code>404</error-code>
3      <location>/error404.jsp</location>
4  </error-page>
5  <error-page>
6      <exception-type>java.lang.Exception</exception-type>
7      <location>/exception.jsp</location>
8  </error-page>

<taglib></taglib> 用来设定JSP网页所用到的Tag Library路径，有两个子元素：     

　　<taglib-uri></taglib-uri> 定义TLD文件的URI，在JSP网页中用taglib指令便可取得该URI的TLD文件     

　　<taglib-location></taglib-location> 指定TLD文件相对于web站台的存放位置

比如：

1 <taglib>
2        <taglib-uri>myTaglib</taglib-uri>
3        <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
4  </taglib>

<resource-ref></resource-ref> 定义利用JNDI取得站台可利用的资源，有五个子元素：    

　　<description></description> 资源说明     

　　<rec-ref-name></rec-ref-name> 资源名称     

　　<res-type></res-type> 资源种类     

　　<res-auth></res-auth> 资源经由Application或Container来许可     

　　<res-sharing-scope></res-sharing-scope> 资源是否可以共享，有Shareable和Unshareable两个值，默认为Shareable

比如，配置数据库连接池就可在此配置：

1 <resource-ref>
2          <description>JNDI JDBC DataSource of shop</description>
3          <res-ref-name>jdbc/sample_db</res-ref-name>
4          <res-type>javax.sql.DataSource</res-type>
5          <res-auth>Container</res-auth>
6  </resource-ref>

<jsp-config> 包括<taglib> 和<jsp-property-group> 两个子元素。

其中<taglib>元素在JSP 1.2时就已经存在；而<jsp-property-group>是JSP 2.0 新增的元素。     

<jsp-property-group>元素主要有八个子元素，它们分别为：          

1.<description>：设定的说明；     

2.<display-name>：设定名称；     

3.<url-pattern>：设定值所影响的范围，如：/CH2 或 /*.jsp；     

4.<el-ignored>：若为true，表示不支持EL 语法；     

5.<scripting-invalid>：若为true，表示不支持<% scripting %>语法；     

6.<page-encoding>：设定JSP 网页的编码；     

7.<include-prelude>：设置JSP 网页的抬头，扩展名为.jspf；     

8.<include-coda>：设置JSP 网页的结尾，扩展名为.jspf。

一个简单的<jsp-config>元素完整配置：

 1 <jsp-config>
 2      <taglib>
 3          <taglib-uri>Taglib</taglib-uri>
 4          <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
 5      </taglib>
 6      <jsp-property-group>
 7          <description>Special property group for JSP Configuration JSP example.</description>
 8          <display-name>JSPConfiguration</display-name>
 9          <url-pattern>/jsp/* </url-pattern>
10          <el-ignored>true</el-ignored>
11          <page-encoding>GB2312</page-encoding>
12          <scripting-invalid>true</scripting-invalid>
13          <include-prelude>/include/prelude.jspf</include-prelude>
14          <include-coda>/include/coda.jspf</include-coda>
15      </jsp-property-group>
16  </jsp-config>  

配置web.xml来限制对某些servlet的请求

有时我们只希望通过认证的用户才能请求某些servlet的话，就可以在web.xml中来进行相应的配置，来达到此目的。

这就要用到<security-constraint></security-constraint>元素。 对于tomcat，中web.xml使用security-constraint元素需要在位于<Tomcat-installation-directory>/conf/tomcat-users.xml的XML文件中创建用户名和密码。比如下面的这个tomcat-users.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>HelloServlet</web-resource-name>
 4            <url-pattern>/HelloServlet</url-pattern>
 5            <http-method>GET</http-method>
 6            <http-method>POST</http-method>
 7        </web-resource-collection>
 8        <auth-constraint>
 9            <description>This applies only to the "tomcat" security role</description>
10            <role-name>admin</role-name>
11        </auth-constraint>
12        <user-data-constraint>
13            <transport-guarantee>NONE</transport-guarantee>
14        </user-data-constraint>
15    </security-constraint>
16    
17    <login-config>
18        <auth-method>BASIC</auth-method>
19    </login-config>
20    <security-role>
21        <role-name>admin</role-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资源。

 

部分转自：https://www.cnblogs.com/morlin/p/4301063.html（web.xml配置介绍）