1 源碼下載

直接放出源碼地址，為了編譯源碼，需要下載安裝OSGi.NET插件框架安裝包：http://www.iopenworks.com/。

【1】框架安裝包：MuiTreeNavVsPackage.zip（使用方法見上一篇文章：分享一個漂亮WPF界面框架創(chuàng)作過程及其源碼）。

【2】框架源代碼：MuiTreeNavSource.zip

注意：運行后，默認賬戶為admin/admin。記得點擊右邊“推薦一下”，否則登錄會失??！

2 OSGi.NET插件應(yīng)用架構(gòu)概述

基于OSGi.NET插件框架的應(yīng)用由以下三個部分構(gòu)成：

（1）主程序：針對特定應(yīng)用環(huán)境（WPF、Web、WinForm等應(yīng)用環(huán)境），加載啟動插件，獲取插件入口，運行入口程序。

（2）插件：提供應(yīng)用功能，實現(xiàn)對其它插件功能擴展并暴露功能擴展點。

（3）插件框架：與特定應(yīng)用環(huán)境無關(guān)，實現(xiàn)插件的加載、啟動、停止、更新和卸載，實現(xiàn)插件功能組合與擴展。

3 漂亮界面框架原理概述

WPF漂亮界面框架最終展示效果如下圖所示。主界面中間區(qū)域的左邊是導(dǎo)航欄，右邊是顯示區(qū)域，點擊導(dǎo)航欄的導(dǎo)航節(jié)點后，在內(nèi)容區(qū)域動態(tài)顯示其內(nèi)容。此外，還提供了標(biāo)題欄、狀態(tài)欄、系統(tǒng)菜單、系統(tǒng)設(shè)置等默認功能。

該界面，從功能上看，它由界面框架插件、演示插件、權(quán)限管理插件、插件中心插件以及通用功能插件構(gòu)成，如下所示。

這些插件的功能組合關(guān)系如下所示，"應(yīng)用 = 界面框架插件 + 功能插件（演示/權(quán)限管理/插件中心插件）擴展"。界面框架定義了系統(tǒng)主界面風(fēng)格、可擴展的屬性導(dǎo)航欄、可擴展的內(nèi)容區(qū)域等元素構(gòu)成。

上述的權(quán)限管理插件除了提供角色管理/用戶管理功能，它還定義了一個登錄窗體。主程序exe文件在執(zhí)行時，首先創(chuàng)建并啟動OSGi.NET插件框架，然后通過服務(wù)總線獲取權(quán)限管理插件注冊的登錄窗體，并顯示。此時，程序執(zhí)行的控制權(quán)則完全交由插件。

在權(quán)限管理插件的登錄界面，登錄成功之后，它會顯示界面框架插件定義的MainWindow主界面。該主界面則開始來組合插件的功能。下面，我們來看看插件實現(xiàn)的細節(jié)。

#p#

4 漂亮界面框架實現(xiàn)

4.1 主程序

主程序主要實現(xiàn)：（1）創(chuàng)建啟動插件框架；（2）獲取入口，并進入入口程序。下面我們來看看這個WPF主程序的入口。

在App.xaml.cs中定義了一個函數(shù)StartBundleRuntime，如下所示。

private void StartBundleRuntime() 
{ 
    …… 
    // 創(chuàng)建BundleRuntime 
    var bundleRuntime = new BundleRuntime(); 
    // 不啟動多版本支持 
    bundleRuntime.EnableAssemblyMultipleVersions = false; 
    // 監(jiān)聽插件狀態(tài)變化，更新進度條 
    bundleRuntime.Framework.EventManager.AddBundleEventListener(BundleStateChangedHandler, true); 
    // 監(jiān)聽框架狀態(tài)變化 
    bundleRuntime.Framework.EventManager.AddFrameworkEventListener(FrameworkStateChangedHandler); 
    // 將Application實例添加到全局服務(wù)，與插件進行共享 
    bundleRuntime.AddService<Application>(this); 
    // 啟動插件框架 
    bundleRuntime.Start(); 
    // 移除事件監(jiān)聽 
    bundleRuntime.Framework.EventManager.RemoveBundleEventListener(BundleStateChangedHandler, true); 
    bundleRuntime.Framework.EventManager.RemoveFrameworkEventListener(FrameworkStateChangedHandler); 
  
    Startup += App_Startup; 
    Exit += App_Exit; 
    _bundleRuntime = bundleRuntime; 
} 

