jjzjj

用C++实现插件模式时的避坑要点

如何开发工业软件 2023-04-17 原文

本文不打算严格地、用标准术语来讲前因后果。本文主要分析实践中常见的、因为对原理不清楚而搞出来的产品里的坑。

什么是插件模式和为什么要用插件模式

插件，Plug-In，或者（IE/Edge称之为）加载项/Add-On，（Office称之为）外接程序/Add-In，（GIMP称之为）扩展/Extension，等等，总之看字面意思都是“额外增加功能”的这种东西，是一类开发模式。基本思路就是，研发软件本体的时候，外部需求不明确、直到使用期仍然经常会增加功能细节。为了把变动部分切割开，在设计的时候，通过对可变部分的归纳分析，对可变部分抽象出一套接口；每套外部需求用动态库之类的形式实现接口；软件本体按某种约定，加载动态库，并从中获取插件实例，通过接口来调用满足当时需求的功能实现。

可以看到，插件的思想，其实就是灵活运用“动态库”的动态加载能力，把对“接口”的实现移到软件本体之外，并用工厂模式来约束动态库的实现方式。

只要是具有动态加载能力的运行环境上，都可以使用插件模式来设计软件系统。极端一些的软件系统，甚至只提供基础平台，所有功能都由插件的方式提供，例如 Visual Studio Code 、 Eclipse 等。

C++实现插件模式

用C++实现插件模式，一般是把下面这些功能组合起来：

  • 用一个C++的带虚函数的基类来表示功能
  • 约定动态库里的工厂模式接口
  • 在一些动态库里提供实现虚函数的派生类
  • 在动态库里实现工厂模式

不幸的是，由于各操作系统的动态库机制普遍是C风格的，用C++做动态库时候的坑，在用C++实现插件模式时，全都会遇到。比如：

  • C++的编译器差异导致的不互通
    会导致必须用同一种（或兼容的）编译器来生成插件和软件本体。
    • 名字改写（Name Mangling）：参考：Wikipedia、HappenLee的解说
      会导致加载插件时“找不到符号”
    • 虚函数（表）实现：
      会导致加载插件时可能不报错，但运行时候找不到正确的虚函数入口
  • 操作系统机制导致的不互通
    • Windows上使用MSVCRT时的内存分配和回收
      Windows每个模块的内存分配默认是在模块自己的堆里的，而Windows上的C运行时库（各种MSVCRT）为了封装出 malloc 、 free 等C函数的效果，建立了__crtheap（2010及之前版本行为）或直接使用进程默认堆（2015及之后版本行为）[1]。这导致，即使是同一个编译器，静态链接VC运行时会采用本模块内部的堆来实现 malloc 等，而动态链接VC运行时则会采用MSVCRT动态库DLL的模块堆。需要解决好“谁申请谁释放”的问题，否则内存管理的地方容易出异常。
    • 全局变量在模块间的共享问题

一些典型的不良实现

这里说的不良实现，使用时候未必会错或崩，但早晚要崩，或者会限制住插件的开发。以下用如下插件接口作为例子。

// IFilter.h

/// 滤波器接口.
class IFilter {
protected:
    IFilter();
public:
    virtual ~IFilter();
public:
    /// 一个将输入复数数组处理为输出复数数组的函数.
    virtual void Filter(const std::complex<double>* acdIn, std::complex<double>* acdOut, size_t uLen) = 0;
    /// 获取当前实现的一些描述字符串.
    virtual std::string GetDescription() const = 0;
};

// IFilter.cpp
IFilter::IFilter() { }
IFilter::~IFilter() { }

并约定插件实现中以如下形式提供工厂函数。

// FilterPluginDll.h
#include "IFilter.h"
/* 插件DLL应该提供如下函数 
extern "C" int GetFilterPluginInDll(char* szFilterNamesBuf, size_t uBufLen);
extern "C" IFilter* BuildFilterPlugin(const char* szFilterName);
extern "C" void FreeFilterPlugin(IFilter* pFilter);
*/
typedef int (*PFNGetFilterPluginInDll)(char* szFilterNamesBuf, size_t uBufLen);
typedef IFilter* (*PFNBuildFilterPlugin)(const char* szFilterName);
typedef void (*PFNFreeFilterPlugin)(IFilter* pFilter);

接口类没有提供二进制实现

比如，对插件只发布两个头文件；认为 IFilter 的构造和析构反正是空函数无所谓，直接写在类定义里。

这样，插件开发者自己生成插件DLL时，会在自己的DLL里链接进一份 IFilter::IFilter() 和 IFilter::~IFilter() 的实现，而软件本体里也有一份自己的实现。虽然看上去，如果编译器一样，两份实现是等同的，但考虑到它们使用了不同的模块堆，以及其它各种原因，插件DLL中的 IFilter 和软件本体里的 IFilter 并不是完全等同的。

这里应该由软件本体导出 IFilter::IFitler() 和 IFilter::~IFilter() 等接口类的共性成分的实现给插件，以免出现一些奇怪的问题。

工厂函数里没有正确设计“谁分配谁释放”

