2016年4月17日 星期日

ZK 教學 - 瀏覽器頁籤 (tab) 被關掉後進行處理

如果你想要在 browser tab 關掉時去執行一些應用程式邏輯,例如清理資料等等。我們可以傾聽 browser tab 關掉的事件,這件事等同於 ZK 的 desktop 被移除。 ZK 提供一個 DesktopCleanup listener讓你可以傾聽任何一個 desktop 被移除的事件,所以只要發現你所關注的那一頁的 desktop 被移除了,那就是該 tab 被關掉了,你可以在該 listener 中實作你的應用程式邏輯。範例如下:

import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Desktop;
import org.zkoss.zk.ui.select.SelectorComposer;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zk.ui.util.DesktopCleanup;
import org.zkoss.zul.Div;

public class CloseComposer extends SelectorComposer<Component> {

    @Wire
    Div root;

    @Override
    public void doAfterCompose(Component comp) throws Exception {
        super.doAfterCompose(comp);
        //or register in zk.xml
        getPage().getDesktop().addListener(new MyDesktopCleanupListener());
    }

    @Listen("onClick = #exit")
    public void processAfterExit(){
        System.out.println("processAfterClose " + root.getId());
    }

    class MyDesktopCleanupListener implements DesktopCleanup{

        @Override
        public void cleanup(Desktop desktop) throws Exception {
            // 或根據 desktop.getRequestPath() 來判斷是哪一頁被關掉
            if (getPage().getDesktop().equals(desktop)){
                processAfterExit();
                System.out.println(desktop.getRequestPath());
            }
        }

    }
}

ZK 教學 - 常見錯誤用法 05 - 用 @NotifyChange 通知 ListModel 改變

以 MVVM 方法開發時,我們通常必須要用 @NotifyChange 來通知 ZK ViewModel 中的某個特定 property 更改了,這時 ZK 會重新載入該 property 去更新畫面。但是若是使用 ZK 提供的 ListModel 的實作物件則有例外 (e.g. ListModelList),因為 ZK 元件都會傾聽 ListModel 的變動,因此如果你改變其內容,元件都會知道並只 render 差異的部分,並不需要被通知。

這時若是加上 @NotifyChange 有什麼壞處呢?它反而會使 ZK 重新載入整個 ListModel 並 re-render 其中所含有的資料,如此一來,比起元件內建的機制只 render 差異部分還來得更沒效率。

2016年3月27日 星期日

ZK 教學 - 常見錯誤用法 04 - 使用不正確的分享範圍

ZK 中除了提供 Java EE 標準的共享範圍: application, session, request 之外,還提供 desktopcomponent 範圍。你可透過相對應的範圍物件並呼叫 setAttribute(key, value) 把資料存進去,並在同一個範圍內透過 getAttribute(key, value) 把資料取出來,是很常見的資料傳遞、分享方法。存資料在恰當的範圍,才能共享資料給適當的對象,也不會影響別人的狀態,或產生不必要的垃圾資料。簡介一下 ZK 才有的範圍 (scope):

  • desktop : 大部份情形你可以把這個範圍看作是一個瀏覽器的 tab,同一個 tab 下的元件都屬於同一個 desktop。每次重新載入 (reload) 頁面會重新產生一個新的 desktop。
  • component: 要取得該元件的 reference 才能取得其上的資料,通常是用來存該元件才會使用的暫存資料。
  • execution: 這是 ZK 的名詞,指得其實就是 request。只是因為 ZK 要求 zul 的 HTTP request 跟透過 AJAX 發的 HTTP request (通常是 event)有不同的處理方式,但是要通用化兩者,畢竟都是 HTTP request, 就用 Execution 物件封裝兩種不同的 request。

建議用法如下:

  • 只使用足夠的、最小的範圍共享。如果可以透過 desktop 共享,就不要透過 session。
  • 使用 ZK 開發時,一般會將多個相關的功能實作在同一頁 (這也是使用 AJAX 開發應用程式的常態),所以大部時候,跟頁面相關的資料只需要存在 desktop 範圍就夠了。如果存在 session ,要注意其會影響所有同一個瀏覽器下的 tab。
  • 要注意使用 application 及 session scope 的 event queue 會自動啟動 server push。

2016年3月25日 星期五

