(1)總覽
1.什麼是Module
Module相當於controller,是用來處理邏輯的,target映射之後可以找到對應的Module來執行。
一般情況下(類都是java編寫),相當於一個用來處理邏輯的java類
不使用AdapterFactory的情況下,Module都要實現Module,Module接口如下:
public interface Module {
/** 執行模塊。 */
void execute() throws Exception;
}
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.接口
public interface ModuleLoaderService {
/** 取得當前factory所支持的所有module類型。 */
Set<String> getModuleTypes();
/** 取得指定module類型的所有module名稱。 */
Set<String> getModuleNames(String moduleType);
/** 取得指定名稱和類型的module實例。 */
Module getModule(String moduleType, String moduleName) throws ModuleLoaderException, ModuleNotFoundException;
/**
* 取得指定名稱和類型的module實例。
* <p>
* 和<code>getModule()</code>不同的是,該方法不會拋出<code>ModuleNotFoundException</code>
* 。如果模塊不存在,則返回<code>null</code>。
* </p>
*/
Module getModuleQuiet(String moduleType, String moduleName) throws ModuleLoaderException;
}
2.成員變量
public class ModuleLoaderServiceImpl extends AbstractService<ModuleLoaderService> implements ModuleLoaderService,
ProductionModeAware {
private Map<ModuleKey, Module> moduleCache = createConcurrentHashMap();
private boolean productionMode = true;
private Boolean cacheEnabled;
private ModuleFactory[] factories;
private ModuleAdapterFactory[] adapters;
...
}
可以看出其中存儲了ModuleFactory和ModuleAdapterFactory 3.關鍵方法
public Module getModuleQuiet(String moduleType, String moduleName) throws ModuleLoaderException {
....
// 從factory中裝載
Object moduleObject = null;
Module module = null;
for (ModuleFactory factory : factories) { //從多個Factory中查找
moduleObject = factory.getModule(moduleType, moduleName);
if (moduleObject != null) {
break;
}
}
// 通過適配器轉換接口
if (moduleObject != null) {
if (moduleObject instanceof Module) {
module = (Module) moduleObject; // 假如moduleObject直接實現了接口
} else { //如果沒有則進行適配
for (ModuleAdapterFactory adapter : adapters) {
module = adapter.adapt(moduleType, moduleName, moduleObject);
if (module != null) {
break;
}
}
}
}
...
return module;
}
核心代碼如上:即先從factory中查找Module,然後進行適配轉換 4.總結
ModuleLoaderService就是一個高層接口,利用ModuleFactory和ModuleAdapterFactory實現加載並適配Module的功能
(3)ModuleFactory
1.接口
/**
* 用來創建modules的工廠。
*
* @author Michael Zhou
*/
public interface ModuleFactory {
/** 取得當前factory所支持的所有module類型。 */
Set<String> getModuleTypes();
/** 取得指定module類型的所有module名稱。 */
Set<String> getModuleNames(String moduleType);
/**
* 取得指定名稱和類型的module實例。
* <p>
* 如果未找到,則返回<code>null</code>。
* </p>
*/
Object getModule(String moduleType, String moduleName) throws ModuleLoaderException;
}
2.關鍵方法 public Object getModule(String moduleType, String moduleName) throws ModuleLoaderException {
Map<String, ModuleInfo> typedModules = modules.get(moduleType);
if (typedModules == null) {
return null;
} else {
ModuleInfo module = typedModules.get(moduleName);
if (module == null) {
return null;
}
if (!beans.containsBean(module.getBeanName())) {
return null;
}
try {
return beans.getBean(module.getBeanName()); //獲取Module
} catch (Exception e) {
throw new ModuleLoaderException("Failure loading module: " + moduleType + ":" + moduleName, e);
}
}
}
其中modules爲Map<String,ModulteInfo>,其中存儲了Module的信息,內容如下[screen={multievent.SayHello2=Module {
type:name = screen:multievent.SayHello2
beanName = module.screen.multievent.SayHello2
source = my_test.understand.app1.module.screen.multievent.SayHello2
}, simple.Download=Module {
type:name = screen:simple.Download
beanName = module.screen.simple.Download
source = my_test.understand.app1.module.screen.simple.Download
}, form.Welcome=Module {
type:name = screen:form.Welcome
beanName = module.screen.form.Welcome
source = my_test.understand.app1.module.screen.form.Welcome
}},
action={RegisterAction=Module {
type:name = action:RegisterAction
beanName = module.action.RegisterAction
source = my_test.understand.app1.module.action.RegisterAction
}}, null]
key爲ModuleType,即screen、action等,ModuleInfo保留了Module必要的信息,如beanName,source等
最終的Module實際上還是通過beanFactory來獲取的
(4)ModuleAdapterFactory
1.接口
public interface ModuleAdapterFactory {
/** 將對象轉換成module接口。 */
Module adapt(String type, String name, Object moduleObject) throws ModuleLoaderException;
}
2.DataBindingAdapterFactorypublic class DataBindingAdapterFactory extends AbstractDataBindingAdapterFactory {
public Module adapt(String type, String name, Object moduleObject) {
ModuleInfo moduleInfo = new ModuleInfo(type, name);
Class<?> moduleClass = moduleObject.getClass();
Method executeMethod = getMethod(moduleClass, "execute");
if (executeMethod != null) {
FastClass fc = FastClass.create(moduleClass);
FastMethod fm = fc.getMethod(executeMethod);
// 對於action,可被“跳過”執行。
boolean skippable = "action".equalsIgnoreCase(type);
return new DataBindingAdapter(moduleObject, getMethodInvoker(fm, moduleInfo, skippable));
}
return null;
}
}
可以看出只支持execute方法3.AbstractModuleEventAdapterFactory
public abstract class AbstractModuleEventAdapterFactory<A extends AbstractModuleEventAdapter>
extends AbstractDataBindingAdapterFactory implements ApplicationContextAware {
private static final String DEFAULT_EVENT = "perform";
private static final String PRE_HANDLER = "beforeExecution";
private static final String POST_HANDLER = "afterExecution";
private ApplicationContext context;
....
}
這種ModuleAdapterFactory可以支持do開頭的方法,並且默認方法是doPerform,開始前可以執行beforeExecution,結束後可以執行afterExecution
(5)webx-xx.xml使用配置
1.最簡單配置
<services:module-loader>
<ml-factories:class-modules>
<search-packages type="$1" packages="com.alibaba.sample.petstore.web.home.module.*" />
</ml-factories:class-modules>
</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屬性
</ml-factories:class-modules>
表示模塊是使用classes生成的module,對應ClassModuleFactory
如果是使用script生成的Module,可以使用<ml-factories:script-modules>,對應ScriptModuleFactory
如果使用自定義的ModuleFactory,那麼使用<ml-factories:factory >
2.adapter配置
<services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >
<ml-adapters:data-binding-adapter/>
<ml-adapters:action-event-adapter/>
<ml-adapters:adapter class=" com.alibaba.sample.petstore.web. common .adapter.AjaxAdapterFactory"/>
</services:module-loader>
data-bing-adapter綁定了DataBindingAdapterFactory,action-event-adapter綁定了ActionEventAdapterFactory,adapter綁定了自定義的Adapter 3.service:module-loader配置
<services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >
<ml-factories:class-modules>
<ml-factories:search-packages type="$1" packages="com.alibaba.sample.petstore.web.store.module.*" />
</ml-factories:class-modules>
< ml-factories:factory class="com.alibaba.sample.petstore.web.common.factory.AjaxAdapterFactory"/>
</services:module-loader>
cacheEnabled:表示查找的時候使用緩存
includeDefaultAdapters:表示是否使用默認的Adapter,默認爲true。當爲true時,會自動加載DataBindingAdapterFactory、ActionEventAdapterFactory,所以可以不需要再用<ml-adapters:data-binding-adapter/>和<ml-adapters:action-event-adapter/>另外配置。
2.service:module-loader配置
<services:module-loader cacheEnabled="true" includeDefaultAdapters=" false" >
<ml-factories:class-modules>
<ml-factories:search-packages type="$1" packages="com.alibaba.sample.petstore.web.store.module.*" />
</ml-factories:class-modules>
< ml-factories:factory class="com.alibaba.sample.petstore.web.common.factory.AjaxAdapterFactory"/>
</services:module-loader>
cacheEnabled:表示查找的時候使用緩存
includeDefaultAdapters:表示是否使用默認的Adapter,默認爲true