.NET自带IOC容器MEF之初体验(转)

本文主要把MEF作为一种IOC容器进行讲解，.net中可用的IOC容器非常多，如 CastleWindsor，Unity，Autofac，ObjectBuilder，StructureMap，Spring.Net等，这些第三方工具各不相同，但功能大体都相同，大都需要事先对接口与实现进行配对（通过代码或配置文件），然后由系统自动或手动来通过接口来获得相应实现类的实例，对象实例化的工作由IOC容器自动完成。

概述   

官方说法： Managed Extensibility Framework（MEF）是.NET平台下的一个扩展性管理框架，它是一系列特性的集合，包括依赖注入（DI）等。MEF为开发人员提供了一个工具，让我们可以轻松的对应用程序进行扩展并且对已有的代码产生最小的影响，开发人员在开发过程中根据功能要求定义一些扩展点，之后扩展人员就可以使用这些扩展点与应用程序交互；同时MEF让应用程序与扩展程序之间不产生直接的依赖，这样也允许在多个具有同样的扩展需求之间共享扩展程序。

解决的问题   

MEF解决了什么呢？以往，如果一个应用程序需要支持插件方式必须要实现自己的底层并且这些插件通常是针对特有应用的，不能被其他应用所使用。实际上MEF提供了发现和组合的能力使你的应用程序可以加载扩展，为运行时的可扩展性提供了一种简单的解决方法：  MEF为宿主应用提供了一种标准的途径来暴露自身并使用外部扩展。而扩展本身是可以被不同的应用程序所使用的。而一个扩展依旧可以通过针对特定应用的方法来实现。扩展之间也可以存在依赖关系，MEF则会自动将它们按照正确的顺序进行调用。MEF还提供了一些用来定位和加载可用扩展的方法。MEF允许使用附加元数据对扩展进行标记，从而达到易于丰富的查询和筛选的目的。

工作原理

简短说一下MEF的工作原理，MEF的核心包括一个catalog和一个CompositionContainer。category用于发现扩展，而container用于协调创建和梳理依赖性。每个可组合的Part提供了一个或多个Export，并且通常依赖于一个或多个外部提供的服务或Import。每个Part管理一个实例为应用程序运行

MEF 提供一种通过“组合”隐式发现组件的方法。 MEF 组件（称为“部件-Part”）。部件以声明方式同时指定其依赖项（称为“导入-Import”）及其提供的功能（称为“导出-Export”）。MEF原理上很简单，找出有共同接口的导入、导出。然后找到把导出的实例化，赋给导入。说到底MEF就是找到合适的类实例化，把它交给导入。

如何声明一个部件-导入与导出

导出”是部件向容器中的其他部件提供的一个值，而“导入”是部件向要通过可用导出满足的容器提出的要求。 在特性化编程模型中，导入和导出是由修饰类或成员使用 Import 和Export 特性声明的。 Export 特性可修饰类、字段、属性或方法，而 Import 特性可修饰字段、属性或构造函数参数。为了使导入与导出匹配，导入和导出必须具有相同的协定。

假设有一个类MyClass，它声明了可以导入插件的类型是IMyAddin。

public class MyClass
{
    [Import]
    public IMyAddin MyAddin { get; set; }
}

这里有一个类，它声明为导出。类型同样为IMyAddin。

[Export(typeof(IMyAddin))]
public class MyLogger : IMyAddin { }

这样我们使用MyAddin属性的时候就可以获得到MyLogger的实例。

发现部件

MEF提供三种方式发现部件

• AssemblyCatalog 在当前程序集发现部件。
• DirectoryCatalog 在指定的目录发现部件。
• DeploymentCatalog 在指定的XAP文件中发现部件（用于silverlight）

当通过不同方式发现部件的时候，还可以使用AggregateCatalog来把这些部件聚合到一起。

var catalog = new AggregateCatalog();
            //把从Program所在程序集中发现的部件添加到目录中
            catalog.Catalogs.Add(new AssemblyCatalog(typeof(Program).Assembly));
            //把从指定path发现的部件添加到目录中
            catalog.Catalogs.Add(new DirectoryCatalog("C:\\Users\\v-rizhou\\SimpleCalculator\\Extensions"));

如何组合部件？

在加载完部件之后，要把它们放到一个CompositionContainer容器中。

var container = new CompositionContainer(catalog)

通过调用容器的ComposeParts()方法可以把容器中的部件组合到一起。

container.ComposeParts(this);

下面我们使用一个简单的列子学习使用MEF

1、         项目结构图

注：三个项目都要添加System.ComponetModel.Composition.dll的引用。

2、         METTest项目

(1)、IHelloWord.cs

