在MvvmLight下使用MEF实现插件子系统

　　MEF即Managed Extensibility Framework,于.net 4.0引入。MEF通过简单地给代码附加“[Import]”和“[Export]”标记，我们就可以清晰地表明组件之间的“服务消费”与“服务提供”关系，MEF在底层使用反射动态地完成组件识别、装配工作。从而使得开发基于插件架构的应用系统变得简单。

　　实际上在Codeplex、codeproject上已经有很多类似主题的示例，但因本身在于使用MEF实现一个复杂的系统，初学者只会感觉眼花缭乱[至少当时我在学习MEF官方发布的例子时倍感吃力]，特写了一个简单逻辑的例子希望能帮到初学者。  

代码整体结构如下：

在上图中，Extension.Core封装了扩展程序接口，只有实现了改接口的模块才能被客户端发现。WPFPlugOne和WPFPlugTwo分别是两个使用MEF实现了插件。

      我们先来看看实现插件的核心Extension.Core ,其中最主要的是IExtensionService，只有实现了该接口的插件才能被客户端使用。 而IMenuItem，它的定义是为了能够响应客户端的请求，并将请求内容传到插件中。具体实现如下：

/// <summary>
    /// 所有扩展入口
    /// </summary>
    public interface IExtensionService
    {
        IMenuItem Item { get; set; }
    }


public interface IMenuItem
    {
        string Header { get; }
        IEnumerable<IMenuItem> Items { get;}
        bool IsChecked { get; set; }
        ICommand CheckChangedCommand { get; }

        GalaSoft.MvvmLight.ViewModelBase ViewModel { get;  }
    }

　　在整个应用程序中，为了实现插件的载入、执行等操作，需要引用两个主要的命名空间：

using System.ComponentModel.Composition.Hosting;
using System.ComponentModel.Composition;

System.ComponentModel.Composition;使我们的程序拥有了指定属性、字段或参数导入特定的导出的能力。即可以[Import]具有指定协定名称、协定类型且标记了[Export]的模块。
System.ComponentModel.Composition.Hosting;则起到一个容器的作用。

这些只是一个货架，具体的货物来源还得看我们的程序如何来加载：

        #region MEF 

        /// <summary>
        /// 首先，它跟踪哪些部分可用于组合、它们的依赖项，并且充当任何指定组合的上下文。其次，它提供了应用程序可以启动组合的方法、获取组合部件的实例，或填充可组合部件的依存关系。
        /// </summary>
        private CompositionContainer _container;

        /// <summary>
        /// 导入凡是协定名称为Extension.Core.ExtensionPoints.Host.Views，协定类型为ResourceDictionary 的模块
        /// 此处在于客户端能统一管理扩展插件的现实方式
        /// </summary>
        [ImportMany(Extension.Core.ExtensionPoints.Host.Views, typeof(ResourceDictionary))]
        private IEnumerable<ResourceDictionary> Views { get; set; }

        [ImportMany(Extension.Core.ExtensionPoints.Host.Styles, typeof(ResourceDictionary), AllowRecomposition = true)]
        private IEnumerable<ResourceDictionary> Styles { get; set; }

        /// <summary>
        /// 扩展插件入口
        /// </summary>
        [ImportMany(Extension.Core.ExtensionPoints.WorkArea.MainMenu.Self, typeof(Extension.Core.IExtensionService))]
        private IEnumerable<Extension.Core.IExtensionService> Extensions { get; set; }

        public static IEnumerable<Extension.Core.IExtensionService> ExtensionAdds { get; set; }

        #endregion

        /// <summary>
        /// 组件构成
        /// 当程序执行到这里，就会将会于应用程序根目录下实现了指定接口的模块进行组合，接下来就可以在程序中直接使用了
        /// </summary>
        /// <returns></returns>
        private bool Compose()
        {
            var catalog = new AggregateCatalog();
            catalog.Catalogs.Add(new DirectoryCatalog("."));

            _container = new CompositionContainer(catalog);

            try
            {
                _container.ComposeParts(this);
            }
            catch (CompositionException compositionException)
            {
                MessageBox.Show(compositionException.ToString());
                _container.Dispose();
                return false;
            }
            return true;
        }

        /// <summary>
        /// 在满足部件的导入并可安全使用时调用
        /// </summary>
        public void OnImportsSatisfied()
        {
            foreach (ResourceDictionary r in Views)
            {
                this.Resources.MergedDictionaries.Add(r);
            }
            ExtensionAdds = Extensions;
        }

 　　下面我们来构建一个具体的插件，名我PlugOne，功能主要是实现对客户端输入数据的修改、删除或添加新的数据。

　　首先，为了客户端能够统一管理插件页面并能够被发现，需要将所有要展示出来的页面定义到DataTemplate中。

