插件架构改进 C# 中的软件设计

在本文中，将向您介绍插件架构的概念，并特别关注 C# 中的插件架构以及如何探索加载插件信息。我们还将查看一些很有价值的插件高级示例情况 —— 但更详细地实现您可以作为家庭作业完成练习！

理解插件架构

那么，对于软件构建而言，插件架构到底是什么？插件架构是一种设计模式，允许您通过动态加载和执行外部模块或插件来扩展现有应用程序的功能。这些插件可以单独开发并添加到应用程序中，而无需修改核心代码库。这意味着我们可以添加新功能，甚至不需要重新构建原始核心应用程序的代码！

在 C# 应用程序中使用插件架构有几个好处，其中一些包括：

• 模块化：通过插件架构，应用程序的不同组件可以作为插件单独开发。这种模块化使您能够专注于特定功能，而不会影响应用程序的整体结构。它还使维护和更新更容易，因为插件可以独立添加或替换。
• 灵活性：通过使用插件架构，您可以轻松地向应用程序引入新特性或功能，而无需修改核心代码。这种灵活性允许快速开发和迭代，因为创建和集成新插件比修改核心共享代码需要更少的努力。
• 代码可重用性：插件可以作为可重用组件开发，可用于多个项目或应用程序。这种可重用性不仅节省了开发时间，而且促进了代码一致性并减少了引入错误的机会。
• 定制：插件架构允许用户或客户根据其特定需求定制和扩展应用程序的功能。这种定制可以通过简单地添加或删除插件来实现，而无需更改核心代码库。

总的来说，在我的开发中，C# 中的插件架构是我大量使用的东西，为构建软件提供了一种模块化和灵活的方法。

在 C# 中加载插件

在 C#中，有多种方法和技术可以将插件加载到您的软件解决方案中。加载插件可以为您的应用程序提供增强的功能和灵活性。让我们通过代码示例来探讨其中一些方法和技术。对于以下示例，假设我们有一个 IPlugin 接口，它简单地映射到以下代码：

public IPlugin
{
    void Execute();
}

C# 中使用反射动态加载程序集

在 C# 中加载插件的一种方法是通过动态加载程序集。这允许您在运行时加载外部 DLL 文件，其中可能包含插件所需的代码。以下是如何实现此目的的示例：

// Get the path to the plugin DLL
string pluginPath = "path/to/plugin.dll";

// Load the plugin assembly
Assembly assembly = Assembly.LoadFrom(pluginPath);

// Instantiate the plugin types
IEnumerable<Type> pluginTypes = assembly
    .GetTypes()
    .Where(t => typeof(IPlugin).IsAssignableFrom(t) && !t.IsAbstract);

// Create instances of the plugins
List<IPlugin> plugins = new();
foreach (Type pluginType in pluginTypes)
{
    IPlugin plugin = (IPlugin)Activator.CreateInstance(pluginType);
    plugins.Add(plugin);
}

// Use the plugins
foreach (IPlugin plugin in plugins)
{
    plugin.Execute();
}

在上面的代码中，我们首先使用 Assembly.LoadFrom 加载插件程序集。然后，我们使用反射找到实现 IPlugin 接口且不抽象的所有类型。我们使用反射（具体来说，使用 Activator.CreateInstance）创建这些插件类型的实例，并将它们存储在列表中。最后，我们可以通过调用它们的 Execute 方法来使用插件。

用于动态加载 C# 插件的 Autofac

C# 中我们可以使用 Autofac 扫描包含实现 IPlugin 接口的类型的程序集的目录并注册它们。以下是如何在 C# 中为此目的设置 Autofac 的示例：

using Autofac;
using System.Reflection;

public class PluginLoader
{
    public IContainer LoadPlugins(string pluginsPath)
    {
        var builder = new ContainerBuilder();

        // Scan the plugins directory for assemblies
        // and register types that implement IPlugin
        var types = Directory
            .GetFiles(pluginsPath, "*.dll")
            .Select(Assembly.LoadFrom)
            .ToArray();
        builder
            .RegisterAssemblyTypes(types)
            .AssignableTo<IPlugin>()
            .As<IPlugin>();

        return builder.Build();
    }
}

上面的代码将使用反射从插件目录中的程序集中获取类型。在这种情况下，它将尝试从该文件夹位置加载具有 DLL 扩展名的任何文件。从那里，我们可以要求 Autofac 注册这些类型，但我们使用 AssignableTo<T>() 方法将类型过滤为仅 IPlugin。最后，我们指示它们可以使用 As<T>() 方法解析为 IPlugin 实例。

以下代码示例构建容器，注册所有插件，然后模拟前面代码示例中的行为，在每个插件上调用 Execute()：

var pluginFolder = Path.Combine(
    Directory.GetCurrentDirectory(),
    "plugins");
var pluginLoader = new PluginLoader();
var container = pluginLoader.LoadPlugins(pluginFolder);

// Resolve all implementations of IPlugin and execute them
foreach (var plugin in container.Resolve<IEnumerable<IPlugin>>())
{
    plugin.Execute();
}