ZK 教學 - 常見錯誤用法 03 - 過度使用複雜元件

每個 ZK 元件都會在瀏覽器產生對應的 HTML element ,有些很複雜、有些較簡單,當然越複雜的 HTML 對瀏覽器記憶體、效能的負擔就越大。所以沒有必要時,不要選擇成本較高的元件。

例如只是要把某一群元件包在一個區域,也許要插入新元件或是整群處理時,可以用 <div> 就好,而不要用 <window>

如果只是要將多個元件水平排列,而並不需要控制其對齊位置的時候,則應該使用 <hlayout>即可,而不需要用 <hbox>。同樣的道理,簡單的垂直排列需求可以用 <vlayout> 完成而不需用 <vbox>

以一個內含兩個元件的 <hbox> 為例:

    <hbox>
        <div>hbox</div>
        <div>hbox</div>
    </hbox>

其所產生的 HTML 如下:

<table id="zFLQ5" class="z-hbox" cellpadding="0" cellspacing="0"
    border="0">
    <tbody>
        <tr valign="top">
            <td id="zFLQ5-frame" style="width:100%;height:100%"
                align="left">
                <table id="zFLQ5-real" height="100%" cellpadding="0"
                    cellspacing="0" border="0" style="text-align:left">
                    <tbody>
                        <tr valign="top">
                            <td id="zFLQ6-chdex" style="height:100%">
                                <div id="zFLQ6" class="z-div">
                                    <span id="zFLQ7" class="z-label">
                                        hbox
                                    </span>
                                </div>
                            </td>
                            <td id="zFLQ6-chdex2"
                                class="z-hbox-separator">
                                <img style="height:0;width:0"></td>
                            <td id="zFLQ8-chdex" style="height:100%">
                                <div id="zFLQ8" class="z-div">
                                    <span id="zFLQ9" class="z-label">
                                        hbox
                                    </span>
                                </div>
                            </td>
                        </tr>
                    </tbody>
                </table>
            </td>
        </tr>
    </tbody>
</table>

若是以一個同樣內含兩個元件的 <hlayout> 來比較如:

    <hlayout>
        <div>hlayout</div>
        <div>hlayout</div>
    </hlayout>

其所產生的 HTML 就小很多:

<div id="zFLQ0" class="z-hlayout">
    <div id="zFLQ1-chdex" class="z-hlayout-inner"
        style="padding-right:5px">
        <div id="zFLQ1" class="z-div">
            <span id="zFLQ2" class="z-label">hlayout</span>
        </div>
    </div>
    <div id="zFLQ3-chdex" class="z-hlayout-inner" style="">
        <div id="zFLQ3" class="z-div">
            <span id="zFLQ4" class="z-label">hlayout</span>
        </div>
    </div>
</div>

2016年3月21日 星期一

ZK 教學 - 常見錯誤用法 02 - 存取別的 Desktop 中的元件

ZK 中 Desktop 的概念約略等同一個 browser tab,每個元件都會歸屬某個特定的 Desktop,而 ZK 的一個元件在實作上其實是由前端的 widget 加上後端的 Java 物件兩兩一組構成。我們是透過操作後端 Java 元件來操作前端 widget。這個從屬關係不能被打亂,否則 操作 Java 物件若找不到對應的前端 widget 就會產生錯誤。

所以,如果你存取到另一個 Desktop 的元件,例如呼叫該元件的 setter ,這時候理當元件要透過 HTTP response 去控制前端的 widget,但 如果 ZK 發現現在的 Destkop 跟元件的原所屬的 Desktop 不相同,就會拋出以下例外

java.lang.IllegalStateException: Access denied: component, <Listcell z_27_b53>, belongs to another desktop: [Desktop g272]

這種情形可能發生在:

  • 你將指向某個元件的變數透過 event queue 傳到 Desktop scope 以外,例如 session or application scope,並且在另一個 Desktop 存取該元件

解決方法:
傳遞資料本身,而不要傳元件。例如我要把 page1.zul 中的 Textbox 輸入值,傳到另一個 page2.zul 中做處理,這時就不應該把 Textbox 直接當參數傳出去,而是把 Textbox.getValue() 傳出去。

  • Composer 中有一個指向元件的變數是 static

解決方法:
不要將指向元件的變數宣告成 static

2016年3月12日 星期六