在主程序中，它使用以下代碼來獲取入口，這個入口是一個LoginWindow。 

private void App_Startup(object sender, StartupEventArgs e) 
{ 
    …… 
    // 獲取loginWindow實例，并顯示該窗口 
    var loginWindow = bundleRuntime.GetFirstOrDefaultService<Window>(); 
    loginWindow.Loaded += (sender2, e2) => 
    { 
        loginWindow.Activate(); 
    }; 
    loginWindow.Show(); 
} 

4.2 主程序與插件的通訊

OSGi.NET插件框架提供了一個簡單的方式來實現(xiàn)主程序與插件間的通訊，即服務(wù)。

主程序可以通過插件框架BundleRuntime來注冊和獲取服務(wù)，插件可以通過插件激活器的上下文來注冊和獲取服務(wù)、或者使用BundleRuntime.Instance這個單例來注冊與獲取服務(wù)。也就是說，主程序的BundleRuntime、插件的上下文IBundleContext都是對應(yīng)相同的服務(wù)總線。

服務(wù)在這里表述為：服務(wù) = 接口/基類 + 實現(xiàn)類。比如ISayHelloService接口、SayHelloServiceBase基類、SayHelloService實現(xiàn)類。我們可以注冊服務(wù)為：

AddService<ISayHelloService>(new SayHelloService()) 

或者

AddService<SayHelloServiceBase>(new SayHelloService()) 
 

那么獲取服務(wù)的方式就是：

Get**Service<ISayHelloService>() 

或者 

Get**Service<SayHelloServiceBase>() 

4.2.1主程序獲取插件注冊的服務(wù)

在該框架，主程序需要獲取權(quán)限管理插件注冊的登錄窗體，然后運行，接著將系統(tǒng)控制權(quán)轉(zhuǎn)交給插件。這時候，主程序通過以下代碼來獲取服務(wù)。

（1）創(chuàng)建啟動插件框架

var bundleRuntime = new BundleRuntime(); 
 
bundleRuntime.Start(); 

（2）獲取服務(wù)

var loginWindow = bundleRuntime.GetFirstOrDefaultService<Window>(); 
 
loginWindow.Show(); 

權(quán)限管理插件在Activator類中，通過以下代碼將LoginWindow注冊到服務(wù)總線。

public class Activator : IBundleActivator 
{ 
    public void Start(IBundleContext context) 
    { 
        context.AddService<Window>(new LoginWindow()); 
    } 
 
    public void Stop(IBundleContext context) 
    { 
 
    } 
} 

這里，需要注意的是：主程序只能等插件框架啟動起來后，才能夠獲取插件注冊的服務(wù)。

4.2.2插件獲取主程序注冊的服務(wù)

主程序可以為插件注冊全局的服務(wù)，這樣所有插件在啟動的時候，就可以直接來訪問。主程序注冊全局服務(wù)的代碼如下：

var bundleRuntime = new BundleRuntime(); 
 
bundleRuntime.AddService<ISayHelloService>(); 
 
bundleRuntime.Start(); 

注意：主程序在BundleRuntime.Start方法調(diào)用前注冊的服務(wù)，插件在啟動時即可獲取。

這時候，插件可以在激活器中直接獲取到該服務(wù)了。

public class Activator : IBundleActivator 
{ 
    public void Start(IBundleContext context) 
    { 
        var sayHelloService = context.GetFirstOrDefaultService<ISayHelloService>(); 
        sayHelloService.Hell(“Lorry Chen”); 
    } 
 
    public void Stop(IBundleContext context) 
    { 
 
    } 
} 

4.2.3 服務(wù)接口

