webx-module

1）总览

              1.什么是Module

                 Module相当于controller，是用来处理逻辑的，target映射之后可以找到对应的Module来执行。

                 一般情况下（类都是Java编写），相当于一个用来处理逻辑的java类

                 不使用AdapterFactory的情况下，Module都要实现Module，Module接口如下：

 

[java] view plain copy  

1. public interface Module {  
2.     /** 执行模块。 */  
3.     void execute() throws Exception;  
4. }  

                 execute()方法是自定义执行逻辑的地方，调用的时候也是通过execute()方法来触发Module的执行

 

 

              2.Module分类

                 action：主要用于处理表单数据

                 screen：处理页面的主题内容

 

                 control：处理页面的部分内容

 

 

              3.Module属性

                 moduleType：表示Module的类型，通常有screen、action

                 moduleName：Module的名称，通常就是target

 

              4.什么是ModuleLoaderService

                 Module定义之后如何才能被使用呢？这就必须要用到ModuleLoaderService了，它能够扫描特定的包或者特定类来加载类，从而供框架使用。

                 但是Module接口的execute()只有这一种类型，没有参数没有返回值，甚至有的类就没有实现Module接口，肯定不能满足需求，所以ModuleLoaderService的另一个功能就是将这些类转换为实现了Module接口、满足要求的Module，同时保持原来处理逻辑不变

                 而这两个功能不是ModuleLoaderService直接实现的，加载类是使用ModuleFactory，模块适配是使用ModuleAdapterFactory实现的。

 

 

（2）ModuleLoaderService

              1.接口

[java] view plain copy  

1. public interface ModuleLoaderService {  
2.     /** 取得当前factory所支持的所有module类型。 */  
3.     Set<String> getModuleTypes();  
4.   
5.     /** 取得指定module类型的所有module名称。 */  
6.     Set<String> getModuleNames(String moduleType);  
7.   
8.     /** 取得指定名称和类型的module实例。 */  
9.     Module getModule(String moduleType, String moduleName) throws ModuleLoaderException, ModuleNotFoundException;  
10.   
11.     /** 
12.      * 取得指定名称和类型的module实例。 
13.      * <p> 
14.      * 和<code>getModule()</code>不同的是，该方法不会抛出<code>ModuleNotFoundException</code> 
15.      * 。如果模块不存在，则返回<code>null</code>。 
16.      * </p> 
17.      */  
18.     Module getModuleQuiet(String moduleType, String moduleName) throws ModuleLoaderException;  
19. }  

              2.成员变量

 

 

 

[java] view plain copy  

1. public class ModuleLoaderServiceImpl extends AbstractService<ModuleLoaderService> implements ModuleLoaderService,  
2.                                                                                              ProductionModeAware {  
3.     private Map<ModuleKey, Module> moduleCache    = createConcurrentHashMap();  
4.     private boolean                productionMode = true;  
5.     private Boolean                cacheEnabled;  
6.     private ModuleFactory[]        factories;  
7.     private ModuleAdapterFactory[] adapters;  
8. ...  
9. }  

              可以看出其中存储了ModuleFactory和ModuleAdapterFactory

 

 

 

 

 

              3.关键方法

 

[java] view plain copy  

1. public Module getModuleQuiet(String moduleType, String moduleName) throws ModuleLoaderException {  
2.         ....  
3.   
4.         // 从factory中装载  
5.         Object moduleObject = null;  
6.         Module module = null;  
7.   
8.         for (ModuleFactory factory : factories) {   //从多个Factory中查找  
9.             moduleObject = factory.getModule(moduleType, moduleName);  
10.   
11.             if (moduleObject != null) {  
12.                 break;  
13.             }  
14.         }  
15.   
16.         // 通过适配器转换接口  
17.         if (moduleObject != null) {  
18.             if (moduleObject instanceof Module) {  
19.                 module = (Module) moduleObject; // 假如moduleObject直接实现了接口  
20.             } else {   //如果没有则进行适配  
21.                 for (ModuleAdapterFactory adapter : adapters) {  
22.                     module = adapter.adapt(moduleType, moduleName, moduleObject);  
23.   
24.                     if (module != null) {  
25.                         break;  
26.                     }  
27.                 }  
28.             }  
29.         }  
30.         ...  
31.         return module;  
32.     }  

             核心代码如上：即先从factory中查找Module，然后进行适配转换

 

 

 

 

 

              4.总结

                 ModuleLoaderService就是一个高层接口，利用ModuleFactory和ModuleAdapterFactory实现加载并适配Module的功能

 

 