ResourceDictionary x:Class="WPFPlugTwo.AddNewData"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
                    xmlns:vm="clr-namespace:WPFPlugTwo.ViewModel"
             mc:Ignorable="d" >
    <DataTemplate DataType="{x:Type vm:AddNewDataViewModel}">
        <Grid Background="White" MinWidth="300" MinHeight="180">
          .........
        </Grid>
    </DataTemplate>
</ResourceDictionary>

 而在对应的交互逻辑页面中，也要做一些对应的更改。

/// <summary>
    /// AddNewData.xaml 的交互逻辑
    /// </summary>
    [Export(Extension.Core.ExtensionPoints.Host.Views,typeof(ResourceDictionary)) ]
    public partial class AddNewData : ResourceDictionary
    {
        public AddNewData()
        {
            InitializeComponent();
        }
    }

　　ok，如果一切正常，这个时候私有属性 Views 已经有值了。但是却还不足以让程序调用。前面已经说过IExtensionService是所有扩展库要实现的必要接口，只有实现了该接口的库才能被发现。

[Export(Extension.Core.ExtensionPoints.WorkArea.MainMenu.Self, typeof(IExtensionService))]
    public class MainMenuItem : IExtensionService
    {
        //导入实现了IMenuItem的导出类型，因为触发扩展插件事件的来源定义menuItem的点击事件 ，
        [Import("AddNewDataMenuItem", typeof(IMenuItem))]
        public Lazy<IMenuItem> AboutMenuItem { set; get; }


        public IMenuItem Item
        {
            get
            {
                return  AboutMenuItem.Value;
            }
            set
            {
                throw new NotImplementedException();
            }
        }
    }


[Export("AddNewDataMenuItem", typeof(IMenuItem))]
    public class AddNewDataMenuItem : IMenuItem
    {
        //导出AddNewData页面的数据模型，如果有多个页面同样可以在此导出
        [Import(Extension.Core.CompositionPoints.WorkArea.ViewModel, typeof(AddNewDataViewModel))]
        public Lazy<AddNewDataViewModel> ViewModelPage { set; get; }
        
        //在MenuItem中显示的插件名次
        public string Header
        {
            get { return "添加数据"; }
        }

        //所对应的MenuItem是否还有二级菜单
        public IEnumerable<IMenuItem> Items
        {
            get { return null; }
        }

        public bool IsChecked
        {
            get;
            set;
        }
        

        private System.Windows.Input.ICommand _checkChangedCommand;
        public System.Windows.Input.ICommand CheckChangedCommand
        {
            get
            {
                if (_checkChangedCommand == null)
                    _checkChangedCommand = new RelayCommand(() =>
                    {
                       //定义在触发该命令后要做的操作
                    });
                return _checkChangedCommand;
            }
        }

        //指定所对应的数据模型
        public GalaSoft.MvvmLight.ViewModelBase ViewModel
        {
            get
            {
                return ViewModelPage.Value;
            }
        }

      此时，一个简单的插件已经诞生了，接下来我们来看客户端是如何来使用它的，前面已经在App.xaml.cs中编写了加载的方法。那么我们要操作的就是静态属性ExtensionAdds了。

<Window x:Class="MvvmLightMEFSample.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:local="clr-namespace:MvvmLightMEFSample"
        xmlns:vm="clr-namespace:MvvmLightMEFSample.ViewModel"
        xmlns:vw="clr-namespace:MvvmLightMEFSample.Views"
        xmlns:i="clr-namespace:System.Windows.Interactivity;assembly=System.Windows.Interactivity"
        Title="{Binding Welcome}"
        Height="300" WindowStartupLocation="CenterScreen"
        Width="500" >

    <Window.Resources>
        <DataTemplate DataType="{x:Type MenuItem}" x:Key="extensionItem">
            <Grid>
                <MenuItem HorizontalAlignment="Stretch" Header="{Binding Item.Header}" Command="{Binding DataContext.CheckChangedCommand,RelativeSource={RelativeSource FindAncestor,AncestorType={x:Type Menu}}}" CommandParameter="{Binding RelativeSource={RelativeSource self}}"/>
            </Grid>
        </DataTemplate>

        <DataTemplate DataType="{x:Type vm:ExtensionWrapperViewModel}">
            <vw:ExtensionWrapper />
        </DataTemplate>
    </Window.Resources>

    <Grid x:Name="LayoutRoot">
        <Menu Height="30"  Name="menu1" VerticalAlignment="Top" >
            <MenuItem Header="固有操作" Width="80">
                <MenuItem Header="删除数据"  Command="{Binding FillDataCommand}"/>
            </MenuItem>
            <MenuItem Header="扩展操作" x:Name="extensionitem" Width="80" HorizontalAlignment="Center" ItemsSource="{Binding Path=(local:App.ExtensionAdds)}" ItemTemplate="{StaticResource extensionItem}"/>
        </Menu>
        <ContentControl Content="{Binding Path=DialogViewModel}"  Margin="0,50,0,0"/>
        
    </Grid>
</Window>

　　

源码下载