Skip to main content

[AS3] pureMVC Utility - WidgetsConsole 1.0.0


Project Name: pureMVC Utility - WidgetsConsole
Version: 1.0.0
Project Owner: Erin Lin
Description: An utility is under pureMVC Multicore that has Flex only and AS3 two versions.
Demo: WidgetsConsole Live Demo with source code
Demo source code
Download: WidgetsConsole Open Source Project Home
pureMVC website: http://puremvc.org/



沒想到我第一個 google code open source project 就獻給 pureMVC 了...

套用 pureMVC 到 Flex 專案第一個遇到的問題就是 view components 的控制,Flex 專案的 view 總類太多:有 Modules, UIComponent, external swf and pop-up view...etc. 整個專案作下來光 view 就可能換上幾十個頁面,先前分享了運用 StateMachine 來處理 view 的轉換,中大型專案作下來 code 的複雜度也是非常可觀。我在今年二月分享了 [Flex] pureMVC MultiCore with Modules 就開始著手將其概念包裝成 pureMVC 的工具包,使用到目前為止整個架構還是挺完善,所以在這邊與大家分享。

WdigetConsole 顧名思義是「 相同目的 views 組合 = Widget 」 的中央控制中心,將程式內加入 WidgetsConsole 的 widget 統一控管,最終只需要 sendNotification 就可以達到 view 的新增跟刪除(因為我是懶人工具的愛好者,懶人工具的定義就是以最低的限度達到所需要的效果,所以這個工具包的自由度很高!)

以下是簡單講解 WidgetsConsole 是什麼:

Widget 的定義: View component(s) + WidgetMediator + WidgetCommand
實作的 WidgetCommand:SimpleCommand 會掌控相關 views, proxies, commands 的註冊與移除。你可以發現上次在 pureMVC + StateMachine 文章中,Erin 建議將一個 view 的相關 Mediators, Proxies , Commands 都用一個 Command 來控制建立與刪除,其重點就是"只"讓一個 Command 掌握一個 views 組合的所有細節。

Interfaces: 想要自動化,介面是不可缺少的
  1. IWidgetShell:所有放置 Widget 的 DisplayObjectContainder 都需要實作。
  2. IWidget:view component or modules 只要需要被中央控管的 views 都要實作 IWidget
  3. IWidgetInfo:定義傳遞的 Value Object 介面


IWidgetShell 的實作
可以 extends 任何的 DisplayObjectContainder Class 來實作 IWidgetShell 介面,當然也可以參考 Live Demo 內的 AssignShell 寫法製作。如果你很在意巢狀容器的話,請避免使用 DisplayObjectContainder Class 來實作 IWidgetShell 介面。

WidgetCommand:SimpleCommand
寫法跟一般寫 Command 沒兩樣,差別在 execute 中只處理 WidgetsConsole.CREATE_WIDGET and WidgetsConsole.DESTROY_WIDGET。
  1. WidgetsConsole.CREATE_WIDGET:處理所有相關 View, mediator, proxies 的註冊,統一在此處理 view component 的 WidgetsConsole.ADD_WIDGET_TO_SHELL

    sendNotification(
    WidgetsConsole.ADD_WIDGET_TO_SHELL,
    widget:IWidget,
    ShellName:String
    );

  2. WidgetsConsole.DESTROY_WIDGET:處理所有相關 View, mediator, proxies 的刪除
    需要在此處理 view component 的 WidgetsConsole.REMOVE_WIDGET_FROM_SHELL

    sendNotification(
    WidgetsConsole.REMOVE_WIDGET_FROM_SHELL,
    widget:IWidget,
    ShellName:String
    );



How to Inject WidgetsConsole?
inject 函式的命名寫法參考自 pureMVC Utility - StateMachine

var wc:WidgetsConsole = new WidgetsConsole();
wc.inject( this.multitonKey );
wc.registerWidget( widgetName:String, command:Class );
//在這邊將做好的 WidgetCommand 註冊
wc.registerShell(name:String, shell:IWidgetShell);
//註冊 shell,由於 shell 是一個 IWidgetShell 實體,所以在實體被移除前一定要執行 removeShell