ZK 教學 - 常見錯誤用法 01 - 操作元件而不是其 model

好幾個 ZK 元件都支援以一個 model 物件為基礎來繪製其內容,例如 Listbox, Grid, Tree, Tabbox, Combobox。這種情況下,必須要以控制該 model 來控制元件的 rendering、選擇模式 (single or multiple choice)、被選定的項目 (selected items),而不是直接透過元件的 API 。

以下是常見的例子:

  • 要將 Listbox 設定成多選,應該要用 ListModel.setMultiple(true) 而不是 Listbox.setMultiple(true)
  • 要刪掉某一個 Listitem,應該是刪掉 ListModel 中對應的資料物件,而不是直接呼叫Listitem.detach()
  • 點選 Tabbox \ Tab 上的關閉按鈕時,不會關掉 Tab,因為其移除是要由 Model 控制。
  • 使用 TreeModel 時,要展開 Tree 上某個節點,要透過 TreeOpenableModel.addOpenPath() (or DefaultTreeModel.()) 而不是 Treeitem.setOpen()

什麼時候可以直接呼叫元件 API 來控制呢?就是你沒有給 Model 物件的時候。

2016年3月5日 星期六

ZK 教學 - 使用 MVC 或 MVVM?

不管是現在剛開始接觸 ZK 或是用過一陣子的人都可能會遇到的問題是到底要用 MVC 或 MVVM 的方式開發。從 ZK 8 之後又把 MVVM 的能力更佳的擴展,所以 MVVM 會是一個功能更強的開發方式。但 MVC 在使用上比較直覺,仍有其優勢,所以我想決定性的因素會比較是開發者的偏好專案的特性。你可參考下面的比較來決定哪種方式比較適合你。

優勢比較

MVVM

  • ViewModel 較不易受畫面變動影響。
    • 因為 ViewModel 沒有變數直接指向 ZK 元件,因此若是畫面上有元件更改,ViewModel 一般不需要修改
  • ViewModel 較易於在不同頁面中重用。
    • 因為 ViewModel 只包含資料跟業務邏輯,若是不同頁面需要的資料跟業務邏輯相同,就可以重用同一個 ViewModel
    • 例如 A 頁面按按鈕執行搜尋,B 頁面點選單執行同樣的搜尋,則可以重用同一個 ViewModel 中的 command,只是兩個頁面 data binding 寫在不同的元件上。
  • 畫面較易於重用(易於模組化)。
    • 透過 shadow component 跟 template 機制,可以將一段頁面的片段做成可以接受傳入參數
  • 易於套用美工所設計的畫面,或是網路上現成的元件。
  • 易於整合第三方 javascript library 或 widget。
    • 因為 ZK 8 提供了一個可以讓你透過 javascript 去呼叫 ViewModel 中的 command (client side binding) 的方式來跟後端溝通
  • ViewModel 的可測試性較好。
    • 因為 ViewModel 不需要繼承特定類別跟實作特定介面,可以輕易地執行單元測試

MVC

  • 操控元件方式直覺好學、易懂。
    • MVVM 控制元件較不直接,需要了解 zk framework data binding 的行為
  • 可以完全使用元件所提供的所有 API。
    • 仍有極少部分 ZK 元件行為沒辦法用 MVVM 控制。例如產生 Messagebox, Listbox.renderAll(), Popup.open()。但這都可以改用直接控制元件的方式來解決,只是就是非 MVVM 的方法,喜歡維持一致的開發模式的人可能不會喜歡
  • 易於控制客製化元件
    • 這裏是指透過繼承既有元件的 java class 所創造出來的客製化元件,若要能以 MVVM 方式控制,還必須要額外加上 data binding 的設定

比較簡表

MVC MVVM
controller 與畫面的耦合程度 較高 不耦合
如何實作 controller 需繼承ZK的SelectorComposer 不需繼承特定類別或實作特定介面的一個 Java class (POJO)
如何控制 UI 元件 透過元件的 API 透過 data binding
更新 UI 的方式 直接操作元件 透過 ZK 內建機制自動更新(需加上 @NotifyChange)
元件控制的精細程度 很精細,可以完全控制 主要控制元件 attribute
整合後端其他服務的方式 在 controller 中直接呼叫 在 controller 中直接呼叫

參考資料: