添加插件支持：接口或基类继承？

Question

我正在为我的.NET应用程序添加插件支持。 基类对我来说听起来很合理，所以人们可以继承它并覆盖某些调用，也可以保留默认功能或者可以使用一些内部帮助函数。

为什么我要选择接口而不是基础插件类来继承？ 你能说出我应该选择哪种设计以及为什么？

Answer 1

您应该考虑查看System.Addin（MAF）命名空间或Managed Extensibility Framework（MEF）。 MEF将是首选，即使它仍然是预发布的，因为它比MAF简单得多。 这些选择中的任何一个都简化了为了使加载项加载并与它们交互而需要执行的大量管道工作。

至于在接口和抽象类之间做出选择，如果你使用MAF或MEF，那么将为你做一些。 此上下文中最基本的区别在于，通过提供抽象基类，您可以为自定义插件（由您或其他开发人员编写）提供继承点，并确保某些方法/属性提供默认行为并强制派生类实现某些所需的方法/属性。 缺点是您只能使用一个基类。

接口绕过单个基类限制，仍然为自定义插件提供了一个插入点，并确保实现某些方法/属性，但不能提供任何类型的默认行为。 您还不能在接口中指定除公共成员之外的任何内容，而抽象类可以具有抽象或虚拟非公共成员（通常受保护）。

Answer 2

使用插件合同的界面。 如果某种类型的插件可能共享某些功能，请创建一个实现该接口的抽象基类。 还要确保您的合同处于实际应用程序之外的程序集中。

请记住，在.NET中，您没有多重继承。 要求实施者放弃他们的继承槽以为他们提供一些功能并不是一个好主意。

Answer 3

为什么它必须是一个或另一个？

您可以定义插件必须遵循的合同作为在任何地方引用的接口。

此外，您还可以定义实现该接口的基类，但仅具有为某些无法提供默认实现的接口函数调用的抽象方法。

public interface IPlugin
{
    void Initialize ();
    void Stuff ();
}

public class PluginBase : IPlugin
{
    protected abstract DoInitialize ();
    protected abstract DoStuff ();

    void IPlugin.Initialize { this.DoInitialize (); }
    void IPlugin.Stuff { this.DoStuff (); }
}

Answer 4

这里有一个关于这个主题的好文章： 插件API设计

我个人会使用一个接口，让插件实现所有细节。

Answer 5

我认为你应该做的显而易见的事情是让插件为它想要处理的各个事件注册回调（委托）。 这是大多数框架在.net中工作的方式

换句话说，既不是基类也不是接口。 此解决方案的优点是您的插件不必符合任何给定的外部接口或基类，它只需注册它所需的功能。

例如，任何给定的asp.net控件中的“事件”部分都是这样做的：看看UserControl

Answer 6

每个人都忘记提到的东西是向后兼容性。 您可以在不破坏现有客户端的情况下向基类添加新方法，而无法在不影响现有接口的情况下修改现有接口。

有一些替代方法可以避免接口的兼容性问题。 例如，当您为应用程序包含新扩展时，可以创建一个继承旧接口的新接口。 但是这样做的缺点是使用IClientInterfaceV2和IClientInterfaceV3等类型来扩展您的体系结构。

我个人的建议是采用scwagner建议的方法，并创建基类和接口。 并向接口用户发出警告，指出未来版本可能会破坏其实现，并且建议使用基类继承策略以避免将来出现兼容性问题。