为我们定义的接口，只有两个简单方法，代码如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace METTest
{
    public interface IHelloWord
    {
         string SayHello(string str);
         string SayWord(string str);
    }
}

(2) HelloWord.cs

该文件继承IHelloWord接口并实现接口中的方法，HelloWord类被声明成internal防止方法在类外被引用，用[Export(typeof(IHelloWord))]修饰声明该类为导出，类型为IHelloWord，代码如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel.Composition;

namespace METTest
{
    [Export(typeof(IHelloWord))]
   internal class HelloWord:IHelloWord
    {
       public string SayHello(string str)
       {
           return "Hello" + str;
       }
       public string SayWord(string str)
       {
           return str;
       }
    }
}

(3) HelloWordB.cs

该文件先不用看，下面用到了在做说明

3、         METTest1项先不管，下面用到了在做说明

4、         MEFConsoleApplication

该项目为控制台项目，添加对METTest的引用，不要添加对METTest1项目的引用。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel.Composition;
using METTest;
using System.Reflection;
using System.ComponentModel.Composition.Hosting;
using System.IO;

namespace MEFConsoleApplication
{
   [Export]
    class Program
    {
        [Import]
       public IHelloWord HelloWord { get; set; }

        static void Main(string[] args)
        {
            Program p = new Program();
            p.Method();
        }

        public void Method()
        {
            AggregateCatalog catelog = new AggregateCatalog();
            catelog.Catalogs.Add(new DirectoryCatalog(Directory.GetCurrentDirectory()));//查找部件，当前应用程序

            //catelog.Catalogs.Add(new DirectoryCatalog(@"../../../MEFTest1/bin/Debug"));//这个我们通过路径找到部件
            //catelog.Catalogs.Add(new AssemblyCatalog(Assembly.GetExecutingAssembly()));
            CompositionContainer  container = new CompositionContainer(catelog);//声明容器
            container.ComposeParts(this);//把容器中的部件组合到一起
            //CompositionBatch Batch = new CompositionBatch();
            //Batch.AddPart(this);
            //container.Compose(Batch);
            //HelloWord = container.GetExportedValue<IHelloWord>();//这样也可以实例化借口
            Console.WriteLine(HelloWord.SayHello("eric"));
            Console.WriteLine(HelloWord.SayWord("_eric"));

            Console.Read();
        }
    }
}

运行结果：

5、下面我们来看一下一个接口被多个类实例化

当一个接口被多个类实例化时，用ImportMany 声明，具体如下

[ImportMany]
public IEnumerable<IHelloWord> HelloWord { get; set; }

打开HelloWordB.cs文件继承IHelloWord，并用[Export(typeof(IHelloWord))]修饰。这样HelloWord和HelloWordB都继承了IHelloWord，并且用[Export]声明。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel.Composition;

namespace METTest
{
    [Export(typeof(IHelloWord))]
   internal class HelloWordB:IHelloWord
    {
        public string SayHello(string str)
        {
            return "我是HelloB:" + str;
        }

        public string SayWord(string str)
        {
            return "B_"+str;
        }
    }
}

修改MEFConsoleApplication项目的Program.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel.Composition;
using METTest;
using System.Reflection;
using System.ComponentModel.Composition.Hosting;
using System.IO;

namespace MEFConsoleApplication
{
   [Export]
    class Program
    {
        [ImportMany]
       public IEnumerable<IHelloWord> HelloWord { get; set; }

        static void Main(string[] args)
        {
            Program p = new Program();
            p.Method();
        }

        public void Method()
        {
            AggregateCatalog catelog = new AggregateCatalog();
            catelog.Catalogs.Add(new DirectoryCatalog(Directory.GetCurrentDirectory()));//查找部件，当前应用程序

            //catelog.Catalogs.Add(new DirectoryCatalog(@"../../../MEFTest1/bin/Debug"));//这个我们通过路径找到部件
            //catelog.Catalogs.Add(new AssemblyCatalog(Assembly.GetExecutingAssembly()));
            CompositionContainer  container = new CompositionContainer(catelog);//声明容器
            container.ComposeParts(this);//把容器中的部件组合到一起
            //CompositionBatch Batch = new CompositionBatch();
            //Batch.AddPart(this);
            //container.Compose(Batch);
            //HelloWord = container.GetExportedValue<IHelloWord>();//这样也可以实例化借口
            //Console.WriteLine(HelloWord.SayHello("eric"));
            //Console.WriteLine(HelloWord.SayWord("_eric"));
            foreach (var item in HelloWord)
            {
                Console.WriteLine(item.SayHello("eric"));
            }
            Console.Read();
        }
    }
}