Deployment descriptor

其他 2019-03-15 15:14:45 阅读次数: 0

    部署描述符是JavaEE程序常见的一部分，但是之前都没有较为全面的学习过，这里就较为全面的记录一下部署描述符中的元素。部署一个Servlet 3 或以上应用程序是一件轻而易举的事。通过Servlet注解，对于不太复杂的应用程序，甚至可以部署没有描述符的Servlet/JSP应用程序。但是需要更加精细配置或是我们不能修改框架源码的情况，仍然需要部署描述符。首先，部署描述符必须命名为web.xml并位于WEB-INF目录下。Java类编译后class文件和配置文件都会放置在WEB-INF/classes目录下，而Java类库都放在WEB-INF/lib目录下，所有的应用程序资源打包成war为后缀的jar文件，这个war中包含WEB-INF(web.xml,  classes，lib)，页面资源。

在存在如下场景，部署描述符不能少：

  • 需要传递全局初始化参数给ServletContext
  • 有多个过滤器，并要设置调用顺序
  • 需要修改会话超时设置
  • 需要限制资源的访问，并配置用户身份验证方式

 web.xml配置详解

 java web项目启动加载顺序

（1）启动WEB项目的时候，容器(如:Tomcat)会去读它的配置文件web.xml的两个节点：

　　  <listener></listener> 和 <context-param></context-param>；

（2）容器创建一个ServletContext(上下文)；

（3）容器将<context-param></context-param>转化为键值对，并交给ServletContext；

（4）容器创建<listener></listener>中的类实例，即创建监听；

（5）容器初始化<filter></filter>，web.xml中可以定义多个 filter，初始化每个 filter 时，是按照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的；

（6）容器初始化<servlet></servlet>， servlet 同 filter 类似。

那么，web项目启动时，可以知道web.xml文件各个节点的加载顺序：context-param -> listener -> filter -> servlet

 web.xml中定义的元素

复制代码 
web-app> 
    <display-name></display-name>定义了WEB应用的名字 
    <description></description> 声明WEB应用的描述信息 
    
    <context-param></context-param> context-param元素声明应用范围内的初始化参数。 

    <filter></filter> 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。 
    <filter-mapping></filter-mapping> 一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。 
    
    <listener></listener>servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。 
    
    <servlet></servlet> 在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。
    <servlet-mapping></servlet-mapping> 服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName.但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。 
    
    <session-config></session-config> 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。 可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。 
    
    <mime-mapping></mime-mapping>如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。 
    
    <welcome-file-list></welcome-file-list> 指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。 
    
    <error-page></error-page> 在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。 
    
    <taglib></taglib> 对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。 
    
    <resource-env-ref></resource-env-ref>声明与资源相关的一个管理对象。 
    <resource-ref></resource-ref> 声明一个资源工厂使用的外部资源。 
    <security-constraint></security-constraint> 制定应该保护的URL。它与login-config元素联合使用 
    <login-config></login-config> 指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。 
    
    <security-role></security-role>给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。 
    
    <env-entry></env-entry>声明Web应用的环境项。 
    <ejb-ref></ejb-ref>声明一个EJB的主目录的引用。 
    <ejb-local-ref></ejb-local-ref>声明一个EJB的本地主目录的应用。 
</web-app>
复制代码

相应元素配置：

（1）Web应用图标

<icon> 
    <small-icon>/images/app_small.gif</small-icon> 
    <large-icon>/images/app_large.gif</large-icon> 
</icon>

（2）Web 应用名称

<display-name>App Name</display-name>

（3）Web 应用描述

<disciption>This is a app disciption.</disciption>

（4）上下文初始化参数

<context-param> 
    <param-name>ContextParameter</para-name> 
    <param-value>test</param-value> 
    <description>It is a test parameter.</description> 
</context-param>

在servlet里面可以通过getServletContext().getInitParameter("context/param")得到

（5）过滤器配置

复制代码 
<filter> 
    <filter-name>setCharacterEncoding</filter-name> 
    <filter-class>com.myTest.setCharacterEncodingFilter</filter-class> 
    <init-param> 
        <param-name>encoding</param-name> 
        <param-value>utf-8</param-value> 
    </init-param> 