（3）ModuleFactory

              1.接口

[java] view plain copy  

1. /** 
2.  * 用来创建modules的工厂。 
3.  * 
4.  * @author Michael Zhou 
5.  */  
6. public interface ModuleFactory {  
7.     /** 取得当前factory所支持的所有module类型。 */  
8.     Set<String> getModuleTypes();  
9.   
10.     /** 取得指定module类型的所有module名称。 */  
11.     Set<String> getModuleNames(String moduleType);  
12.   
13.     /** 
14.      * 取得指定名称和类型的module实例。 
15.      * <p> 
16.      * 如果未找到，则返回<code>null</code>。 
17.      * </p> 
18.      */  
19.     Object getModule(String moduleType, String moduleName) throws ModuleLoaderException;  
20. }  

              2.关键方法

 

[java] view plain copy  

1. public Object getModule(String moduleType, String moduleName) throws ModuleLoaderException {  
2.     Map<String, ModuleInfo> typedModules = modules.get(moduleType);  
3.   
4.     if (typedModules == null) {  
5.         return null;  
6.     } else {  
7.         ModuleInfo module = typedModules.get(moduleName);  
8.   
9.         if (module == null) {  
10.             return null;  
11.         }  
12.   
13.         if (!beans.containsBean(module.getBeanName())) {  
14.             return null;  
15.         }  
16.   
17.         try {  
18.             return beans.getBean(module.getBeanName()); //获取Module  
19.         } catch (Exception e) {  
20.             throw new ModuleLoaderException("Failure loading module: " + moduleType + ":" + moduleName, e);  
21.         }  
22.     }  
23. }  

                 其中modules为Map<String,ModulteInfo>，其中存储了Module的信息，内容如下

 

[plain] view plain copy  

1. [screen={multievent.SayHello2=Module {  
2.   type:name = screen:multievent.SayHello2  
3.   beanName  = module.screen.multievent.SayHello2  
4.   source    = my_test.understand.app1.module.screen.multievent.SayHello2  
5. }, simple.Download=Module {  
6.   type:name = screen:simple.Download  
7.   beanName  = module.screen.simple.Download  
8.   source    = my_test.understand.app1.module.screen.simple.Download  
9. }, form.Welcome=Module {  
10.   type:name = screen:form.Welcome  
11.   beanName  = module.screen.form.Welcome  
12.   source    = my_test.understand.app1.module.screen.form.Welcome  
13. }},   
14. action={RegisterAction=Module {  
15.   type:name = action:RegisterAction  
16.   beanName  = module.action.RegisterAction  
17.   source    = my_test.understand.app1.module.action.RegisterAction  
18. }},  null]  

             key为ModuleType，即screen、action等，ModuleInfo保留了Module必要的信息，如beanName，source等

             最终的Module实际上还是通过beanFactory来获取的
 

 

（4）ModuleAdapterFactory

              1.接口

[java] view plain copy  

1. public interface ModuleAdapterFactory {  
2.     /** 将对象转换成module接口。 */  
3.     Module adapt(String type, String name, Object moduleObject) throws ModuleLoaderException;  
4. }  

              2.DataBindingAdapterFactory

 

[java] view plain copy  

1. public class DataBindingAdapterFactory extends AbstractDataBindingAdapterFactory {  
2.     public Module adapt(String type, String name, Object moduleObject) {  
3.         ModuleInfo moduleInfo = new ModuleInfo(type, name);  
4.         Class<?> moduleClass = moduleObject.getClass();  
5.         Method executeMethod = getMethod(moduleClass, "execute");  
6.   
7.         if (executeMethod != null) {  
8.             FastClass fc = FastClass.create(moduleClass);  
9.             FastMethod fm = fc.getMethod(executeMethod);  
10.   
11.             // 对于action，可被“跳过”执行。  
12.             boolean skippable = "action".equalsIgnoreCase(type);  
13.   
14.             return new DataBindingAdapter(moduleObject, getMethodInvoker(fm, moduleInfo, skippable));  
15.         }  
16.   
17.         return null;  
18.     }  
19. }  

             可以看出只支持execute方法

 

 

              3.AbstractModuleEventAdapterFactory  

 

 

 

