使用C++實現(xiàn)插件模式時的避坑要點(推薦)

更新時間：2022年08月06日 16:04:42 作者：SnEngrDrYJ

這篇文章主要介紹了使用C++實現(xiàn)插件模式時的避坑要點,本文主要分析實踐中常見的、因為對原理不清楚而搞出來的產(chǎn)品里的坑，本文給大家介紹的非常詳細，需要的朋友可以參考下

本文不打算嚴格地、用標準術語來講前因后果。本文主要分析實踐中常見的、因為對原理不清楚而搞出來的產(chǎn)品里的坑。

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

插件，Plug-In，或者（IE/Edge稱之為）加載項/Add-On，（Office稱之為）外接程序/Add-In，（GIMP稱之為）擴展/Extension，等等，總之看字面意思都是“額外增加功能”的這種東西，是一類開發(fā)模式。基本思路就是，研發(fā)軟件本體的時候，外部需求不明確、直到使用期仍然經(jīng)常會增加功能細節(jié)。為了把變動部分切割開，在設計的時候，通過對可變部分的歸納分析，對可變部分抽象出一套接口；每套外部需求用動態(tài)庫之類的形式實現(xiàn)接口；軟件本體按某種約定，加載動態(tài)庫，并從中獲取插件實例，通過接口來調(diào)用滿足當時需求的功能實現(xiàn)。

可以看到，插件的思想，其實就是靈活運用“動態(tài)庫”的動態(tài)加載能力，把對“接口”的實現(xiàn)移到軟件本體之外，并用工廠模式來約束動態(tài)庫的實現(xiàn)方式。

只要是具有動態(tài)加載能力的運行環(huán)境上，都可以使用插件模式來設計軟件系統(tǒng)。極端一些的軟件系統(tǒng)，甚至只提供基礎平臺，所有功能都由插件的方式提供，例如 Visual Studio Code 、 Eclipse 等。

C++實現(xiàn)插件模式

用C++實現(xiàn)插件模式，一般是把下面這些功能組合起來：

用一個C++的帶虛函數(shù)的基類來表示功能
約定動態(tài)庫里的工廠模式接口
在一些動態(tài)庫里提供實現(xiàn)虛函數(shù)的派生類
在動態(tài)庫里實現(xiàn)工廠模式

不幸的是，由于各操作系統(tǒng)的動態(tài)庫機制普遍是C風格的，用C++做動態(tài)庫時候的坑，在用C++實現(xiàn)插件模式時，全都會遇到。比如：

C++的編譯器差異導致的不互通
會導致必須用同一種（或兼容的）編譯器來生成插件和軟件本體。
- 名字改寫（Name Mangling）：參考：Wikipedia、C/C++中的名字空間與作用域示例詳解會導致加載插件時“找不到符號”
- 虛函數(shù)（表）實現(xiàn)：
  會導致加載插件時可能不報錯，但運行時候找不到正確的虛函數(shù)入口
操作系統(tǒng)機制導致的不互通
- Windows上使用MSVCRT時的內(nèi)存分配和回收
  Windows每個模塊的內(nèi)存分配默認是在模塊自己的堆里的，而Windows上的C運行時庫（各種MSVCRT）為了封裝出 malloc 、 free 等C函數(shù)的效果，建立了__crtheap（2010及之前版本行為）或直接使用進程默認堆（2015及之后版本行為）[1]。這導致，即使是同一個編譯器，靜態(tài)鏈接VC運行時會采用本模塊內(nèi)部的堆來實現(xiàn) malloc 等，而動態(tài)鏈接VC運行時則會采用MSVCRT動態(tài)庫DLL的模塊堆。需要解決好“誰申請誰釋放”的問題，否則內(nèi)存管理的地方容易出異常。
- 全局變量在模塊間的共享問題

一些典型的不良實現(xiàn)

這里說的不良實現(xiàn)，使用時候未必會錯或崩，但早晚要崩，或者會限制住插件的開發(fā)。以下用如下插件接口作為例子。

// IFilter.h
 
/// 濾波器接口.
class IFilter {
protected:
    IFilter();
public:
    virtual ~IFilter();
public:
    /// 一個將輸入復數(shù)數(shù)組處理為輸出復數(shù)數(shù)組的函數(shù).
    virtual void Filter(const std::complex<double>* acdIn, std::complex<double>* acdOut, size_t uLen) = 0;
    /// 獲取當前實現(xiàn)的一些描述字符串.
    virtual std::string GetDescription() const = 0;
};
// IFilter.cpp
IFilter::IFilter() { }
IFilter::~IFilter() { }

并約定插件實現(xiàn)中以如下形式提供工廠函數(shù)。

// FilterPluginDll.h
#include "IFilter.h"
/* 插件DLL應該提供如下函數(shù) 
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);

接口類沒有提供二進制實現(xiàn)

比如，對插件只發(fā)布兩個頭文件；認為 IFilter 的構造和析構反正是空函數(shù)無所謂，直接寫在類定義里。

這樣，插件開發(fā)者自己生成插件DLL時，會在自己的DLL里鏈接進一份 IFilter::IFilter() 和 IFilter::~IFilter() 的實現(xiàn)，而軟件本體里也有一份自己的實現(xiàn)。雖然看上去，如果編譯器一樣，兩份實現(xiàn)是等同的，但考慮到它們使用了不同的模塊堆，以及其它各種原因，插件DLL中的 IFilter 和軟件本體里的 IFilter 并不是完全等同的。

這里應該由軟件本體導出 IFilter::IFitler() 和 IFilter::~IFilter() 等接口類的共性成分的實現(xiàn)給插件，以免出現(xiàn)一些奇怪的問題。