Widget 的呼叫:

sendNotification(
WidgetsConsole.CREATE_WIDGET,
new WidgetInfo( widgetName:String , mediatorName:String , targetShellName:String , moduleURL:String = null, attachment:Object = null )
);

mediatorName 由外部指定才能讓同一個 Widget 有不同的 Instances, 也可以將之 push 到不同的 shell 內。請參考 Live Demo

這邊的 moduleURL:String 欄位請自由運用,在 WidgetCommand 內可以藉由 IWidgetInfo.getURL() 取得,由於一開始 Erin 就是針對 Flex 開發出這個工具包,所以 IWidgetInfo 並沒有分版本;AS3 版本只是將 Module 相關拿掉而已。
*Edit:10.26,2009 筆誤... moduleURL:String 寫成 targetShellName:String...

LazyWidget 的呼叫:懶人 widget,WidgetMediator and WidgetCommand 已由 WidgetsConsole 提供
只有 ViewUI 的 Widget,單純展示畫面,多為測試用。 inject WidgetsConsole 的時候 registerLazyWidget(),才可以使用。

sendNotification(
WidgetsConsole.CREATE_WIDGET,
new WidgetInfo( WidgetsConsole.LAZY_WIDGET , mediatorName:String , targetShellName:String , moduleURL:String =null, viewUIInstance:IWidget )
);
//*Edit:10.26,2009 筆誤... moduleURL:String 寫成 targetShellName:String...
//attachment 欄位直接帶入 IWidget


Widget 的刪除

//刪除全部 Widgets
sendNotification(WidgetsConsole.DESTROY_ALL_WIDGETS);

//刪除指定 shell 內所有的 Widgets
sendNotification(WidgetsConsole.DESTROY_WIDGETS_BY_SHELL, shellName:String );

sendNotification(WidgetsConsole.DESTROY_WIDGET, mediatorName:String );
//刪除特定 Widget


Module 專區 - Flex only version

ModuleWidget 的呼叫:外部 ModuleWidget 共用,WidgetMediator and WidgetCommand 已由 WidgetsConsole 提供
需要在 inject WidgetsConsole 的時候順便 registerModuleWidget(),才可以使用。

sendNotification(
WidgetsConsole.CREATE_WIDGET,
new WidgetInfo( WidgetsConsole.MODULE_WIDGET , mediatorName:String , targetShellName:String , moduleURL:String , attachment:Object = null )
);
//WidgetsConsole 會將 attachment:Object 送到 Module.data,所以需要直接寄到 Module 的參數可以利用 attachment 傳送。



Module 專用的 broadcast to Global Notification:WidgetsConsole.MODULE_SENDER
發出通知後會自動轉變成 「WidgetsConsole.BROADCASTING 」到 System facade ,也會順便轉發出 「WidgetsConsole.MODULE_RECEIVER」 送進"其他"的 ModuleWidget(自己發送的 Notification 就不會接收),所以 WidgetsConsole.BROADCASTING 請謹慎使用...

sendNotification( WidgetsConsole.MODULE_SENDER , body:Object , type:String );
//body is an Object...可以放任何你想要傳出去的物件~~萬物皆物件啊!


Module 外部資料接收器:WidgetsConsole.MODULE_RECEIVER

override public function listNotificationInterests():Array
{
return [
WidgetsConsole.MODULE_RECEIVER
];
}
override public function handleNotification(notification:INotification):void
{
//就是處理你要的東西
}


Module remove Notification:WidgetsConsole.MODULE_REMOVE
不管是由 Module 發出 WidgetsConsole.MODULE_REMOVE,又或者從 System facade 發出 WidgetsConsole.DESTROY_WIDGET 都會送出 WidgetsConsole.MODULE_REMOVE 讓 Module facade 收聽,所以請記得在 Module's ApplicationFacade 內註冊 WidgetsConsole.MODULE_REMOVE Command,並將此 Module 在移除時需要清除的東西寫在此 Command 內。

