linux下C 插件(plugin)實現技術

應用程序中使用插件技術,有利於日後的版本更新、維護(比如打補丁)和功能擴展,是一種很實用的技術。其最大的特點是更新插件時無需重新編譯主程序,對於一個設計良好的應用系統而言,甚至可以做到業務功能的在線升級。本文介紹了linux下用C++實現插件的一個簡單實例,希望能對大家有所啓發。

爲了能做到更新插件時無需重新編譯主程序,要求主程序中定義的接口是定死的,而接口的實現被放到了具體的插件中,這樣主程序在運行時刻將插件加載進來,就可以使用這些接口所提供的功能了。在面向對象的系統中,各個功能模塊被封裝到類中,因此在C++中實現插件技術,就需要在主程序中提供基類,併爲這些基類定義明確的接口,然後在插件(動態庫或共享庫)中定義派生類,並實現基類中所有的接口。

我們以計算多邊形面積爲例,首先定義一個基類CPolygon:

/*+********************************************************/
/*+********************************************************/
/*+********************************************************/

/* polygon.h */

#ifndef __POLYGON_H__
#define __POLYGON_H__

#include < iostream >

class CPolygon
{
public:

    CPolygon(){}

    virtual ~CPolygon(){}

    virtual double area(void) const = 0;
};

#endif /* __POLYGON_H__ */

/*-********************************************************/
/*-********************************************************/
/*-********************************************************/

注意基類不一定是虛類(有純虛函數的類),但是接口一定要定義成虛函數,因爲最終主程序是通過基類指針
來調派生類的接口函數,另外如果基類中有資源分配(new)的話,析構函數一定要定義成虛的,否則不會被
調用,造成內存泄漏。

接下來要定義派生類,並放到共享庫(triangle.so)中:

/*+********************************************************/
/*+********************************************************/
/*+********************************************************/

/* triangle.h */

#ifndef __TRIANGLE_H__
#define __TRIANGLE_H__

#include " polygon.h "
#include < iostream >

class CTriangle : public CPolygon
{
public:

    virtual double area(void) const;

};

#endif /* __TRIANGLE_H__ */


/* triangle.cpp */

#include "triangle.h"

extern "C"
{
    void * create()
    {
        return new CTriangle;
    }

}

double CTriangle::area(void) const
{
    std::cout << "area of triangle" << std::endl;
    return 0;
}

/*-********************************************************/
/*-********************************************************/
/*-********************************************************/

其中定義了函數“create”用來創建CTriangle類對象,該函數可讓主程序獲得CTriangle對象指針,從而
可以訪問CTriangle類對象。主程序通過調用dlsym獲取指向該函數的指針,需要指出的是,由於dlsym被
設計成c-style方式,因此調用c++定義的函數時,需要加上extern "C"

那麼主程序是如何調用共享庫的呢,代碼片段如下:

/*+********************************************************/
/*+********************************************************/
/*+********************************************************/

typedef CPolygon* create_t();

void * handle = dlopen("triangle.so", RTLD_LAZY);

if( !handle )
{
 std::cerr << dlerror() << std::endl;
 exit(1);
}

create_t * create_triangle = (create_t *)dlsym(handle, "create");

CPolygon * pObj = create_triangle();

if( 0 != pObj )
{
 pObj->area();
}

delete pObj;

dlclose(handle);

/*-********************************************************/
/*-********************************************************/
/*-********************************************************/

主程序通過dlopen打開triangle.so,然後通過dlsym得到庫中的函數create指針,調用create後返回了
指向CTriangle類對象的指針,類型是CPolygon的,由於虛函數的多態性, pObj->area() 實際是調用
了CTriangle::area.

好了,插件技術就是這麼簡單,回顧一下實現過程:寫一個基類,定義接口函數,然後在共享庫中寫
派生類,最後在主程序運行時刻打開共享庫(dlopen),並通過create函數得到指向新創建的派生類
對象的指針,然後利用虛函數的多態性,調用派生類的各種方法。


不過進一步使用後你可能會發現,這樣實現會有些問題:

1. 每寫一個派生類就需要重寫一個create函數

注意到CTriangle類實現時定義的create函數必須返回 new CTriangle:

extern "C"
{
    void * create()
    {
        return new CTriangle;
    }

}

那麼如果再建一個類比如CRectangle, create函數必須重寫,返回 new CRectangle

這樣做一方面麻煩,另外CTriangle、CRectangle兩個類不能放到同一個共享庫中,否則會編譯時刻
提示重複定義錯誤。


2. 主程序無法判斷create函數返回的是哪個類所創建的對象

當只有一個基類(CPolygon)時主程序當然知道返回的是CPolygon派生類的對象指針:
create_t * create_triangle = (create_t *)dlsym(handle, "create");
CPolygon * pObj = create_triangle();

假如有多個基類,根據這些基類派生出不同類型的類時,無法在主程序中判斷返回的是那個類的對象。


3. 操作繁瑣

沒有一個統一的操作界面,實現共享庫的加載、卸載、派生類對象的創建,特別是當需要加載一個目錄
下所有的共庫時,感覺一個一個地加載太麻煩了,能不能批量加載呢。


通過動態類加載和建立Helper類可以很好地解決上述問題,其中dynclass.h/dynclass.cpp中實現了動態
加載類對象,pluginhelper.h/pluginhelper.cpp實現了Plugin Helper,具體細節見附件。


下面簡單介紹一下使用步驟:


1. 首先定義基類(CPolygon),方法同上

2. 在共享庫中實現派生類

比如CTriangle:

/*+********************************************************/
/*+********************************************************/
/*+********************************************************/

/* triangle.h */

#ifndef __TRIANGLE_H__
#define __TRIANGLE_H__

#include " polygon.h "
#include  < iostream >

class CTriangle : public CPolygon
{
public:

    virtual double area(void) const;

};

#endif /* __TRIANGLE_H__ */


/* triangle.cpp */

#include " triangle.h "
#include " dynclass.h "

DYN_DECLARE(CTriangle);

double CTriangle::area(void) const
{
    std::cout << "area of triangle" << std::endl;
    return 0;
}

/*-********************************************************/
/*-********************************************************/
/*-********************************************************/


注意到此時派生類的實現(triangle.cpp)中已沒有了那個討厭的create了,被我偷偷放到
dynclass.cpp中了:

extern "C"
{
    void * createByClassName(const char * strClassName)
    {
        return DYN_CREATE(strClassName);
    }
}

由於對任何派生類而言,該函數的實現都一樣,因此只需要實現一次,對使用者是不可見的,達到
了從派生類中拿走的目的。

另外增加了一個宏:DYN_DECLARE(CTriangle); 參數是類名(這裏用到了RTTI),每個派生類對應
一個這樣的宏,該類就可以支持類對象的動態加載了,需要包含頭文件dynclass.h


2. 在主程序中如何使用

使用起來也非常簡單,在主程序(main.cpp)中:

/*+********************************************************/
/*+********************************************************/
/*+********************************************************/
...

#include " pluginhelper.h "
#include " polygon.h "

...

CPluginHelper pluginHelper;

pluginHelper.Load( "./plugin", "*.so" );

CPolygon * pbase = (CPolygon *)pluginHelper.Create("CTriangle");

if( 0 != pbase )
{
    pbase->area();
}

delete pbase;

pluginHelper.Unload( "./plugin", "*.so" );

/*-********************************************************/
/*-********************************************************/
/*-********************************************************/

首先定義CPluginHelper對象,調用Load方法加載共享庫,其中第一個參數是共享庫的路徑,第二
個參數是共享庫的名稱,共享庫名支持模式匹配,這裏表示要加載./plugin目錄所有so共享庫,
當然也可以是某個具體的共享庫名。

隨後可以通過CPluginHelper::Create方法,根據類名稱創建該類的對象,實現了參數化創建對象
的目的,然後就是對該對象的調用,當不用該對象時,需要調用delete來刪除。

最後,調用CPluginHelper::Unload將指定共享庫卸載。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章