Struts 学习笔记2 －ActionServlet深入探讨

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--org.apache.struts.action.ActionServlet

Struts提供了一个缺省版本的ActionServlet类，你可以继承这个类，覆盖其中的一些方法来达到你的特殊处理的需要。ActionServlet继承与javax.servlet.http.HttpServlet，所以在本质上它和一个普通的servlet没有区别，你完全可以把它当做一个servlet来看待，只是在其中完成的功能不同罢了。ActionServlet主要完成如下功能：

将一个来自客户端的URI映射到一个相应的Action类

• 如果是这个Action类是第一次被调用，那么实例化一个并放入缓存
  
• 如果在配置文件(struts-config.xml)中指定了相应的ActionForm，那么从Request中抓取数据填充FormBean
  
• 调用这个Action类的perform()方法，传入ActionMapping的一个引用，对应的ActionForm、以及由容器传给ActionServlet的HttpServletRequest、HttpServletResponse对象。

确省版本的ActionServlet会从配置文件web.xml中读取如下初始化参数：

• application
  应用使用的资源包(resources bundle)的基类
  
• factory
  用于创建应用的MessageResources对象的MessageResourcesFactory的类名。确省是org.apache.struts.util.PropertyMessageResourcesFactory。
  
• config
  Struts的配置文件，确省是/WEB-INF/struts-config.xml。注意这儿是与应用Context关联的相对路径。
  
• content
  定义了确省的内容类型和编码格式，它会被自动地被设置到每个response中，如果JSP/Servlet中没有明确的设置。确省是text/html。
  
• debug
  调试信息的级别。默认为0，比当前级别高的调试信息会被log到日志文件中。
  
• detail
  与debug的作用类似，只是这个detail是initMapping()时专用的。调试信息会被打印到System.out，而不是日志文件。
  
• formBean
  ActionFormBean的实现类，确省为org.apache.struts.action.ActionFormBean
  
• forward
  应用中使用的ActionForward类，确省是org.apache.struts.action.ActionForward。
  
• locale
  指定了确省使用的Locale对象。设为true，当得到一个session时，会自动在session中存储一个以Action.LOCALE_KEY标示的Locale对象，如果session中还没有与Action.LOCALE_KEY绑定的Locale对象。
  
• mapping
  应用中使用的ActionMapping类，确省是org.apache.struts.action.ActionMapping。
  
• multipartClass
  文件上传使用的MutipartRequestHandler的实现类。确省为org.apache.struts.upload.DiskMultipartRequestHandler
  
• nocache
  如果设为true，那么ActionServlet会自动在每个到客户端的响应中添加nocache的HTML头，这样客户端就不会对应用中的页面进行缓存。确省为false
  
• null
  如果设置为true，那么应用在得到一个未定义的message资源时，会返回null，而不是返回一个错误信息。确省是true。
  
• maxFileSize
  文件上传的大小上限，确省为250M
  
• bufferSize
  文件上传时的缓冲区的大小，确省为4M
  
• tempDir
  设置用于上传时的临时目录。工作目录会作为一个Servlet环境（Context）的属性提供。
  
• validate
  Are we using the new configuration file format?确省为true。
  
• validating

在解析配置XML文件是是否进行有效性的验证。确省为true

ActionServlet中应用了命令设计模式。

一个Servlet在由容器生成时，首先会调用init()方法进行初始化，在接到一个HTTP请求时，调用相应的方法进行处理；比如GET请求调用doGet()方法，POST请求调用doPost()方法。所以首先看看ActionServlet的init()方法，你就会很清楚为什么ActionServlet可以完成这些功能了。

init()

在它的init()方法中，ActionServlet依次调用如下protected的方法完成初始化：

