使用C++實現外掛模式時的避坑要點(推薦)

2022-08-06 22:00:10

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

什麼是外掛模式和為什麼要用外掛模式

外掛，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、C/C++中的名稱空間與作用域範例詳解會導致載入外掛時“找不到符號”
- 虛擬函式（表）實現：
  會導致載入外掛時可能不報錯，但執行時候找不到正確的虛擬函式入口
作業系統機制導致的不互通
- 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() 等介面類的共性成分的實現給外掛，以免出現一些奇怪的問題。