在4.2.1小節(jié)中，主程序和權(quán)限管理插件在處理服務(wù)時，使用Window這個類作為服務(wù)的契約。這個服務(wù)契約是在.NET Framework中直接定義的，因此主程序和插件都可以訪問到。如果我們新定義的服務(wù)SayHelloService（ISayHelloService接口、SayHelloService服務(wù)實現(xiàn)類），那么這時候主程序和插件都需要通過接口ISayHelloService來獲取服務(wù)，這時候建議將ISayHelloService接口定義到一個外部的程序集，主程序可以引用它，插件也可以依賴它。

4.3 權(quán)限管理的登錄窗體

基于4.2，我們發(fā)現(xiàn)通過服務(wù)可以實現(xiàn)主程序和插件之間的通訊。當(dāng)主程序獲取到權(quán)限管理注冊的登錄窗體實例，便獲取該窗體并展現(xiàn)它，此后應(yīng)用系統(tǒng)便交由插件來控制了。

在權(quán)限管理插件的登錄窗體，它由LoginUserControl.xaml來實現(xiàn)，在該頁面的后臺代碼的登錄處理函數(shù)中，一旦登錄成功，它將創(chuàng)建一個主窗體MainWindow，并且顯示該窗體，如下圖所示。

在這里，權(quán)限管理插件創(chuàng)建了主窗體MainWindow類，這個類實際上是由界面框架插件定義的主窗體。因此，該插件依賴了界面框架插件，并添加了對UIShell.WpfShellPlugin程序集的引用。如下所示。

通過上述的工作，登錄窗體在登錄成功之后，就可以顯示界面框架的主窗體了。

4.4 界面框架插件

應(yīng)用系統(tǒng)由界面框架插件、服務(wù)插件和功能插件構(gòu)成，它們的組合關(guān)系如下所示。

從界面功能上來講，系統(tǒng)由主界面框架、插件中心插件、權(quán)限管理插件、演示插件組成，在其背后還有一些非界面功能插件，比如數(shù)據(jù)庫訪問等。

界面框架插件提供了一個可擴展、可組合的界面功能展示。界面框架插件暴露了一個名為UIShell.NavigationService的擴展點，權(quán)限管理插件、插件中心插件、其它插件則定義了針對該擴展點的擴展。

界面框架對應(yīng)的擴展格式如下所示。該格式由名為Node的XML節(jié)點組成，Node節(jié)點可以嵌套包含子節(jié)點。

<Extension Point="UIShell.NavigationService"> 
  <Node Id="2E3614E0-388D-46E4-88A8-42E7CB3B421F" Name="權(quán)限管理" 
        Icon="/UIShell.RbacManagementPlugin;component/Assets/Permission.png" 
        Order="490"> 
    <Node Name="角色管理" Permission="RoleManagementPermission" 
          Value="UIShell.RbacManagementPlugin.RolePermissionUserControl" 
          Icon="/UIShell.RbacManagementPlugin;component/Assets/Role.png" Order="1" /> 
    <Node Name="用戶管理" Permission="UserManagementPermission" 
          Value="UIShell.RbacManagementPlugin.UserPermissionUserControl" 
          Icon="/UIShell.RbacManagementPlugin;component/Assets/User2.png" Order="2" /> 
  </Node> 
</Extension> 

當(dāng)界面框架插件沒有加載任何擴展時，界面是空白的。左邊導(dǎo)航欄用于加載插件定義的導(dǎo)航菜單，右邊用于加載插件的顯示內(nèi)容。

那么插件中心插件就是由對界面框架插件的擴展及如下功能構(gòu)成，如下所示。

插件中心插件對界面框架插件的界面擴展是通過如下的Manifest.xml來定義的。

同理，權(quán)限管理插件也是對界面框架插件定義了擴展并實現(xiàn)了如下功能。

權(quán)限管理插件對界面框架的擴展定義在Manifest.xml中實現(xiàn)，如下所示。

課程管理這個示例插件也是如此。

4.4.1 導(dǎo)航服務(wù)