• initActions() －     大家可能还曾有这个疑问：Struts为什么可以找到一个请求URI对应的action类呢？答案就在这儿，ActionServlet有一个actions属性，类型为org.apache.struts.util.FastHashMap，用于存储以类的全名为key的已实例化的Action类。在init()时首先调用的就是initActions()方法，在这个方法中只是简单的清除map中的所有的名值对，
  
  1.  
  2.         synchronized (actions) {
  3.             actions.setFast(false);
  4.             actions.clear();
  5.             actions.setFast(true);
  6.         }
  
  首先把actions设为slow模式，这时对FastHashMap的访问是线程同步的，然后清除actions中的所有的已存在的名/值对，最后再把actions的模式设为fast。由于FastHashMap是struts在java.util.HashMap的基础上的一个扩展类，是为了适应多线程、并且对HashMap的访问大部分是只读的特殊环境的需要。大家知道java.util.HashMap是非线程安全的，所以HashMap一般适用于单线程环境下。org.apache.struts.FastHashMap就是继承于java.util.HashMap，在其中添加多线程的支持产生的。在fast模式下的工作方式是这样的：读取是非线程同步的；写入时首先克隆当前map，然后在这个克隆上做写入操做，完成后用这个修改后的克隆版本替换原来的map。那么在什么时候会把Actions类添加到这个map中呢？我们已经提到了struts是动态的生成Action类的实例的，在每次ActionServlet接收到一个GET或POST的HTTP请求时，会在这个map中查找对应的Action类的实例，如果不存在，那么就实例化一个，并放入map中。可见这个actions属性起到了对Action类实例的缓存的作用。
  
• initInternal() －     初始化ActionServlet内部使用的资源包MessageResources，使用MessageResources.getMessageResources(internalName)得到    internalName为"org.apache.struts.action.ActionResources"对应的ActionResources.properties文件。这个资源包主要用于ActionServlet处理过程中的用到的提示信息，这儿不展开讨论。
  
• initDebug() －     从web.xml中读取本应用的debug级别参数getServletConfig().getInitParameter("debug")，然后赋给debug属性。
  
• initApplication()－    初始化应用资源包，并放置入ServletContext中。
  
  1.  
  2.         String factory =getServletConfig().getInitParameter(“factory”);    
  3.         String oldFacory = MessageResourcesFactory.getFactoryClass();
  4.         if (factory !=null)
  5.                 MessageResourcesFactory.setFactoryClass(factory);
  6.         String value = getServletConfig().getInitParameter("application");
  7.         MessageResourcesFactory factoryObject =
  8.                 MessageResourcesFactory.createFactory();
  9.         application = factoryObject.createResources(value);
  10.         MessageResourcesFactory.setFactory(oldFactory); 
  11.         getServletContext().setAttribute(Action.MESSAGES_KEY, application);
  
  说明：文中引用的代码片断可能会省略了一些例外检查等非主线的内容，敬请注意。
  
  首先从配置文件中读取factory参数，如果这个参数不为空，那么就在MessageResourcesFactory中使用这个指定的Factory类；否则，使用默认的工厂类org.apche.struts.util.PropertyMessageResourceFactory。然后调用MessageResourcesFactory的静态createFactory()方法，生成一个具体的MessageResourceFactory对象（注意：MessageResourcesFactory是抽象类）。这样就可以调用这个具体的MessageResourceFactory的createResource()方法得到配置文件(web.xml)中定义的资源文件了。
  上面的application对象类型为MessageResources。在web.xml中在配置ActionServlet时可以指定一个特定的工厂类。不能直接MessageResourcesFactory的createResources()方法，因为这个方法是abstract的。创建factoryObject的过程如下：
  
  1.     
  2.         MessageResourceFactory factoryObject=
  3.                 MessageResourcesFactory.createFactory();
  4.         application = factoryObject.createResources(value);
  
  <li>initMapping() －    为应用初始化mapping信息ActionServlet有一个protected的属性：mapping，封装了一个ActionMapping的对象集合，以便于管理、查找ActionMapping。mappings是org.apache.struts.action.ActionMappings类的实例。主要有两个方法：addMapping(ActionMapping mapping)和findMapping(String path)。ActionMapping也是使用上面提到的org.apache.struts.util.FastHashMap类来存储所有的ActionMapping对象。
  
  1.  
  2.         mappings.setServlet(this);
  3.         ……
  4.         // Initialize the name of our ActionFormBean implementation class
  5.         value = getServletConfig().getInitParameter("formBean");
  6.         if (value != null)
  7.             formBeanClass = value;
  8.     
  9.         // Initialize the name of our ActionForward implementation class
  10.         value = getServletConfig().getInitParameter("forward");
  11.         if (value != null)
  12.                 forwardClass = value;
  13.  
  14.         // Initialize the name of our ActionMapping implementation class
  15.         value = getServletConfig().getInitParameter("mapping");
  16.         if (value != null)
  17.                 mappingClass = value;
  
  在initMapping()中，首先链接mappings对象到本servlet实例。其实这句话的作用很简单，在ActionMappings中会有一个ActionServlet类型的属性，这个属性就界定了这个ActionMappings对象所属的ActionServlet。Struts的实现比较灵活，其中的ActionFormBean、ActionForward、ActionMapping类你完全可以使用自己实现的子类，来定制Struts的工作方式。上面的代码就从配置文件（web.xml）中读取formBean、forward、mapping参数，这些参数就是你定制的ActionFormBean、ActionForward、ActionMapping类名。
  
  1.  
  2.         // Initialize the context-relative path to our configuration resources
  3.         value = getServletConfig().getInitParameter("config");
  4.         if (value != null)
  5.                 config = value;
  6.                 // Acquire an input stream to our configuration resource
  7.         InputStream input = getServletContext().getResourceAsStream(config);
  8.         Digester digester = null;
  9.                 digester = initDigester(detail);
  10.         try {
  11.                 formBeans.setFast(false);
  12.                 forwards.setFast(false);
  13.                 mappings.setFast(false);
  14.                 digester.parse(input);
  15.                 mappings.setFast(true);
  16.                 forwards.setFast(true);
  17.                 formBeans.setFast(true);
  18.         } catch (SAXException e) {
  19.                 throw new ServletException
  20.         (internal.getMessage("configParse", config), e);
  21.         } finally {
  22.                 input.close();
  23.         }
  
  从web.xml读取Struts的配置文件的位置。使用org.apache.struts.digester.Digester解析config参数标示的配置文件，通常为“/WEB-INF/struts-config.xml”，解析出所有的data-source、form-bean、action-mapping、forward。从上面的程序片断看到，Digester仅仅调用了一个parse()方法，那么，Digester是怎样把解析struts-config.xml文件并把解析的结果form-bean等信息存储到属性变量formBeans等中的呢？你可以注意到在调用digester.parse(InputStream)之前，首先调用了initDigester()方法：
  
  1.  
  2.         Digester digester = new Digester();
  3.         digester.push(this);
  4.         digester.addObjectCreate("struts-config/action-mappings/action",
  5.                                  mappingClass, "className");
  6.         digester.addSetProperties("struts-config/action-mappings/action");
  7.         digester.addSetNext("struts-config/action-mappings/action",
  8.                             "addMapping",
  9.                             "org.apache.struts.action.ActionMapping");
  10.  
  11.         digester.addSetProperty
  12.             ("struts-config/action-mappings/action/set-property",
  13.              "property", "value");
  
  在这个方法中首先生成一个Digester对象，然后设置解析的规则和回调，如果你对XML、SAX不是很熟，这儿不必纠缠太深。要注意的是addSetNext()方法，设置了每一个要解析元素的Set Next回调方法，而这个方法就是由digester解析器的父提供的。上面的片断中的“addMapping”就是ActionServlet本身定义的一个方法，将由Digester回调。Digester就是籍此把解析出的每一个FormBean、ActionForward、ActionMapping等存储到属性变量formBeans、forwards、mappings等中的。
  
