MEF 插件式開發之 WPF 初體驗

時間  2020-05-08
標籤 mef 插件 開發 wpf 體驗 简体版
原文   原文鏈接

MEF 在 WPF 中的簡單應用

MEF 的開發模式主要適用於插件化的業務場景中，C/S 和 B/S 中都有相應的使用場景，其中包括但不限於 ASP.NET MVC 、ASP WebForms、WPF、UWP 等開發框架。固然，DotNet Core 也是支持的。html

在上篇文章中，筆者大體講述若是在控制檯程序中建立一個簡單的 MEF 應用程序。若是有讀者不太清楚，可點擊 MEF 插件式開發 - 小試牛刀 進行查看。在本篇博文中，筆者將建立一個簡單的 WPF 程序來作一些 MEF 的相關小實驗。git

首先，咱們建立一個工程，工程的目錄結構以下圖所示github

  • MefSample：WPF主程序，用來負責程序相關初始化
  • MefSample.Core：類庫，核心接口庫，來用約束相關插件的導出接口
  • MefSample.Plugin1：用戶控件庫，插件1，某一獨立具體的業務模塊
  • MefSample.Plugin2：用戶控件庫，插件2，某一獨立具體的業務模塊
  • MefSample.Service：類庫，某一具體服務的實現

咱們在相應模塊中添加相應代碼，來構建一個簡單的 MEF 示例程序。框架

在 MefSample.Core 中，咱們建立一個 IView 的接口，用於插件的導出約束，示例代碼以下所示ide

[Description("視圖接口")]
public interface IView
{
}

而後分別在 MefSample.Plugin1 和 MefSample.Plugin2 建立一個 UserControl ,並修改相應的後臺代碼函數

MefSample.Plugin1this

[Export(typeof(IView))]
public partial class MainView : UserControl,IView
{
    public MainView()
    {
        InitializeComponent();
    }
}

MefSample.Plugin2spa

[Export(typeof(IView))]
public partial class MainView : UserControl,IView
{
    public MainView()
    {
        InitializeComponent();
    }
}

加載插件

模塊加載分兩種：實時加載 和 延遲加載，針對模塊數量少，內存消耗小的話，咱們能夠採用常規的加載方式，可是若工程項目較複雜，模塊數較多的話，延遲加載是一種不錯的選擇方式，這裏分別針對這兩種加載方式進行簡單的代碼描述插件

- 常規加載

在主程序 MefSample 中，咱們能夠採用以前的加載方式來加載全部的插件，示例代碼以下所示code

public partial class MainWindow : Window
{
    private CompositionContainer container = null;
    public MainWindow()
    {
        InitializeComponent();
    }
    protected override void OnContentRendered(EventArgs e)
    {
        var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory);
        if (dir.Exists)
        {
            var catalog = new DirectoryCatalog(dir.FullName, "*.dll");
            container = new CompositionContainer(catalog);
            try
            {
                container.ComposeParts(this);
            }
            catch (CompositionException compositionEx)
            {
                Console.WriteLine(compositionEx.ToString());
            }

            IEnumerable<IView> plugins = container.GetExportedValues<IView>();
            foreach (var plugin in plugins)
            {
                this.tab.Items.Add(new TabItem() { Header = plugin.ToString(),Content = plugin });
            }
        }
        base.OnContentRendered(e);
    }

    protected override void OnClosing(CancelEventArgs e)
    {
        container?.Dispose();
        base.OnClosing(e);
    }
}

- 懶加載

要想用到懶加載技術須要藉助 Lazy 來實現，稍微將上述代碼修改一下就能夠了，示例代碼以下所示

public partial class MainWindow : Window
{
    [ImportMany]
    public Lazy<IView>[] plugins { get; set; }

    private CompositionContainer container = null;
    public MainWindow()
    {
        InitializeComponent();
    }
    protected override void OnContentRendered(EventArgs e)
    {
        var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory);
        if (dir.Exists)
        {
            var catalog = new DirectoryCatalog(dir.FullName, "*.dll");
            container = new CompositionContainer(catalog);
            try
            {
                container.ComposeParts(this);
            }
            catch (CompositionException compositionEx)
            {
                Console.WriteLine(compositionEx.ToString());
            }

            foreach (var plugin in plugins)
            {
                this.tab.Items.Add(new TabItem()
                {
                    // 此時 pulugin 對象還未建立，執行 plugin.Value 纔會建立該對象
                    Header = plugin.ToString(),
                    Content = plugin.Value
                });
            }
        }
        base.OnContentRendered(e);
    }

    protected override void OnClosing(CancelEventArgs e)
    {
        container?.Dispose();
        base.OnClosing(e);
    }
}

獲取元數據

有時，單純地加載一個插件並不能知足咱們的業務需求，咱們可能還須要獲取一些插件中的元數據來進行相應處理，這個時候咱們就須要藉助 IMetaData 來知足咱們的業務場景需求。 首先，咱們在 MefSample.Core 建立一個新的接口，定義爲 IMetadata，並建立一個與之對應的自定義屬性 CustomExportMetadata ，相關示例代碼以下所示