比如，为了“简单”，只要求了 BuildFilterPlugin 工厂函数，认为可以由软件本体用 delete pFilter; 来释放插件实例。

一种建议的实现方法

用类似于Windows的COM风格的“放了一堆函数指针的结构体”来表示插件的接口定义；软件本体里为了使用方便，再用接口类包装一下。

参考文献

  1. 一个程序员的修炼之路. 谈一谈Windows中的堆 [EB/OL]. https://blog.csdn.net/CJF_iceKing/article/details/119083770
C++要点IFiltercode本体C++

有关用C++实现插件模式时的避坑要点的更多相关文章

  1. ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co

  2. ruby - 解析 RDFa、微数据等的最佳方式是什么，使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作，但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式，例如使用这个yaml文件，它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  3. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件？ - 2

    在选择我想要运行操作的频率时，唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案，但您可以安排它每天运行，并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/8692687/

  4. ruby-on-rails - 无法使用 Rails 3.2 创建插件？ - 2

    我对最新版本的Rails有疑问。我创建了一个新应用程序(railsnewMyProject)，但我没有脚本/生成，只有脚本/rails，当我输入ruby./script/railsgeneratepluginmy_plugin"Couldnotfindgeneratorplugin.".你知道如何生成插件模板吗？没有这个命令可以创建插件吗？PS:我正在使用Rails3.2.1和ruby​​1.8.7[universal-darwin11.0] 最佳答案 随着Rails3.2.0的发布，插件生成器已经被移除。查看变更日志here.现在

  5. ruby - 如何在续集中重新加载表模式？ - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  6. ruby - 如何根据特征实现 FactoryGirl 的条件行为 - 2

    我有一个用户工厂。我希望默认情况下确认用户。但是鉴于unconfirmed特征，我不希望它们被确认。虽然我有一个基于实现细节而不是抽象的工作实现，但我想知道如何正确地做到这一点。factory:userdoafter(:create)do|user,evaluator|#unwantedimplementationdetailshereunlessFactoryGirl.factories[:user].defined_traits.map(&:name).include?(:unconfirmed)user.confirm!endendtrait:unconfirmeddoenden

  7. ruby - 是否有用于序列化和反序列化各种格式的对象层次结构的模式？ - 2

    给定一个复杂的对象层次结构，幸运的是它不包含循环引用，我如何实现支持各种格式的序列化？我不是来讨论实际实现的。相反，我正在寻找可能会派上用场的设计模式提示。更准确地说:我正在使用Ruby，我想解析XML和JSON数据以构建复杂的对象层次结构。此外，应该可以将该层次结构序列化为JSON、XML和可能的HTML。我可以为此使用Builder模式吗？在任何提到的情况下，我都有某种结构化数据-无论是在内存中还是文本中-我想用它来构建其他东西。我认为将序列化逻辑与实际业务逻辑分开会很好，这样我以后就可以轻松支持多种XML格式。 最佳答案 我最

  8. 华为OD机试用Python实现 -【明明的随机数】 2023Q1A - 2

    华为OD机试题本篇题目：明明的随机数题目输入描述输出描述：示例1输入输出说明代码编写思路最近更新的博客华为od2023|什么是华为od，od薪资待遇，od机试题清单华为OD机试真题大全，用Python解华为机试题|机试宝典【华为OD机试】全流程解析+经验分享,题型分享,防作弊指南华为o

  9. 基于C#实现简易绘图工具【100010177】 - 2

    C#实现简易绘图工具一.引言实验目的:通过制作窗体应用程序(C#画图软件),熟悉基本的窗体设计过程以及控件设计,事件处理等,熟悉使用C#的winform窗体进行绘图的基本步骤,对于面向对象编程有更加深刻的体会.Tutorial任务设计一个具有基本功能的画图软件**·包括简单的新建文件,保存,重新绘图等功能**·实现一些基本图形的绘制,包括铅笔和基本形状等,学习橡皮工具的创建**·设计一个合理舒适的UI界面**注明:你可能需要先了解一些关于winform窗体应用程序绘图的基本知识,以及关于GDI+类和结构的知识二.实验环境Windows系统下的visualstudio2017C#窗体应用程序三.

  10. MIMO-OFDM无线通信技术及MATLAB实现（1）无线信道：传播和衰落 - 2

     MIMO技术的优缺点优点通过下面三个增益来总体概括：阵列增益。阵列增益是指由于接收机通过对接收信号的相干合并而活得的平均SNR的提高。在发射机不知道信道信息的情况下，MIMO系统可以获得的阵列增益与接收天线数成正比复用增益。在采用空间复用方案的MIMO系统中，可以获得复用增益，即信道容量成倍增加。信道容量的增加与min(Nt,Nr)成正比分集增益。在采用空间分集方案的MIMO系统中，可以获得分集增益，即可靠性性能的改善。分集增益用独立衰落支路数来描述，即分集指数。在使用了空时编码的MIMO系统中，由于接收天线或发射天线之间的间距较远，可认为它们各自的大尺度衰落是相互独立的，因此分布式MIMO

随机推荐