• initUpload() －    初始化有关Upload的一些参数，比如：bufferSize、tempDir。
  
• initDataSource() －取出在initMapping()中从配置文件中读取的每一个DataSource，设置LogWriter，如果为GenericDataSource的实例，则打开数据源。然后，把每个dataSource放入Context中。
  dataSource.setLogWriter(scw)；
  ((GenericDataSource)dataSource).open();
  getServletContext().setAttribute(key,dataSource);
  
• initOther() －        设置其它尚未初始化的的参数（content、locale、nocache），并发布formBeans、forwards、mappings到Context：
  getServletContext().setAttribute(Action.FORM_BEANS_KEY, formBeans);
  getServletContext().setAttribute(Action.FORWARDS_KEY, forwards);
  getServletContext().setAttribute(Action.MAPPINGS_KEY, mappings);
  
• initServlet() －    初始化Controller Servlet的Servlet Mapping。这儿也使用了Digester工具，扫描web.xml所有的<web-app/servlet-mapping>，寻找servlet-name与当前Servlet相同的mapping，置入Context。代码如下；
  
  1.  
  2.         Digester digester = new Digester();
  3.         digester.push(this);
  4.         digester.setDebug(debug);
  5.         digester.setValidating(validating);
  6.         digester.addCallMethod(“web-appservlet-mapping”,“addServletMapping”, 2);
  7.         digester.addCallParm(“web-appservlet-mappingservlet-name”, 0);
  8.         digester.addCallParm(“web-appservlet-mappingurl-pattern”, 1);
  9.         InputStream is = getServletContext().getResourceAsStream(“/WEB-INFweb.xml”);
  10.         digester.parse(is); 
  11.         getServletContext().setAttribute(Action.SERVLET_KEY,servletMapping);