插件對界面框架的擴展的XML由導(dǎo)航服務(wù)來進行解析。通俗的講，該服務(wù)實現(xiàn)的是將以下XML節(jié)點變更NavigationNode對象。

<Extension Point="UIShell.NavigationService"> 
  <Node Id="2E3614E0-388D-46E4-88A8-42E7CB3B421F" Name="權(quán)限管理"  
        Icon="/UIShell.RbacManagementPlugin;component/Assets/Permission.png"  
        Order="490"> 
    <Node Name="角色管理" Permission="RoleManagementPermission"  
          Value="UIShell.RbacManagementPlugin.RolePermissionUserControl"  
          Icon="/UIShell.RbacManagementPlugin;component/Assets/Role.png" Order="1" /> 
    <Node Name="用戶管理" Permission="UserManagementPermission"  
          Value="UIShell.RbacManagementPlugin.UserPermissionUserControl"  
          Icon="/UIShell.RbacManagementPlugin;component/Assets/User2.png" Order="2" /> 
  </Node> 
</Extension> 

NavigationNode對象如下圖所示，它包含子對象。該對象對應(yīng)于XML節(jié)點。我們可以通過INavigationService來獲取這些對象集合。INavigationService會默認從名字為"UIShell.NavigationService"的擴展點來創(chuàng)建對象。如果我們使用了類似的導(dǎo)航擴展定義，但使用了不同的擴展點，可以使用INavigationServiceFactory來創(chuàng)建指定擴展點的導(dǎo)航服務(wù)。

導(dǎo)航服務(wù)還隱藏了針對擴展變更事件的處理。該服務(wù)暴露了NavigationChanged事件來通知導(dǎo)航節(jié)點變更。

4.4.2 界面框架擴展實現(xiàn)

界面框架首先需要實現(xiàn)一個空的布局，其內(nèi)容區(qū)域為樹和空白顯示區(qū)域。樹使用TreeView，空白顯示區(qū)域的父控件是DockPanel。那么，該框架實現(xiàn)的核心就是將NavigationNode的集合轉(zhuǎn)換成TreeViewNode集合，當(dāng)點擊TreeViewNode時，能夠?qū)⑵鋵?yīng)的用戶控件加載。

界面框架的XAML如下所示。

<UserControl x:Class="UIShell.WpfShellPlugin.Pages.Layout"……> 
    <Grid Style="{StaticResource ContentRoot}"> 
        <DockPanel> 
            <DockPanel DockPanel.Dock="Bottom" Height="20" ……> 
                ……//Status Bars 
            </DockPanel> 
 
            <Grid> 
                <Grid.ColumnDefinitions> 
                    <ColumnDefinition Name="TreeViewColumn"></ColumnDefinition> 
                    <ColumnDefinition Width="*"></ColumnDefinition> 
                </Grid.ColumnDefinitions> 
                 
                <TreeView Grid.Column="0" Grid.Row="0" Name="NavigationTreeView"  
                    SelectedItemChanged="NavigationTreeView_SelectedItemChanged" /> 
 
                <GridSplitter DragCompleted="GridSplitter_DragCompleted" /> 
 
                <TextBlock  Grid.Column="1" Grid.Row="0" Name="LoadingTextBlock"  
                    Text="加載中......"  …… Visibility="Hidden"></TextBlock> 
 
                <Grid Grid.Column="1" Grid.Row="0" Name="LayoutDockPanel"> 
                </Grid> 
            </Grid> 
        </DockPanel> 
         
        <DockPanel Name="SideBarDockPanel"  
Background="{DynamicResource WindowBackground}"  
Width="300" HorizontalAlignment="Right" Visibility="Hidden"> 
            <Border BorderThickness="2" BorderBrush="{DynamicResource Accent}"> 
                <Grid> 
                    <Grid.RowDefinitions> 
                        <RowDefinition Height="45" /> 
                        <RowDefinition Height="*" /> 
                    </Grid.RowDefinitions> 
                     
                    <TextBlock Name="SideBarTitleTextBlock"  
