在RCP程式中,實現可擴充性和可插入性的主要手段就是建立自訂擴充點,當然軟體自身也要設計得當才行。本節就以給SMS項目的功能導航器增加一個結點為例,示範如何建立自訂擴充點,最終效果33.3所示。 圖33.3
增加一個自訂擴充點將以下語句加入到plugin.xml檔案,就可以建立一個擴充點。33.4所示,在外掛程式清單編輯器的“擴充點”介面會多出一項。<extension-point id="navigators" name="Navigator Tree Entries"/>“擴充點”介面
使用自訂擴充點使用自訂擴充點和使用Eclipse內建的擴充點沒有什麼本質區別,關鍵是該擴充點需要設定哪些資訊。回顧功能導航器的樹結點,它是由NavigatorEntry類負責,該類有6個 屬性: ● name:結點名稱。 ● image:結點的表徵圖。 ● parentEntry:父結點。 ● children:子結點集合。 ● editorInput:結點對應編輯器的EditorInput。 ● editorId:編輯器對應於plugin.xml中的Id值。為了簡化樣本,暫且只提供name和image設定資訊,而這已足夠讓結點顯示在功能導航器中了。將以下擴充點的使用語句加入到plugin.xml檔案中。<extension point="cn.com.chengang.sms.navigators"> <navigator class="cn.com.chengang.sms.navigator.PluginNavigatorEntry" icon="icons/project.gif" name="擴充的結點"/></extension> 說明: ● 定義擴充點用“extension-point”,使用擴充點用“extension point”,兩者有細微差別。 ● 原來的定義擴充點的ID標識為navigators,使用時則要加上外掛程式ID作為首碼,即cn.com.chengang.sms.navigators。 ● plugin.xml本質上只是一個XML檔案,class可以改為class1,icon也可以改為image。但是這樣修改之後,後面的讀取plugin.xml設定資訊的程式碼也要相應改動,一般來說,盡量取Eclipse中約定俗成的名稱。
建立擴充點定義的類PluginNavigatorEntry代碼如下:package cn.com.chengang.sms.navigator;public class PluginNavigatorEntry extends NavigatorEntry {}這個類繼承了NavigatorEntry結點類,在實際開發中可以加入一些應用所需的代碼。這裡作為樣本,沒有必要再加代碼了。
讀取擴充點定義的資訊在plugin.xml定義好了擴充點,也建立好了相關的類,而本步的關鍵是讀出plugin.xml中自訂擴充點的設定資訊,並據此來建立樹結點執行個體。將以下代碼加入到SmsFactory類。//取得plugin.xml中的自訂結點,加入到一個List集合中private static List<ITreeEntry> getPluginNavigator() { List<ITreeEntry> result = new ArrayList<ITreeEntry>(); // 從plugin.xml中取出自訂擴充點navigators的資訊 IExtensionRegistry registry = Platform.
getExtensionRegistry(); IExtensionPoint extension = registry.getExtensionPoint("cn.com.chengang.sms.navigators"); if (extension == null) return Collections.
emptyList(); // 取出plugin.xml中所有使用navigators擴充點的配置資訊 IConfigurationElement[] configElements = extension.getConfigurationElements(); for (IConfigurationElement ce : configElements) { try { // 根據配置資訊的class屬性,建立所定義的類的執行個體 NavigatorEntry navigator=(NavigatorEntry) ce.createExecutableExtension("class"); navigator.setName((String) ce.getAttribute("name")); String icon = (String) ce.getAttribute("icon"); navigator.setImage(Activator.getImageDescriptor(icon).createImage()); result.add(navigator); } catch (CoreException e) { e.printStackTrace(); } } return result;}修改SmsFactory類中建立功能導航器樹結點的方法,將自訂結點加入到樹結點集 合中。public static List<ITreeEntry> createNavigatorEntryTree() { ……前面代碼不變,省略。 list.addAll(getPluginNavigator()); return list;}如果自訂擴充點的資訊較多較複雜,則可以模仿*.ui.views讀取擴充點資訊的方式,分成3種不同的類: ● ViewDescriptor——這是一個和自訂擴充點某一項資訊相對應的資料類,它實際上為外界封閉了對IConfigurationElement類的訪問。 ● ViewRegistry——如果說ViewDescriptor是擴充點某一項的資訊封裝,那麼ViewRegistry就是對自訂擴充點所有資訊的封裝。如果把ViewDescriptor比作某個省份,那麼ViewRegistry就是整個國家。 ● ViewRegistryReader——這個類負責向ViewRegistry輸送資料,如果說ViewRegistry是盲人,那麼ViewRegistryReader就是讀報人。
總結完成以上操作步驟,運行SMS項目就可以看到圖33.3所示的。從這個執行個體可以看到,在Eclipse中自訂擴充點和普通的“設定檔+代碼讀取”編程方式沒有太大差別,如果讀者用過Spring或其他架構,對這一點可以更容易理解。
建立擴充點的schema檔案以前在使用擴充點時,有可能一不小心把class屬性錯寫成了clasa,這時Eclipse就會提示有錯誤,但這裡的這個自訂擴充點沒有。以前在外掛程式清單編輯器的“擴充”介面建立一個擴充點時,會有一個圖形編輯介面,但這裡的這個自訂擴充點沒有。之所以這裡沒有這些智能化的效果,是因為少建立了一個schema檔案。自訂擴充點用的是XML,而在XML規範中有一種schema檔案(過去是DTD),可以用它來約束XML的格式。schema定義了有哪些XML項和子項,各項又有哪些屬性,屬性的名稱叫什麼,屬性是字元型還是數值型,屬性是不是可選的等。Eclipse正是根據擴充點的schema檔案來校正使用者書寫的擴充點語句是否有錯,根據schema定義來建立擴充點的圖形編輯介面。怎麼定義schema呢?可以參考Eclipse的視圖擴充點org.eclipse.ui.views是如何定義的,然後模仿著做一個。*.ui.views擴充點的schema檔案的所在地址是C:/eclipse/plugins /org.eclipse.rcp.source…/src/org.eclipse.ui…/schema/views.exsd,將它複製到SMS項目根目錄的schema子目錄(目錄名可以任取),並將檔案改名為navigators.exsd(檔案名稱可任取,不過一般讓它和對應的擴充點名稱一樣)。為了讓自訂擴充點能接受schema的規範,還要在自訂擴充點的定義語句末尾加一個屬性schema="schema/navigators.exsd"。,當加了schema之後,Eclipse左側邊欄上立刻提示有錯誤。這是因為此schema檔案原來是為擴充點views準備的,當然不適合這裡自訂的擴充點navigators。schema對擴充點的影響下面根據navigators擴充點的實際情況來修改navigators.exsd檔案:開啟navigators.exsd檔案可以顯示出一個圖形編輯器,將其中的“一般資訊”項按圖33.6所示修改。在下面的等相當於協助資訊,可以暫時不管它們。轉到“定義”介面,在這裡定義擴充點應該包含哪些項和子項,各項又有哪些屬性。將原來views擴充點的定義刪掉一些沒有必要的屬性項;將view項改為navigator;將class屬性的“擴充”項(父類)改為NavigatorEntry類;將“選項”結點的原views結點刪除,再新增一個navigator的引用結點。最後結果。%提示:在列表處的右鍵捷徑功能表可用於增刪結點的操作。 navigators.exsd的“一般資訊” “定義”介面中class屬性的設定介面儲存navigators.exsd後,可以看到plugin.xml編輯器中原來的警告提示已經沒有了,轉到“擴充”介面可以看到建立的自訂擴充點也具有了圖形編輯介面。建立自訂擴充點後的圖形編輯介面