.NET Core 和 .NET Framework 中的 MEF2

MEF,Managed Extensibility Framework,现在已经发布了三个版本了,它们是 MEF 和 MEF2。

等等!3 去哪儿了?本文将教大家完成基于 MEF2 的开发。


MEF 和 MEF2

其实微软发布了四个版本的 MEF:

对于第一代的 MEF,我们这里就完全不说了,性能又差功能又少,没有利用价值。

对于 .NET Framework 4.5 里引入的 MEF2,性能上没能改进多少,倒是使用起来功能更多。详细资料和使用方法请参考微软官方的文档:

而本文主要说的 MEF2 是微软后来以 NuGet 包形式发布的 MEF2;适用于 .NET Framework 4.5 及以上、.NET Core 和各种 .NET 移动平台。它的接口相比于 .NET Framework 中原生带的已经变了,中文和英文的参考资料很少,几乎都是参考微软官方发布的文档才能使用。所以本文将为大家提供其中文的使用方法指导。

至于性能提升程度,我没有进行定量测试,所以直接从 IoC Container Benchmark - Performance comparison - www.palmmedia.de 一文中搬运了性能测试结果,如下:

性能报告

安装 MEF2

.NET Framework 中自带的 MEF 在程序集 System.ComponentModel.Composition.dll 中,命名空间为 System.ComponentModel.Composition。MEF2 随 NuGet 包发布,其 NuGet 包名是 Microsoft.Composition,命名空间为 System.Composition

Microsoft.Composition

所以,在需要使用 MEF2 的项目中安装以上 NuGet 包即可完成安装。

使用 MEF2 开发

MEF 完全使用特性来管理容器中的依赖,微软称之为 Attributed Programming Model,并辅以广告——不需要配置文件的依赖注入容器。所以,使用特性来标记依赖关系就成了 MEF 的招牌依赖管理方式。

使用方法我将分为两个部分来讲,最容易的是业务代码,给开发团队中所有成员使用的代码。比较难的是框架代码,给开发团队中写框架的那一部分成员。

业务代码

业务代码的写法其实取决于框架开发者怎么去定义框架。但是,为了方便大家理解,在这一节我将只说 MEF2 最原生的使用方法。框架那一节我才会说明如何自定义业务代码的写法。

最原生的使用方法其实只有两个——[Import][Export],其它都是变种!具体说来,标记了 Export 的类将导出给其它类使用;标记了 Import 的属性/字段/方法参数等将接收来自 Export 的那些类/属性/字段的实例。

Import/Export

在类型上标记 [Export] 可以让容器发现这个类型。[Export] 允许带两个参数,一个契约名称,一个契约类型。在 [Import] 的时候,相同的契约名称会被注入;与属性或字段的类型相同的契约类型会被注入。

IEnumerable/Lazy

如果属性或字段是集合类型,可以使用 [ImportMany] 来注入集合(如果 Export 有多个)。

如果属性或字段是 Lazy<T> 类型,那么并不会立即注入,而是在访问到 Lazy<T>.Value 时才获取到实例(如果此时的创建过程由容器处理,那么第一次访问 Value 时才会创建)。

框架代码

框架代码也分为两个部分:一个部分是初始化,初始化后可以创建一个依赖注入容器;另一个部分是管理依赖,将使用之前初始化好的依赖注入容器进行管理。

初始化的最简代码如下:

var compositionHost = new ContainerConfiguration().CreateContainer();

那么,得到的 compositionHost 变量将是用来管理依赖的容器,你可以将它储存在字段中用于随后管理依赖。

但是,只是这么初始化将得不到任何对象。所以,我们需要额外添加配置代码,以便将一些程序集中的对象添加到容器中:

var compositionHost = new ContainerConfiguration().WithAssemblies(new []
{
    typeof(A).Assembly,
    typeof(B).Assembly,
    typeof(C).Assembly,
    typeof(D).Assembly,
}).CreateContainer();

这样,A/B/C/D 这四个类分别所在的程序集中,直接或间接加了 [Export] 特性的类都将被此依赖容器管理。

MEF2 之所以为 2,因为它除了能通过 [Export] 特性导出,还能直接在框架中发现而不必由业务开发者手动指定。这在第三方代码或者不希望被 MEF 侵入的代码中非常有用。例如,我们将所有已有的 ViewModel 导出:

// 使用 ConventionBuilder 自动导出所有的 ViewModel。
var convention = new ConventionBuilder();

// 将所有继承自 ViewModelBase 的类导出,并共享一个实例(即注入到多个属性中的都是同一个实例)。
convention.ForTypesDerivedFrom<ViewModelBase>().Export().Shared();

// 使用这些配置创建依赖注入容器。
var compositionHost = new ContainerConfiguration().WithAssemblies(new []
{
    typeof(A).Assembly,
    typeof(B).Assembly,
    typeof(C).Assembly,
    typeof(D).Assembly,
}).WithDefaultConventions(convention).CreateContainer();;

注意,以上代码中的 .Shared() 目的是让导出的 ViewModel 共享实例(同一个类型的实例只有一个)。

只初始化是不行的,还需要将这些依赖注入到目标实例中才行。使用 SatisfyImports 可以将传入的对象中的所有依赖注入进去。

compositionHost.SatisfyImports(targetObject);

在框架设计中,对于不同模块中的类型,框架需要决定使用哪一个容器来注入,或者是否注入。所以上面这个代码会发生在使用 MEF2 框架中需要注入的任何一个部分。


参考资料

本文会经常更新,请阅读原文: https://walterlv.com/post/mef2-from-nuget.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)