Grid.Row="0" Margin="16, 16, 16, 0"  
Foreground="{DynamicResource Accent}" FontSize="20" /> 
                     
                    <DockPanel Grid.Row="1" Margin="16"  
                        Name="SideBarDockPanelContent"> 
                    </DockPanel> 
                </Grid> 
                 
            </Border> 
        </DockPanel> 
    </Grid> 
</UserControl> 

從這些XAML片段，你可以看到，LayoutDockPanel這個名字的控件時用于放置動態(tài)加載的插件的控件，加載時機是在NavigationTreeView的SelectedItemChanged事件。另外，該界面框架還實現(xiàn)了SideBarDockPanel，用于支持從側(cè)面動態(tài)滑出一個側(cè)邊框。

下面我們看看界面框架針對擴展的處理。

接著我們看看ResetNavigation函數(shù)的實現(xiàn)。

其實現(xiàn)的核心就是InitializeNavigationTreeView。

該函數(shù)就是根據(jù)NavigationNode集合，遞歸創(chuàng)建TreeViewItem。下面我們來看看點擊樹形導(dǎo)航節(jié)點時，如何動態(tài)加載顯示插件的控件，其核心代碼如下。

從插件動態(tài)加載類型時，我們使用的是node.Bundle.LoadClass，即獲取擴展注冊的插件對象，調(diào)用該對象的LoadClass方法來加載用戶控件，然后將用戶控件顯示在LayoutDockPanel控件。

不過，當(dāng)前界面框架還處理一些其它的功能：

（1）當(dāng)前導(dǎo)航節(jié)點的側(cè)邊欄，即當(dāng)切換菜單時，會自動打開/關(guān)閉與其關(guān)聯(lián)的側(cè)邊欄；

（2）緩存與關(guān)閉，即加載用戶控件后，會直接緩存，在切換時，會將前一個控件隱藏，接著顯示當(dāng)前控件；只有關(guān)閉后，用戶控件才從父控件移除掉；

（3）關(guān)閉內(nèi)容區(qū)域與導(dǎo)航節(jié)點選擇的同步，也就是說，關(guān)閉當(dāng)前內(nèi)容后，會默認顯示前一個頁面，此時，導(dǎo)航節(jié)點的選擇也必須同步切換；

（4）相關(guān)對象的關(guān)系存儲。

4.5 插件

下面我將從以下幾個方面來談一下開發(fā)插件過程中，需要處理的一些問題。

4.5.1 插件引用了第三方程序集

在主界面框架中，我們依靠第三方控件庫"ModernUI"來實現(xiàn)界面，并對"ModernUI"做深入的定制。在界面框架插件引用該控件時，首先，我們需要將該插件添加到Manifest.xml作為本地程序集，即界面框架插件在運行時需要與該程序集一起才能夠正常運行。

接著，可以直接從bin目錄來引用該程序集或者添加ModernUI源碼項目的程序集引用。

這時候，在界面框架插件中，就可以來直接使用ModernUI程序集的類型了。如下示例。

ModernDialog.ShowMessage("Hello, world!", "Hello", MessageButtongs.Ok); 

或者

var dialog = new ModernDialog(){……}; 
 
dialog.ShowDialog(); 

4.5.2 一個程序集如何讓所有插件都直接使用

在這個WPF應(yīng)用程序，每一個插件在開發(fā)界面時大部分使用了MVVM架構(gòu)，它依賴于MVVMLite這個庫。為了能夠讓插件直接使用，并且不需要將其添加到本地程序集的情況下來使用。我們可以在主程序里面直接添加對MVVMLite程序集的依賴，編譯后，每一個插件可以直接來引用主程序輸出目錄下的MVVMLite程序集。

你可以發(fā)現(xiàn)，MVVMLite程序集所在的位置。如果是Web應(yīng)用的話，這些程序集所在目錄是bin目錄。這樣的程序集在OSGi.NET框架中成為全局程序集，默認開啟支持該功能。你可以通過設(shè)置BundleRuntime.EnableGlobalAssemblyFeature屬性開啟或者關(guān)閉該功能。