[java] view plain copy  

1. public abstract class AbstractModuleEventAdapterFactory<A extends AbstractModuleEventAdapter>  
2.         extends AbstractDataBindingAdapterFactory implements ApplicationContextAware {  
3.     private static final String DEFAULT_EVENT = "perform";  
4.     private static final String PRE_HANDLER   = "beforeExecution";  
5.     private static final String POST_HANDLER  = "afterExecution";  
6.     private ApplicationContext context;  
7.     ....  
8. }  

             这种ModuleAdapterFactory可以支持do开头的方法，并且默认方法是doPerform，开始前可以执行beforeExecution，结束后可以执行afterExecution

 

 

 

（5）webx-xx.xml使用配置

              1.最简单配置

 

[html] view plain copy  

1. <services:module-loader>  
2.     <ml-factories:class-modules>  
3.         <search-packages type="$1" packages="com.alibaba.sample.petstore.web.home.module.*" />  
4.     </ml-factories:class-modules>  
5. </services:module-loader>  

 

                <1>packages属性

                只用指定search-package即可，表示Module去哪里扫描

                *表示通配符，那么com.alibaba.sample.petstore.web.home.module以及其子包都可以被扫描到

            packages表达式中可以有多个通配符*，第一个*代表的字符串可以用$1表示，第二个使用$2... 那么type属性可以使用$1,$2来表示。

            比如有一个Module：com.alibaba.sample.petstore.web.home.module.screen.HelloScreen ，那么第一个就是screen，因为type是使用$1，所以type说就是screen，即moduleType为screen。而moduleName是type之后的所有字符，那么就是HelloScreen

               <2>class-modules属性

 

[html] view plain copy  

1. </ml-factories:class-modules>  

                     表示模块是使用classes生成的module，对应ClassModuleFactory

 

                     如果是使用script生成的Module，可以使用<ml-factories:script-modules>，对应ScriptModuleFactory
                     如果使用自定义的ModuleFactory，那么使用<ml-factories:factory >

 

              2.adapter配置

[html] view plain copy  

1. <services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >  
2. <ml-adapters:data-binding-adapter/>  
3. <ml-adapters:action-event-adapter/>     
4. <ml-adapters:adapter class=" com.alibaba.sample.petstore.web. common .adapter.AjaxAdapterFactory"/>  
5. </services:module-loader>  

               data-bing-adapter绑定了DataBindingAdapterFactory，action-event-adapter绑定了ActionEventAdapterFactory，adapter绑定了自定义的Adapter 

 

 

 

 

 

 

              3.service：module-loader配置

 

[html] view plain copy  

1. <services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >  
2. <ml-factories:class-modules>  
3.     <ml-factories:search-packages type="$1" packages="com.alibaba.sample.petstore.web.store.module.*" />  
4. </ml-factories:class-modules>  
5. < ml-factories:factory class="com.alibaba.sample.petstore.web.common.factory.AjaxAdapterFactory"/>  
6. </services:module-loader>  

                cacheEnabled：表示查找的时候使用缓存

 

                includeDefaultAdapters：表示是否使用默认的Adapter，默认为true。当为true时，会自动加载DataBindingAdapterFactory、ActionEventAdapterFactory，所以可以不需要再用<ml-adapters:data-binding-adapter/>和<ml-adapters:action-event-adapter/>另外配置。

 

 

 

              2.service：module-loader配置

 

[html] view plain copy  

1. <services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >  
2. <ml-factories:class-modules>  
3.     <ml-factories:search-packages type="$1" packages="com.alibaba.sample.petstore.web.store.module.*" />  
4. </ml-factories:class-modules>  
5. < ml-factories:factory class="com.alibaba.sample.petstore.web.common.factory.AjaxAdapterFactory"/>  
6. </services:module-loader>  

                cacheEnabled：表示查找的时候使用缓存

 

                includeDefaultAdapters：表示是否使用默认的Adapter，默认为true

 

最后欢迎大家访问我的个人网站：1024s