C#中实用插件架构的示例

现在我们已经了解了如何实现加载插件的方法，是时候看看 C# 应用程序中可能的插件架构的一些示例了。在这些示例中，我们不会详细介绍如何构建一个完整的应用程序，但是我们可以深入了解用例的一些高级细节、示例插件 API 的样子以及插件的用途。

动态数据可视化插件

C# 中插件架构的一个有趣用例是用于动态数据可视化。当处理大数据集或实时数据流时，这尤其有用。通过创建插件系统，可以开发单独的可视化模块，这些模块可以在运行时根据数据的类型和格式动态加载和卸载。我们可以将应用程序的核心建立在一两个可视化效果周围，而是将它们视为插件，以便随着应用程序的发展，在以后添加更丰富的可视化效果。

这是我们可以考虑的一些示例代码：

// Interface for the visualization plugin
public interface IVisualizationPlugin : IDisposable
{
    void Initialize();

    void RenderData(
        DataSet data,
        IVisualizationContext context);
}

// Example plugin implementation
public class BarChartPlugin : IVisualizationPlugin
{
    public void Initialize()
    {
        // Initialize the bar chart visualization
    }

    public void RenderData(
        DataSet data,
        IVisualizationContext context)
    {
        // Render the bar chart with the provided data
    }

    public void Dispose()
    {
        // Cleanup resources used by the bar chart
    }
}

在这个示例中，我们可能希望为插件设置一些可选的入口点。这就是我们的 Initialize() 方法。我们将每个标记为 IDisposable，以便确保在准备卸载每个插件时，每个插件都有适当的机会清理资源。RenderData 方法是发生神奇变化的地方，每个插件都可以获取传入的数据集和用于可视化的上下文对象。这个上下文对象是人为的，当然，它会严重依赖于应用程序，但它可能是允许插件向其中添加 UI 控件或插件可以直接在其上绘制可视化效果的表面。

用于文件处理的基于扩展的插件

C# 中另一个可能的插件架构示例是用于扩展文件处理能力。想象一下，您有一个文件处理应用程序，支持各种文件格式，如图像、文档和视频。通过实现插件系统，可以允许用户开发并动态加载自定义文件格式处理程序。

在下面的代码中，我们将看到一种插件格式，它允许我们检查插件是否可以支持文件扩展名。您可以想象，我们有一个类似 facade 的类，它会遍历每个插件来查看哪个插件支持它，并调用相关的插件来处理它：

// Interface for the file format plugin
public interface IFileFormatPlugin
{
    bool CanHandleFile(string filePath);

    void ProcessFile(string filePath);
}

// Example plugin implementation
public class PDFPlugin : IFileFormatPlugin
{
    public bool CanHandleFile(string filePath)
    {
        return filePath.EndsWith("pdf", StringComparison.OrdinalIgnoreCase);
    }

    public void ProcessFile(string filePath)
    {
        // Perform PDF-specific file processing
    }
}

自定义规则引擎插件

当为需要复杂验证或业务规则的应用程序实现自定义规则引擎时，插件架构也可能是有益的。通过使用插件，可以将规则引擎分解为单独的模块，并根据特定条件或触发器动态加载和执行它们。

在下面的代码示例中，我们使用了一个通常具有布尔返回类型和一个 out 参数来获取结果的 TryX 模式。在这种情况下，当规则评估不满足时，我们可以输出一个 Exception 实例。另一种方法是使用自定义多类型来拥有自己的返回类型，可以是结果或错误，或者使用 OneOf NuGet 包。让我们来看看：

// Interface for the rule plugin
public interface IRulePlugin
{
    string RuleName { get; }

    bool TryEvaluateRule(
        object target,
        out Exception error);
}

// Example plugin implementation
public class AgeValidationPlugin : IRulePlugin
{
    public string RuleName { get; } = "AgeValidation";

    public bool TryEvaluateRule(
        object target,
        out Exception error)
    {
        // Check if the target object meets the age validation criteria
    }
}

基于插件的认证系统

插件架构也可以应用于认证系统，允许集成各种认证提供者，如 OAuth、Active Directory 或自定义认证机制。通过创建认证插件，可以实现灵活性，并轻松在不同的认证方法之间切换，而无需将应用程序与特定实现紧密耦合。

这是一个高度简化的插件 API，展示了目标，但任何使用过真实认证系统的人都可能意识到这是非常简单的：

// Interface for the authentication plugin
public interface IAuthenticationPlugin
{
    bool AuthenticateUser(string username, string password);
}

// Example plugin implementation
public class OAuthPlugin : IAuthenticationPlugin
{
    public bool AuthenticateUser(string username, string password)
    {
        // Authenticate the user using OAuth protocol
    }
}

虽然这个例子可能有点轻描淡写，但重点是指出用例 —— 应用程序中的认证可以成为迁移到插件的一件好事。如果您正在开发可能需要不同认证集成的东西，利用插件与每个插件进行接口并仍然为您的应用程序提供认证将是一个很好的机会。