全局程序集有以下特點：（1）如果插件包含了另一個程序集，和該程序集名稱一樣，則會被替換掉；（2）全局程序集不支持多版本。

4.5.3 插件引用了另一個插件的程序集

在該界面框架中，所有UI插件都是基于ModernUI控件庫來實現(xiàn)。該控件庫在界面框架中包含。因此，我們的功能插件需要引用界面框架插件的ModernUI控件庫。

首先，在界面框架，需要將該程序集定義成共享。

接著，在功能插件中，需要添加對界面框架的依賴。

最后，插件就可以直接通過引用，來添加對該程序集的引用，并在代碼中來調(diào)用了。

4.5.4 插件間的通訊實現(xiàn)

插件間的通訊，有兩種方式，第一種是一個插件直接使用另一個插件的程序集的類，如4.5.3的方式；第二種是松耦合的方式，即使用服務(wù)。

比如，在演示插件，我們引用了配置服務(wù)。配置服務(wù)是在配置服務(wù)插件來創(chuàng)建的，該服務(wù)定義如下所示。

該插件通過Activator來注冊服務(wù)實例，如下所示。

using System; 
using System.Collections.Generic; 
using System.Text; 
using UIShell.OSGi; 
 
namespace UIShell.ConfigurationService 
{ 
    public class Activator : IBundleActivator 
    { 
        public void Start(IBundleContext context) 
        { 
            context.AddService<IConfigurationService>(new ConfigurationService()); 
        } 
 
        public void Stop(IBundleContext context) 
        { 
             
        } 
    } 
} 

演示插件依賴于IConfigurationService接口所在的程序集，通過該接口來獲取服務(wù)，如下所示。

接著，在演示插件就可以通過以下方式來存儲或者獲取配置了。

BundleActivator.ConfigrationService.Set(BundleActivator.Bundle, "TreeViewColumnWidth", 80); 

或者

var width = BundleActivator.ConfigurationService.Get(BundleActivator.Bundle, "TreeViewColumnWidth", 80); 

4.5.5 如何從插件動態(tài)的加載類型

從插件加載類型的方式通過插件對象來實現(xiàn)。插件對象由OSGi.NET框架創(chuàng)建，可以通過插件激活器的IBundleContext.Bundle屬性獲取。

var bundle = Context.Bundle; // 或者var bundle = Context.GetBundleBySymbolicName("DemoPlugin"); 
var class = bundle.LoadClass("DemoPlugin.CourseManagementUserControl"); 

5 關(guān)于框架的藝術(shù)

框架的藝術(shù)并不在于技術(shù)本身，而是在于能夠幫助團隊更有效率的進行產(chǎn)品開發(fā)。為了提高產(chǎn)品開發(fā)效率，框架必須能夠提供：

（1）統(tǒng)一的開發(fā)模板：通過模板來規(guī)范團隊成員的編碼規(guī)則與規(guī)范功能模塊的架構(gòu)，減少軟件開發(fā)的學(xué)習(xí)成本。比如，我們制作的演示插件模板，在這個模板基礎(chǔ)上做功能開發(fā)，是不需要你掌握多少關(guān)于框架本身的技術(shù)，而是專注于業(yè)務(wù)實現(xiàn)及通用功能的調(diào)用；此外，該模板規(guī)范了MVVM架構(gòu)分層，統(tǒng)一了架構(gòu)思想。

（2）一致的用戶體驗：通過框架為客戶定義了一致的界面風(fēng)格，這使我們的軟件看上起更加的專業(yè)。

（3）良好的分工協(xié)作：通過框架，團隊成員可以專注于不同的功能模塊，進行有效率的并行協(xié)作。

6 總結(jié)

這個教程介紹了漂亮界面框架的架構(gòu)、實現(xiàn)細節(jié)，通過這個教程，你已經(jīng)能夠掌握使用OSGi.NET框架來開發(fā)一個漂亮界面框架了。

原文鏈接：http://www.cnblogs.com/baihmpgy/p/osgi_muinavtree_fx.html