sendNotification( WidgetsConsole.MODULE_REMOVE );
// remove self



其實目前 mx.modules.ModuleManager 有要命的 memory leak bug...建議現階段還是少用 Module 比較安全。這也是我使用 RSL(Runtime Shared Library) 來處理專案的主要原因,Module 只用來實作非主要的 view componet。

想要取得你所載入的 Module's ModuleInfo 去執行 unload() 的話,請利用 ModuleManager.getModule(url):IModuleInfo 來取得,關於這點我沒有在 WidgetsConsole 內處理的原因是:不管 ModuleInfo 有沒有執行 unload,其 ModuleInfo 還是會剩下一個實體不被回收,可能的原因是 ModuleManager 內的 inner class ModuleManagerImpl 有個 moduleList 在 ModuleInfo.unload 的時候並沒有順便清掉其 reference,當然也可能還有其他的因素。既然有沒有 unload 都沒差別那就不需要特別處理它了...=)

Comments

  1. 還能說什麼呢...這真的太有大愛了!

    ReplyDelete
  2. 我在live demo with source code連結找不到source code呀~

    ReplyDelete
  3. 有阿....滑鼠按右鍵不是有 view source...

    ReplyDelete
  4. 報告^^
    沒有看到view source捏~~~

    ReplyDelete
  5. 看情況好像被 Hinet 的垃圾廣告 JS 擋起來了....等我有空的時候再去查解法來解決~~- -....

    ReplyDelete
  6. 阿咧...今天看的時候 online Demo 的 View source 又可以開了...= =

    ReplyDelete

Post a Comment

Popular posts from this blog

[Swift3] weak 與 unowned 關鍵字

雖然在 Swift 中看起來"很像"是不需要煩惱內存管理的問題,不過實際上它還是遵循著自動引用計數 (ARC) 的規則,當一個物件沒有被其他對象引用時會自動被銷毀,如果三魂七魄沒有完全回位的話,就會有個靈體留在現世的空間裡,最經典的範例如下:
閉包(Closure)引用
classClassA {

typealias Complete = ()->()

var name : String
var onComplete : Complete?

init(_ name: String){
self.name = name
print("Hello I am \(self.name)")

onComplete = {
print("\(self.name): onComplete!") // --> 閉包引用 self, 計數 + 1
}
}

deinit {
print("deinit: \(self.name)")
}
}

var a : ClassA? = ClassA("A") // --> 引用計數 + 1
a = nil // 2-1 = 1 還剩下 1 所以沒辦法銷毀

---output-------
Hello I am A

由於這邊的 onComplete 宣告為 Optional, 正確的做法要連同 onComplete 一起刪除才可以被回收,若不是 Optional 則會進入無法回收狀態:

var b : ClassA? = ClassA("B")
b?.onComplete = nil // --> 還好是 Optional 可以設成 nil 計數 - 1
b = nil // 計數 = 0 所以被回收

---output-------
Hello I am B
deinit: B

但是做人不需要煩惱太多,這時候就出動 unowned 關鍵字讓物件可以順利被回收:

onComplete = { [unowned self] in
print("\(self.name): onComplete!") // …

PureMVC 我也會 [1]

為什麼要學 PureMVC ? 明明網路上一堆免費的 MVC 微型框架,為什麼 Erin 特別愛用 PureMVC?
嚴格說起來,使用 PureMVC 開發的專案寫出來的 class 檔一定比 一些簡化版 PureMVC base 的 framework 如 Robotlegs 多,也比較難入門,但是為什麼要特別推薦它?

答案很簡單,越基本的東西反而是最好延伸,留白越多的紙最好畫!也因為如此才令人著迷啊...(咦?)

百分百真情推薦:
大家的職責切分的很乾淨...棒訊息傳遞機制是好物由於架構超然於 Flash / Flex 架構上,反而在 team work 分工的時候更方便擁有多個程式語言的版本,想要入門其他語言是個不錯的選擇Source code 公開化,要改要加什麼隨便你~~出來的時間比較久相關資源多
接下來就來看圖說故事。
PureMVC Diagram, 出處:PureMVC 官網

當初第一眼看到這張圖的時候,真的挺像個變形蟲,不過想要快速了解 framework 的基本運作流程,最容易的方法就是看圖說故事...

PureMVC 核心是由四個單例(singleton design pattern) 組成: Facade, Model, View and Control,唯一出入口就是 Facade,你會發現圖示中 Model, View and Control 都是雙向指向連接到 Facade,它們互相不清楚其他人的存在。

這四個 Class 你也只需要認識 Facade 即可...=)

Facade :
圖示中, Facade 下方有三個圈圈分別是 Mediator, Command and Proxy,意思是所有實作這三種 class instance 都是透過 Façade 來註冊移除或取用其他資源。拿 Flash 來比喻, Facade 很像是 root,所有的 DisplayObject 顯示、操作和移除都可以透過 root 抓取實體後執行,所有實體都可以透過 root 去找到其他實體。在 PureMVC 中, 它最大的作用就是切開 MVC 彼此的依賴,也提供 user 一個統一的操作出入口。

Model, View and Control
你會發現這三個大圈圈旁邊都有一堆同色的 Proxy, Command and Mediator,當各自的 class inst…

PureMVC 我也會 [0]

最近感覺 PureMVC 又熱了起來,也剛好好久沒有更新文章了,
就順便將去年底做的企業內訓 PureMVC 課程部分整理寫出來,

要講 PureMVC 當然要先從啥是 MVC 講起:

Model-View-Control
出處:維基百科 MVC,大概節錄一段:
(控制器Controller)- 負責轉發請求,對請求進行處理。(檢視View) - 介面設計人員進行圖形介面設計。(模型Model) - 程式設計師編寫程式應有的功能(實作算法等等)、數據庫專家進行資料管理和數據庫設計(可以實作具體的功能)。
其實到 Flash 的世界來講,Model and Control 都是由 .as 處理,而 View 便是 .fla+.as ,為了要鬆綁之間的關係,Event 機制就相當重要。其實每個人對 MVC 的最佳解釋都不同,真的要多練習才會有所領悟。

簡單來說:

Model = 餐廳廚房
data: 西餐類
action:依照點菜單做餐點
action: 做完餐點就是將餐點放在出菜口按下通知鈴等服務生來


Control = 服務生
action: 聽到大門歡迎鈴就要說「歡迎光臨」
action: 看到客人揮揮手要去收點菜單
action: 聽到廚房通知鈴看是哪桌的餐點去送菜


View = 餐廳外場
view: 田園式的西餐廳裝潢
action: 客人進門會有歡迎鈴
action: 客人揮揮手叫服務生過來服務,是哪個服務生都無所謂,重點只要會收點菜就行了。
action: 客人收到餐點準備開動

當餐廳要改成外炒店,這時候只需要將大廚換成會中餐廚師,其出的菜就是中式快炒。
當餐廳外場由田園式外觀重新裝潢成華麗感夜店風,其進門的客層也會有所不同。

重點就是當你換掉一個地方時,對其它的部份不會造成太大的影響或者根本無所謂,這就是 MVC 所講求的境界...

一般來說,小專案有沒有必要使用 MVC 就是由各位自己判斷了,當你習慣將程式切分開來,發現 debug 不是一件痛苦的事情時,這時候有沒有強制使用 MVC 倒不是重點,因為你已經養成良好的撰寫習慣。但是開始接觸大型專案配合 team work 時,在沒有一個共用的核心框架前提下,這個專案開發到最後一定會是一個多手多腳的怪物,共用核心框架的價值就在這邊展現,這也是為什麼一堆微型 MVC 框架的產生,也讓各位不得已…