</filter> 
<filter-mapping> 
    <filter-name>setCharacterEncoding</filter-name> 
    <url-pattern>/*</url-pattern> 
</filter-mapping>
复制代码

（6）监听器配置

<listener> 
    <listerner-class>listener.SessionListener</listener-class> 
</listener>

（7）Servlet配置

基本配置：

复制代码 
<servlet> 
    <servlet-name>test</servlet-name> 
    <servlet-class>TestServlet</servlet-class> 
</servlet> 
<servlet-mapping> 
    <servlet-name>test</servlet-name> 
    <url-pattern>/test</url-pattern> 
</servlet-mapping>
复制代码

高级配置：<servlet>

复制代码 
       <servlet-name>test</servlet-name> 
       <servlet-class>TestServlet</servlet-class> 
       <init-param> 
           <param-name>foo</param-name> 
           <param-value>bar</param-value> 
       </init-param> 
       <run-as> 
           <description>Security role for anonymous access</description> 
           <role-name>tomcat</role-name> 
       </run-as> 
           <!-- 
                 当Web应用启动时，装载Servlet的次序
                 当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet. 
                 当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它 
            -->
　　　　<load-on-startup>1</load-on-startup>
   </servlet> 
   <servlet-mapping> 
       <servlet-name>test</servlet-name> 
       <url-pattern>/test</url-pattern> 
   </servlet-mapping>
复制代码

（8）会话超时配置（单位为分钟）

<session-config> 
    <session-timeout>120</session-timeout> 
</session-config>

（9）MIME类型配置

<mime-mapping> 
    <extension>html</extension> 
    <mime-type>text/html</mime-type> 
</mime-mapping>

（10）欢迎页配置

<welcome-file-list> 
    <welcome-file>index.jsp</welcome-file> 
    <welcome-file>index.html</welcome-file> 
    <welcome-file>index.htm</welcome-file> 
</welcome-file-list>

（11）配置错误页面

方法1：通过错误码来配置error-page

<error-page> 
    <error-code>404</error-code> 
    <location>/404.jsp</location> 
</error-page>

上面的配置当系统发生404错误时，页面将跳转到错误处理页面404.jsp

方法2：通过异常类型配置error-page

<error-page> 
    <exception-type>java.lang.NullException</exception-type> 
    <location>/error.jsp</location> 
</error-page>

上面的配置当系统发生java.lang.NullException异常时，页面将跳转到错误处理页面error.jsp

（12）TLD配置

<taglib> 
    <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri> 
    <taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location> 
</taglib>
如果MyEclipse一直在报错，应该把<taglib>放到<jsp-config>中
<jsp-config> 
    <taglib> 
        <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri> 
        <taglib-location>/WEB-INF/pager-taglib.tld</taglib-location> 
    </taglib> 
</jsp-config>

（13）资源管理对象配置

<resource-env-ref> 
    <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> 
</resource-env-ref>

（14）资源工厂配置

<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>

（15）安全限制配置

复制代码 
<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>
复制代码

（16）登陆验证配置

复制代码 
<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>
复制代码

（17）安全角色：security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。

<security-role> 
    <role-name>tomcat</role-name> 
</security-role>

（18）Web环境参数：env-entry元素声明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>

（19）EJB 声明

复制代码 
<ejb-ref> 
    <description>Example EJB reference</decription> 
    <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>
复制代码

（20）本地EJB声明

复制代码 
<ejb-local-ref> 
    <description>Example Loacal EJB reference</decription> 
    <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>
复制代码

猜你喜欢

转载自www.cnblogs.com/oner-xd/p/10537079.html
今日推荐
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
面壁智能发布 Eurux-8x22B 开源大模型 —— 堪称「理科状元」
开源日报 | 谷歌扶持鸿蒙上位；开源Rabbit R1；Docker加持的安卓手机；微软的焦虑和野心；海尔电器把开放平台关了
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
周排行
Java自定义时间格式
同步整形电路
在开发中最最最常用的字符串的属性大集合
Linux 查看端口占用并杀掉
Java基础四：ArrayList
多线程之死锁就是这么简单
mysql 基础命令集
awk 命令详解
Centos6.3编译安装nginx+php步骤
OCR （Optical Character Recognition，光学字符识别）
每日归档
更多
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022