一、演示概述
本示例演示如何使用MEF提供的目录(Catalog)的扩展机制实现可过滤导出部件的自定义目录类。主要是通过继承ComposablePartCatalog基类,并实现接口INotifyComposablePartCatalogChanged来完成的。
相关下载(屏幕录像):
http://yunpan.cn/cVkvuUNfuDtTX 访问密码 567d
温馨提示:如果屏幕录像和代码不能正常下载,可站内留言,或发邮件到[email protected]
欢迎有兴趣研究.NET相关技术的网友加QQ群:18507443
二、自定义部件目录类Catalog
在MEF中,除了可以使用自身提供的注入AggregateCatalog、AssemblyCatalog、DirectoryCatalog这样的目录类以外,也可以自己定义目录类。
自定义目录类需要继承自ComposablePartCatalog类,并实现接口INotifyComposablePartCatalogChanged即可。如下面所示的代码:
public class FilteredCatalog : ComposablePartCatalog, INotifyComposablePartCatalogChanged
{
#region Private Fields
private readonly ComposablePartCatalog m_ComposablePartCatalog;
private readonly INotifyComposablePartCatalogChanged m_NotifyComposablePartCatalogChanged;
private readonly IQueryable<ComposablePartDefinition> m_Parts;
#endregion
#region Constructors
/// <summary>
/// 默认构造函数。
/// </summary>
/// <param name="composablePartCatalog">包含了所有导出部件的目录Catalog。</param>
/// <param name="expression">筛选条件表达式。</param>
public FilteredCatalog(ComposablePartCatalog composablePartCatalog, Expression<Func<ComposablePartDefinition, bool>> expression)
{
m_ComposablePartCatalog = composablePartCatalog;
m_NotifyComposablePartCatalogChanged = composablePartCatalog as INotifyComposablePartCatalogChanged;
m_Parts = composablePartCatalog.Parts.Where(expression);
}
#endregion
#region INotifyComposablePartCatalogChanged
/// <summary>
/// 部件目录Catalog已经改变后触发的事件。
/// </summary>
public event EventHandler<ComposablePartCatalogChangeEventArgs> Changed
{
add
{
if (m_NotifyComposablePartCatalogChanged != null)
{
m_NotifyComposablePartCatalogChanged.Changed += value;
}
}
remove
{
if (m_NotifyComposablePartCatalogChanged != null)
{
m_NotifyComposablePartCatalogChanged.Changed -= value;
}
}
}
/// <summary>
/// 部件目录Catalog正在发生改变时触发的事件。
/// </summary>
public event EventHandler<ComposablePartCatalogChangeEventArgs> Changing
{
add
{
if (m_NotifyComposablePartCatalogChanged != null)
{
m_NotifyComposablePartCatalogChanged.Changing += value;
}
}
remove
{
if (m_NotifyComposablePartCatalogChanged != null)
{
m_NotifyComposablePartCatalogChanged.Changing -= value;
}
}
}
#endregion
#region ComposablePartCatalog
/// <summary>
/// 获取目录中包含的部件定义。经过构造函数中的表达式过滤后,已经是传入目录Catalog对象中的一部分导出部件了。
/// </summary>
public override IQueryable<ComposablePartDefinition> Parts
{
get { return m_Parts; }
}
#endregion
}
上述代码中概括来说包含如下几点内容:
1、构造函数传递了基础目录Catalog对象,这个目录对象可能包含了很多的导出部件,我们要实现的目录过滤类FilteredCatalog就是基于这个目录进行过滤的,它是个全集,而FilteredCatalog是它的子集。另外一个参数是过滤表达式,过滤条件由调用者来编写,至于内部过滤办法实际还是LINQ提供的Where()方法。
2、对于接口INotifyComposablePartCatalogChanged的实现,实际上是和基础目录Catalog对象的事件关联在一起,即当基础目录对象发生改变时,目录过滤类FilteredCatalog也将会收到相应的通知。
3、重写了基类ComposablePartCatalog的Parts集合属性,该属性返回的就是该目录中包含部件定义,凡是在目录中需要被暴露的部件定义都是通过该集合返回的。因此,上述代码中将过滤后的部件定义通过该属性返回。
定义好了过滤类,接下来就是如何使用它了。
三、使用自定义目录类Catalog
如下代码所示:
// 获取所需的部件。
DirectoryCatalog catalog = new DirectoryCatalog("controls");
CompositionContainer container = new CompositionContainer(catalog);
// 过滤Catalog,生成子组合容器。
FilteredCatalog filteredCatalog = new FilteredCatalog(catalog,
o=>o.Metadata.ContainsKey("UC") && o.Metadata["UC"].ToString() == "BB");
CompositionContainer filteredContainer = new CompositionContainer(filteredCatalog, container);
UserControl userControl = filteredContainer.GetExportedValue<UserControl>();
this.MainContentControl.Content = userControl;
首先通过DirectoryCatalog类获取到应用程序根目录下controls子文件夹中的所有部件定义,并以此生成顶级组合容器container(类型为CompositionContainer)。
然后使用自定义目录过滤类FilteredCatalog对DirectoryCatalog目录中的部件定义进行过滤,并生成子组合容器filteredContainer(类型为CompositionContainer)。
最后通过组合容器的GetExportedValue<T>()方法获取指定协议类型的导出部件。需要说明的是,如果组合容器中没有对应协议类型的导出部件则会引发异常。
可通过如下地址获取完整的示例代码和屏幕录像文件。
四、相关资源
1、MSDN官方资料:
http://msdn.microsoft.com/zh-cn/library/dd460648(v=vs.110).aspx
2、参考了微软MVP Bēniaǒ的文章《MEF程序设计指南七:使用目录(Catalog)动态装载xap与目录筛选(Filtered Catalog)》,