我学MEF系列(9):搭建一个简单的组合引擎(ComposionEngine)
2012-01-31 17:14 ps_zw 阅读(1432) 评论(4) 编辑 收藏 举报前言
我们使用MEF的原因是因为它可以帮助我们解决很多现实问题。在实际项目中我们会将它进行封装以方便使用,使同一个team有一套使用MEF的标准机制。本文就来搭建一个简单的组合引擎。
引擎应该具备的功能
1.定义一个引擎类它可以组合指定的Catalog;
2.它可以根据需要启动指定的扩展组件;
3.引擎是可以停止的,这里就是通过它可以销毁组合容器;
4.能够提供一组组合规则(可以通过元数据等方式实现),这点本文没有实现;
5.为扩展组件提供统一的接口,方便扩展。
搭建引擎
步骤1:新建项目ComposionEngineCore和项目MEFDemo_Console,如下图所示:
步骤2:在项目ComposionEngineCore中添加接口(抽象类):IStartable<T> ,它实现了接口IPartImportsSatisfiedNotification
代码如下:
1 /// <summary>
2 /// 通用接口
3 /// </summary>
4 /// <typeparam name="T"></typeparam>
5 [InheritedExport]
6 public abstract class IStartable<T> : IPartImportsSatisfiedNotification
7 {
8 public abstract void Start(T parameter);
9
10 public void OnImportsSatisfied()
11 {
12 Console.WriteLine(this.GetType().FullName + " has composed!");
13 }
14 }
步骤3:添加类:ComposionEngine<T> ,它提供了Start方法用来启动扩展组件,代码如下:
1 /// <summary>
2 /// 组合引擎
3 /// </summary>
4 /// <typeparam name="T"></typeparam>
5 public class ComposionEngine<T>
6 {
7 private CompositionContainer _container;
8
9 /// <summary>
10 /// 根据给定的Catalog构造组合引擎
11 /// </summary>
12 /// <param name="catalogs"></param>
13 public ComposionEngine(params ComposablePartCatalog[] catalogs)
14 {
15 var aggregate = new AggregateCatalog(catalogs);
16 _container = new CompositionContainer(aggregate);
17 }
18
19 /// <summary>
20 /// 根据给定的容器构造组合引擎
21 /// </summary>
22 /// <param name="container">给定组合容器</param>
23 public ComposionEngine(CompositionContainer container)
24 {
25 if (container == null)
26 throw new ArgumentNullException("container");
27 _container = container;
28 }
29
30 /// <summary>
31 /// 使用默认的Catalog构造组合引擎
32 /// </summary>
33 public ComposionEngine()
34 {
35 _container = new CompositionContainer(new AssemblyCatalog(Assembly.GetCallingAssembly()));
36 }
37
38 /// <summary>
39 /// 启动给定参数的组件
40 /// </summary>
41 /// <param name="parameters">给定组件</param>
42 public void Start(T parameters)
43 {
44 Console.WriteLine("Compose has started!");
45 var startables = _container.GetExportedValues<IStartable<T>>();
46 foreach (var startable in startables)
47 {
48 startable.Start(parameters);
49 }
50 }
51
52 /// <summary>
53 /// 启动默认的组件
54 /// </summary>
55 public void Start()
56 {
57 Start(default(T));
58 }
59
60 /// <summary>
61 /// 注销容器
62 /// </summary>
63 public void Stop()
64 {
65 if (_container == null)
66 {
67 throw new InvalidOperationException("Stop can only be called once");
68 }
69 _container.Dispose();
70 _container = null;
71 }
72 }
通过前面三步,我们一个简单的组合引擎(或者称之为组合启动器)就搭建好了。下面一下如何使用:
1.在MEFDemo_Console中添加类MyEngineTest,使之实现接口IStartable<T>.代码如下:
1 public class MyEngineTest : IStartable<object>
2 {
3 public override void Start(object extension)
4 {
5 Console.WriteLine("MyEngineTest's method 'Start' has called !");
6 }
7 }
2.在Program.cs中创建组合引擎,并启动:
1 static void Main(string[] args)
2 {
3 var engine = new ComposionEngine<object>();
4 engine.Start();
5
6 Console.WriteLine("Press any key to continue !");
7 Console.ReadKey();
8 }
运行结果如下:
通过测试我们发现这个组合引擎基本上可以使用了,在实际项目中我们可以通过元数据(Metadata),或者其他方式来控制扩展组件的启动和组合。
本文参考:http://codebetter.com/glennblock/2010/01/15/hosting-mef-within-your-applications/
源码下载地址:MEFDemo.7z