`

究 Spring 3.1之无web.xml式 基于代码配置的servlet3.0应用(转)

阅读更多

  大家应该都已经知道Spring 3.1对无web.xml式基于代码配置的servlet3.0应用。通过spring的api或是网络上高手们的博文,也一定很快就学会并且加到自己的应用中去了。PS:如果还没,也可以小小参考一下鄙人的上一篇文章<<探 Spring 3.1之无web.xml式 基于代码配置的servlet3.0应用>>。 

        经过一天的深度research, 我了解,理解以及重现了springframework的那一小段代码。
 

        OK,第一步,入手点,WebApplicationInitializer接口。因为我们只需实现这个接口覆写它的一个方法,就可以做到配置web.xml同样的功效。看它的源码,其实看和不看没什么两样: 

Java代码  收藏代码
  1. package org.springframework.web;  
  2.   
  3. import javax.servlet.ServletContext;  
  4. import javax.servlet.ServletException;  
  5. public interface WebApplicationInitializer {  
  6.     void onStartup(ServletContext servletContext) throws ServletException;  
  7. }  

   就这么点儿,有效代码5行,弄地我一头雾水,就是一个普通接口,声明了一个方法。连注解都没有,server是怎么找到实现了它的类的?如果这样,何不找我定义的其它接口(的实现类完成配置工作)呢。可见现在java的解耦技术,真令人汗颜。 
   第二步,这个接口旁边(同包)有个SpringServletContainerInitializer, 看下它是何方神圣吧:
 
Java代码  收藏代码
  1. package org.springframework.web;  
  2.   
  3. import java.lang.reflect.Modifier;  
  4. import java.util.Collections;  
  5. import java.util.LinkedList;  
  6. import java.util.List;  
  7. import java.util.ServiceLoader;  
  8. import java.util.Set;  
  9. import javax.servlet.ServletContainerInitializer;  
  10. import javax.servlet.ServletContext;  
  11. import javax.servlet.ServletException;  
  12. import javax.servlet.annotation.HandlesTypes;  
  13.   
  14. import org.springframework.core.annotation.AnnotationAwareOrderComparator;  
  15.   
  16. @HandlesTypes(WebApplicationInitializer.class)  
  17. public class SpringServletContainerInitializer implements ServletContainerInitializer {  
  18. public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)  
  19.             throws ServletException {  
  20.   
  21.         List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();  
  22.         if (webAppInitializerClasses != null) {  
  23.             for (Class<?> waiClass : webAppInitializerClasses) {  
  24.                 // Be defensive: Some servlet containers provide us with invalid classes,  
  25.                 // no matter what @HandlesTypes says...  
  26.                 if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&             WebApplicationInitializer.class.isAssignableFrom(waiClass)) {  
  27.                     try {  
  28.                         initializers.add((WebApplicationInitializer) waiClass.newInstance());  
  29.                     }  
  30.                     catch (Throwable ex) {  
  31.                         throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);  
  32.                     }  
  33.                 }  
  34.             }  
  35.         }  
  36.   
  37.         if (initializers.isEmpty()) {  
  38.             servletContext.log("No Spring WebApplicationInitializer types detected on classpath");  
  39.             return;  
  40.         }  
  41.   
  42.         Collections.sort(initializers, new AnnotationAwareOrderComparator());  
  43.         servletContext.log("Spring WebApplicationInitializers detected on classpath: " + initializers);  
  44.   
  45.         for (WebApplicationInitializer initializer : initializers) {  
  46.             initializer.onStartup(servletContext);  
  47.         }  
  48.     }  
  49.   
  50. }  


     以上的有效代码28行。刚看时也很迷茫,其实慢慢就理解了。拟个伪代码吧,方便大家理解: 
      1,定义一个类SpringServletContainerInitializer,并标明该类要操作的一个类WebApplicationInitializer 
      2, 该类会行使ServletContainerInitializer接口的一个行为onStartup,从而将一个集合中的初始化设置 全部配置到ServletContext的实例中。 
      3,具体的onStartup方法中,建立合格配置列表, 
      4,如果确定集合中有配置,逐一检查配置是否是合格配置,具体判断依据:这个类不是接口,不是抽象类,而且是所要操作的那个接口的一个实现类。满足此依据,合格。将合格的配置类实例化放入合格配置列表。过程中有错要通知控制台。 
     5,如若执行完步骤4,发现没有合格配置,在ServletContext记录该结果,并结束onStartup行为。 
     6,将找到配置按一定排列方式(AnnotationAwareOrder)排序。 
     7,在ServletContext中记录找到结果。 
     8,逐一执行配置。 即驱动每一个WebApplicationInitializer的实现类行使其onStartup行为。 

     第三步很明显了,去research 接口ServletContainerInitializer和注解HandleType。在这里:
http://docs.oracle.com/javaee/6/api/javax/servlet/ServletContainerInitializer.html 

    该接口允许一个库或运行时,(运行时应该指server)声明为一个web程序的启动状态,并执行任何所需的程序中注册的servlet,filter,listener来响应它...... 
     其它也就不用看了,可以想象得到支持Servlet3机制的服务器,会找到这样接口的实现类,执行onStartup行为。至于如何找,无非也是这样一系列的反射机制的应用。自己做一个试试吧: 
     自定义的WebApplicationInitializer:
 

Java代码  收藏代码
  1. package com.gxino.imagecapture.cfg;  
  2.   
  3. import javax.servlet.ServletContext;  
  4. import javax.servlet.ServletException;  
  5.   
  6. public interface WebParameter {  
  7.     public void loadInfo(ServletContext servletContext) throws ServletException;  
  8. }  


     自定义的ServletContainerInitializer,我做得很简单,直接去执行找到配置类中的loadInfo方法 

Java代码  收藏代码
  1. package com.gxino.imagecapture.cfg;  
  2.   
  3. import java.lang.reflect.Modifier;  
  4. import java.util.Set;  
  5.   
  6. import javax.servlet.ServletContainerInitializer;  
  7. import javax.servlet.ServletContext;  
  8. import javax.servlet.ServletException;  
  9. import javax.servlet.annotation.HandlesTypes;  
  10.   
  11. @HandlesTypes(WebParameter.class)  
  12. public class WebConfiguration implements ServletContainerInitializer {  
  13.   
  14.     @Override  
  15.     public void onStartup(Set<Class<?>> webParams, ServletContext servletCtx)  
  16.             throws ServletException {  
  17.         if (webParams != null) {  
  18.             for (Class<?> paramClass : webParams) {  
  19.                 if (!paramClass.isInterface() && !Modifier.isAbstract(paramClass.getModifiers()) &&  
  20.                         WebParameter.class.isAssignableFrom(paramClass)) {  
  21.                     try {  
  22.                         ((WebParameter) paramClass.newInstance()).loadInfo(servletCtx);  
  23.                     }  
  24.                     catch (Throwable ex) {  
  25.                         throw new ServletException("Failed to instantiate WebParam class", ex);  
  26.                     }  
  27.                 }  
  28.             }//loop  
  29.         }//Web Params  
  30.     }//onStartup  
  31.   
  32. }  

      写个测试Servlet: 

Java代码  收藏代码
  1. package com.gxino.imagecapture.ctrl;  
  2.   
  3. import java.io.IOException;  
  4.   
  5. import javax.servlet.ServletException;  
  6. import javax.servlet.http.HttpServlet;  
  7. import javax.servlet.http.HttpServletRequest;  
  8. import javax.servlet.http.HttpServletResponse;  
  9.   
  10. import com.gxino.imagecapture.cfg.WebParameter;  
  11.   
  12. public class TestServlet extends HttpServlet {  
  13.       
  14.     public void doGet(HttpServletRequest req, HttpServletResponse resp){  
  15.         System.out.println("Some client access once");  
  16.         try {  
  17.             req.getRequestDispatcher("/index.jsp").forward(req, resp);  
  18.         } catch (ServletException | IOException e) {  
  19.             // TODO Auto-generated catch block  
  20.             e.printStackTrace();  
  21.         }  
  22.     }  
  23.       
  24. }  


       实现WebParam配置接口来配置刚才的Servlet: 

Java代码  收藏代码
  1. package com.gxino.imagecapture.cfg;  
  2.   
  3. import javax.servlet.ServletContext;  
  4. import javax.servlet.ServletException;  
  5. import javax.servlet.ServletRegistration;  
  6.   
  7.   
  8. public class ServletParameter implements WebParameter {  
  9.   
  10.     @Override  
  11.     public void loadInfo(ServletContext servletContext) throws ServletException {  
  12.         ServletRegistration.Dynamic testServlet=servletContext.addServlet("test","com.gxino.imagecapture.ctrl.TestServlet");  
  13.         testServlet.setLoadOnStartup(1);  
  14.         testServlet.addMapping("/index.html");  
  15.     }  
  16.   
  17. }  

     启动服务器,访问http://localhost:xxxx/xxxxx/index.html 
  
     失败。Debug. 发现没有走这些代码。应该还差关键环节。看来还得知道Servlet3中是怎么找ServletContainerInitializer的。再回刚才ServletContainerInitializer的api有这样一句:该接口的实现必须声明一个JAR资源放到程序中的META-INF/services下,并且记有该接口那个实现类的全路径,才会被运行时(server)的查找机制或是其它特定机制找到。那篇api需要仔细阅读啊。 
     到org.springframework.web-3.0.1.RELEASE.jar中能找到META-INF/services下的javax.servlet.ServletContainerInitializer文件,内容为org.springframework.web.SpringServletContainerInitializer同样,我们专门作这样一个包,在mkdir好的META-INF/services下vi 一个文件命名为javax.servlet.ServletContainerInitializer,内容为自定的那个WebConfiguration的全路径类名。 然后在META-INF的parent路径下运行jar cvf test.jar META-INF。一切完毕,将其放到WEB-INF/lib下。启动。
 
     
     这回大功告成。 
     
     访问http://localhost:xxxx/xxxxx/index.html。页面跳到了index.jsp下。 
     并且控制台打出: Some client access once 

     再使个劲,将Servlet和Servlet配置合二为一:
 
Java代码  收藏代码
  1. package com.gxino.imagecapture.ctrl;  
  2.   
  3. import java.io.IOException;  
  4.   
  5. import javax.servlet.ServletContext;  
  6. import javax.servlet.ServletException;  
  7. import javax.servlet.ServletRegistration;  
  8. import javax.servlet.http.HttpServlet;  
  9. import javax.servlet.http.HttpServletRequest;  
  10. import javax.servlet.http.HttpServletResponse;  
  11.   
  12. import com.gxino.imagecapture.cfg.WebParameter;  
  13.   
  14. public class TestServlet extends HttpServlet implements WebParameter{  
  15.   
  16.     @Override  
  17.     public void loadInfo(ServletContext servletContext) throws ServletException {  
  18.         ServletRegistration.Dynamic testServlet=servletContext.addServlet("test""com.gxino.imagecapture.ctrl.TestServlet");  
  19.         testServlet.setLoadOnStartup(1);  
  20.         testServlet.addMapping("/index.html");  
  21.     }  
  22.     public void doGet(HttpServletRequest req, HttpServletResponse resp){  
  23.         System.out.println("Some client access once");  
  24.         try {  
  25.             req.getRequestDispatcher("/index.jsp").forward(req, resp);  
  26.         } catch (ServletException | IOException e) {  
  27.             // TODO Auto-generated catch block  
  28.             e.printStackTrace();  
  29.         }  
  30.     }  
  31.       
  32. }  


这回我们看到,配置文件与servlet放到了一起。这样将回节省大量时间。 

    以后直接运用Spring Framework的WebApplicationInitializer也知道是怎么一回事儿了。而且可以将Spring 的applicationContext.xml与web.xml融合在一个类中。即注解为@Configuration,并实现WebApplicationInitializer.回头试试。

分享到:
评论

相关推荐

    org.springframework.web.servlet-3.1.0.RELEASE.jar.zip

    《Spring Web MVC框架详解——基于org.springframework.web.servlet-3.1.0.RELEASE.jar》 在Java Web开发领域,Spring框架无疑是最具影响力的框架之一,其中Spring Web MVC是其核心组件,专注于处理Web请求和响应。...

    Tomcat(二) Tomcat实现:Servlet与web.xml介绍 以及 源码分析Tomcat实现细节1

    web.xml是Web应用的部署描述符,它包含了应用的配置信息,如Servlet、Filter、Listener的定义,以及它们之间的映射关系。通过web.xml,Tomcat知道如何正确地初始化和管理Web应用的各个组件。 5. **Tomcat源码分析*...

    spring MVC配置详解

    -- 可以自定义 servlet.xml 配置文件的位置和名称,默认为 WEB-INF 目录下,名称为[&lt;servlet-name&gt;]-servlet.xml,如 spring-servlet.xml --&gt; &lt;param-name&gt;contextConfigLocation &lt;param-value&gt;/WEB-INF/spring-...

    spring3.1包名解析

    18. `org.springframework.web.servlet-3.1.0.M1.jar`: 提供对Servlet 3.0规范的支持,是Spring MVC的主要组成部分,负责处理HTTP请求和响应。 19. `org.springframework.web.struts-3.1.0.M1.jar`: 与Struts框架的...

    SSH和SSI等框架常用基础配置web.xml

    对于使用SSH(Struts + Spring + Hibernate)和SSI(Struts + Spring + iBatis)等框架的应用程序而言,合理的`web.xml`配置至关重要。本文将详细介绍`web.xml`中的关键配置项,并解释其作用。 #### 一、`web.xml`...

    struct2.3+spring3.1+mybits3.1 核心Jar包和配置文件

    "struct2.3+spring3.1+mybits3.1 核心Jar包和配置文件"的组合正是这样一个经典的应用架构,它将Struts2、Spring3.1和MyBatis3.1这三个流行框架整合在一起,为开发者提供了强大的MVC(Model-View-Controller)架构...

    spring3.1+xfire1.26

    总的来说,"spring3.1+xfire1.26 全注解"项目展示了如何利用Spring 3.1和XFire 1.26的注解功能,实现无XML配置的Web服务开发,提高了开发效率,降低了维护成本。在实际应用中,这种组合可以方便地创建和部署复杂的...

    web.xml文件的作用

    虽然并非所有Web应用程序都必须包含`web.xml`文件,但在大多数场景下,为了更好地配置和管理Web应用,开发者通常会选择在项目的`WEB-INF`目录下放置一个`web.xml`文件。本文将详细介绍`web.xml`文件的基本概念、结构...

    struts2.0+hibernate3.1+spring2.0.doc

    1. **web.xml**:定义了应用程序的初始化参数以及Servlet的映射规则。 ```xml &lt;servlet&gt; &lt;servlet-name&gt;action&lt;/servlet-name&gt; &lt;servlet-class&gt;org.apache.struts2.dispatcher.ng.filter....

    springmvc3.1+hibernate3环境搭建架包

    在实际开发中,你可能还需要添加其他的库,例如Spring的测试库(spring-test-3.1.x.jar)来进行单元测试,或者JSTL和EL库(如javax.servlet.jsp.jstl-*.jar和javax.el-*.jar)来实现动态视图。记得根据项目的具体...

    Spring MVC总结(一)

    Spring MVC架构与DispatcherServlet配置 Spring MVC是一种流行的基于Java的Web应用框架,它提供了一个灵活的架构来开发...了解Spring MVC的架构和DispatcherServlet的配置是开发基于Spring MVC的Web应用程序的基础。

    spring3.1MVC+mybatis3.1框架集成及事务,分页使用

    1. **Spring MVC 3.1**:Spring MVC是Spring框架的一个模块,主要处理Web应用中的请求和响应。它提供了模型-视图-控制器(MVC)架构,使得开发人员能够将业务逻辑、数据和用户界面分离。Spring MVC 3.1引入了更多的...

    spring 3.1 mvc sample

    Spring MVC 是一个强大的基于Java的Web应用程序开发框架,它属于Spring框架的一部分,专注于处理Web请求和展示数据。在Spring 3.1版本中,引入了许多改进和新特性,旨在提高开发效率和应用性能。这个“spring 3.1 ...

    Spring3.1整合FreeMarker2.3.19

    它通过`org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer`类来配置FreeMarker,并通过`org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver`类来解析视图。 **2. 配置...

    struts2.0+hibernate3.1+spring2.5的配置

    Struts2.0、Hibernate3.1和Spring2.5是经典的Java企业级开发框架组合,它们在2000年代末至2010年代初广泛用于构建Web应用程序。这个配置组合提供了模型-视图-控制器(MVC)架构、持久化管理和依赖注入等核心功能。 ...

    官方原版源码spring-framework-4.3.25.RELEASE.zip

    此外,它优化了对Servlet 3.1的支持,增强了对WebSocket和Spring Data的改进。 3. **源码结构分析** - **spring-framework-4.3.25.RELEASE-dist.zip**:包含Spring Framework的基础库和核心模块,如core-container...

    SPRING MVC配置过程

    -- 可以自定义 servlet.xml 配置文件的位置和名称,默认为 WEB-INF 目录下,名称为 [&lt;servlet-name&gt;]-servlet.xml,如 spring-servlet.xml --&gt; &lt;param-name&gt;contextConfigLocation &lt;param-value&gt;/WEB-INF/spring...

    集成Hibernate3.6.8+Spring3.0.6+struts2.2.3.1

    `web.xml`是Web应用的部署描述符,其中定义了Servlet、Filter、Listener等组件的配置。对于Struts而言,这里需要配置Struts的DispatcherServlet,它是处理HTTP请求的入口。 #### Struts配置文件:struts.xml `...

    SSH 配置实例: Spring 3.1 + Hibernate 4.2 + Struts 2.3

    开发人员需要编写XML配置文件,如Spring的`applicationContext.xml`和Struts 2的`struts.xml`,来定义框架的配置和应用的组件。 总之,SSH框架的集成使得开发者可以充分利用Spring的依赖注入和事务管理,Hibernate...

    DWR3.0_Spring3.1_Hibernate4.1_JPA全注解实例

    《DWR3.0_Spring3.1_Hibernate4.1_JPA全注解实例》是一个集成技术的实践教程,涵盖了Direct Web Remoting (DWR) 3.0、Spring框架3.1、Hibernate持久化框架4.1以及Java Persistence API (JPA)的全注解使用方法。...

Global site tag (gtag.js) - Google Analytics