C# 中如何使用MEF插件

概述

MEF（Managed Extensibility Framework）是 .NET 框架中的一个库，用于创建可扩展的应用程序。它允许开发者通过插件的方式动态加载和组合应用程序的功能模块。MEF 的核心思想是通过“导入”和“导出”机制来实现组件之间的松耦合。

本文将介绍如何在 C# 中使用 MEF 插件，包括如何定义插件、如何加载插件以及如何在应用程序中使用插件。

1. 安装 MEF

首先，你需要在项目中安装 MEF。可以通过 NuGet 包管理器来安装 System.ComponentModel.Composition 包。

Install-Package System.ComponentModel.Composition

2. 定义插件接口

在使用 MEF 之前，首先需要定义一个插件接口。这个接口将作为所有插件的契约，确保插件能够被正确加载和使用。

public interface IPlugin
{
    string Name { get; }
    void Execute();
}

3. 实现插件

接下来，你可以创建一个或多个插件类来实现这个接口。每个插件类都需要标记为 [Export]，以便 MEF 能够识别并加载它们。

[Export(typeof(IPlugin))]
public class HelloWorldPlugin : IPlugin
{
    public string Name => "HelloWorldPlugin";

    public void Execute()
    {
        Console.WriteLine("Hello, World!");
    }
}

[Export(typeof(IPlugin))]
public class GoodbyeWorldPlugin : IPlugin
{
    public string Name => "GoodbyeWorldPlugin";

    public void Execute()
    {
        Console.WriteLine("Goodbye, World!");
    }
}

4. 创建插件容器

为了加载和使用插件，你需要创建一个 CompositionContainer。这个容器将负责发现和组合所有导出的插件。

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

public class PluginManager
{
    [ImportMany]
    public IEnumerable<IPlugin> Plugins { get; set; }

    public void LoadPlugins()
    {
        var catalog = new AggregateCatalog();
        catalog.Catalogs.Add(new AssemblyCatalog(typeof(Program).Assembly));

        var container = new CompositionContainer(catalog);
        container.ComposeParts(this);
    }
}

在上面的代码中，PluginManager 类包含一个 Plugins 属性，该属性被标记为 [ImportMany]，表示它可以导入多个 IPlugin 类型的插件。LoadPlugins 方法使用 AggregateCatalog 来收集所有可用的插件，并通过 CompositionContainer 将它们组合到 PluginManager 实例中。

5. 使用插件

一旦插件被加载，你就可以在应用程序中使用它们了。

class Program
{
    static void Main(string[] args)
    {
        var pluginManager = new PluginManager();
        pluginManager.LoadPlugins();

        foreach (var plugin in pluginManager.Plugins)
        {
            Console.WriteLine($"Executing plugin: {plugin.Name}");
            plugin.Execute();
        }
    }
}

在这个示例中，Main 方法创建了一个 PluginManager 实例，并调用 LoadPlugins 方法来加载所有插件。然后，它遍历所有加载的插件，并调用它们的 Execute 方法。

6. 动态加载插件

MEF 还支持从外部程序集动态加载插件。你可以通过 DirectoryCatalog 来加载指定目录下的所有插件。

public void LoadPluginsFromDirectory(string path)
{
    var catalog = new AggregateCatalog();
    catalog.Catalogs.Add(new DirectoryCatalog(path));

    var container = new CompositionContainer(catalog);
    container.ComposeParts(this);
}

在这个方法中，DirectoryCatalog 会扫描指定目录下的所有程序集，并加载其中包含的插件。

7. 处理插件依赖

有时，插件可能需要依赖其他插件或服务。MEF 允许你通过 [Import] 和 [Export] 属性来处理这些依赖关系。

[Export(typeof(ILogger))]
public class ConsoleLogger : ILogger
{
    public void Log(string message)
    {
        Console.WriteLine(message);
    }
}

[Export(typeof(IPlugin))]
public class DependentPlugin : IPlugin
{
    [Import]
    public ILogger Logger { get; set; }

    public string Name => "DependentPlugin";

    public void Execute()
    {
        Logger.Log("DependentPlugin is executing.");
    }
}

在这个示例中，DependentPlugin 依赖于 ILogger 服务。MEF 会自动将 ConsoleLogger 实例注入到 DependentPlugin 中。

8. 总结

MEF 是一个强大的工具，可以帮助你创建可扩展的应用程序。通过定义插件接口、实现插件、创建插件容器以及动态加载插件，你可以轻松地将新功能添加到应用程序中，而无需修改现有代码。

本文介绍了如何在 C# 中使用 MEF 插件，包括如何定义插件接口、实现插件、加载插件以及处理插件依赖。希望这些内容能帮助你更好地理解和使用 MEF。