/// <summary>
/// 元數據接口
/// 第二種方法可參考：MetadataViewImplementation 方式
/// </summary>
public interface IMetadata
{
    [DefaultValue(0)]
    int Priority { get; }
    string Name { get; }
    string Description { get; }
    string Author { get; }
    string Version { get; }
}

[MetadataAttribute]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class CustomExportMetadata : ExportAttribute, IMetadata
{
    public int Priority { get; private set; }
    public string Name { get; private set; }
    public string Description { get; private set; }
    public string Author { get; private set; }
    public string Version { get; private set; }

    public CustomExportMetadata() : base(typeof(IMetadata))
    {
    }

    public CustomExportMetadata(int priority) : this()
    {
        this.Priority = priority;
    }

    public CustomExportMetadata(int priority, string name) : this(priority)
    {
        this.Name = name;
    }

    public CustomExportMetadata(int priority, string name, string description) : this(priority, name)
    {
        this.Description = description;
    }

    public CustomExportMetadata(int priority, string name, string description, string author) : this(priority, name, description)
    {
        this.Author = author;
    }

    public CustomExportMetadata(int priority, string name, string description, string author, string version) : this(priority, name, description, author)
    {
        this.Version = version;
    }
}

而後爲咱們的每一個插件打上相應標籤

MefSample.Plugin2

[Export(typeof(IView))]
[CustomExportMetadata(1,"Plugin 1","這是第一個插件","hippiezhou","1.0")]
public partial class MainView : UserControl,IView
{
    public MainView()
    {
        InitializeComponent();
    }
}

MefSample.Plugin2

[Export(typeof(IView))]
[CustomExportMetadata(2, "Plugin 2", "這是第二個插件", "hippiezhou", "1.0")]
public partial class MainView : UserControl, IView
{
    public MainView()
    {
        InitializeComponent();
    }
}

最後，修改咱們的主程序

public partial class MainWindow : Window
{
    [ImportMany]
    public Lazy<IView,IMetadata>[] Plugins { get; set; }

    private CompositionContainer container = null;
    public MainWindow()
    {
        InitializeComponent();
    }
    protected override void OnContentRendered(EventArgs e)
    {
        var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory);
        if (dir.Exists)
        {
            var catalog = new DirectoryCatalog(dir.FullName, "*.dll");
            container = new CompositionContainer(catalog);
            try
            {
                container.ComposeParts(this);
            }
            catch (CompositionException compositionEx)
            {
                Console.WriteLine(compositionEx.ToString());
            }

            foreach (var plugin in Plugins)
            {
                this.tab.Items.Add(new TabItem()
                {
                    //獲取元數據
                    Header = plugin.Metadata.Name,
                    Content = plugin.Value
                });
            }
        }
        base.OnContentRendered(e);
    }

    protected override void OnClosing(CancelEventArgs e)
    {
        container?.Dispose();
        base.OnClosing(e);
    }
}

依賴注入

最後說一下關於依賴注入的問題，在上篇博文中咱們簡單敘述了什麼是 IOC。談到控制反轉就不得不提一下依賴注入了。在本次實驗中，筆者經過往 Plugin2 插件注入一個簡單服務來進一步理解。

首先，咱們在 MefSample.Core 中建立一個服務接口 IService，示例代碼以下所示

[Description("服務接口")]
public interface IService
{
    void QueryData(int numuber, Action<int> action);
}

其次，咱們在 MefSample.Service 中實現一個相應的服務 DataService，示例代碼以下所示

[Description("具體服務")]
[Export(nameof(DataService),typeof(IService))]
public class DataService : IService
{
    public void QueryData(int numuber, Action<int> action)
    {
        action(numuber * 100);
    }
}

最後，咱們在 MefSample.Plugin2 的模塊構造函數中注入一個服務 IService 類型的服務，示例代碼以下所示

[Export(typeof(IView))]
[CustomExportMetadata(2, "Plugin 2", "這是第二個插件", "hippiezhou", "1.0")]
public partial class MainView : UserControl, IView
{
    public readonly IService Service;
    [ImportingConstructor]
    public MainView([Import("DataService")]IService service)
    {
        InitializeComponent();

        Service = service;
        Service.QueryData(10, sum => { this.tb.Text = sum.ToString(); });
    }
}

當咱們從新編譯程序項目並運行的話，會發現插件二模塊的界面上會顯示 1000。這裏須要注意的是，你也能夠不經過構造函數來注入服務，而是以屬性的方式。可是我我的不建議這麼作，由於它並不能很好的闡釋了 DI 。這裏建議讀者朋友閱讀一下 Artech 大叔發佈的相關係列文章，確實至關精彩，非常值得閱讀。

總結

MEF 對初學者來講可能不是很好理解，可是多寫幾個 Demo 試驗幾回就行了。若是後續還有時間的話，我會與你們簡單分享一下 Prism 框架的使用。這裏分享幾個 Github 地址給你們

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程