一、發生的背景
在開發新項目中使用了新的語言開發 C# 和新的技術方案 WEB Service,但是在新項目中,一些舊的模塊需要繼續使用,一般是采用 C 或 C++ 或 Delphi 編寫的,如何利用舊模塊對于開發人員來說,有三種可用方法供選擇:
第一、將 C 或 C++ 函數用 C# 徹底改寫一遍,這樣整個項目代碼比較統一,維護也方便一些。但是盡管微軟以及某些書籍說,C# 和 C++ 如何接近,但是改寫起來還是很痛苦的事情,特別是 C++ 里的指針和內存操作;
第二、將 C 或 C++ 函數封裝成 COM,在 C# 中調用COM 比較方便,只是在封裝時需要處理 C 或 C++ 類型和 COM 類型之間的轉換,也有一些麻煩,另外COM 還需要注冊,注冊次數多了又可能導致混亂;
第三、將 C 或 C++ 函數封裝成動態鏈接庫,封裝的過程簡單,工作量不大。因此我決定采用加載動態鏈接庫的方法實現,于是產生了在 C# 中如何調用自定義的動態鏈接庫問題,我在網上搜索相關主題,發現一篇調用系統 API 的文章,但是沒有說明如何解決此問題,在 MSDN 上也沒有相關詳細說明。基于此,我決定自己從簡單出發,逐步試驗,看看能否達到自己的目標。
(說明一點:我這里改寫為什么很怕麻煩,我改寫的代碼是變長加密算法函數,代碼有600多行,對算法本身不熟悉,算法中指針和內存操作太多,要想保證算法正確,最可行的方法就是少動代碼,否則只要有一點點差錯,就不能肯定算法與以前兼容)
二、技術實現
下面看看如何逐步實現動態庫的加載,類型的匹配,動態鏈接庫函數導出的定義,這個不需要多說,大家參考下面宏定義即可:
#define LIBEXPORT_API extern "C" __declspec(dllexport)
第一步,我先從簡單的調用出發,定義了一個簡單的函數,該函數僅僅實現一個整數加法求和:
LIBEXPORT_API int mySum(int a,int b){ return a+b;}
C# 導入定義:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Auto,CallingConvention=CallingConvention.StdCall)]
public static extern int mySum (int a,int b);
}
在C#中調用測試:
int iSum = RefComm.mySum(2,3);
運行查看結果iSum為5,調用正確。第一步試驗完成,說明在C#中能夠調用自定義的動態鏈接庫函數。
第二步,我定義了字符串操作的函數(簡單起見,還是采用前面的函數名),返回結果為字符串:
LIBEXPORT_API char *mySum(char *a,char *b){sprintf(b,"%s",a); return a;}
C# 導入定義:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Auto,
CallingConvention=CallingConvention.StdCall)]
public static extern string mySum (string a, string b);
}
在C#中調用測試:
string strDest="";
string strTmp= RefComm.mySum("12345", strDest);
運行查看結果 strTmp 為"12345",但是strDest為空。我修改動態鏈接庫實現,返回結果為串b:
LIBEXPORT_API char *mySum(char *a,char *b){sprintf(b,"%s",a) return b;}
修改 C# 導入定義,將串b修改為ref方式:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Auto,CallingConvention=CallingConvention.StdCall)]
public static extern string mySum (string a, ref string b);
}
在C#中再調用測試:
string strDest="";
string strTmp= RefComm.mySum("12345", ref strDest);
運行查看結果 strTmp 和 strDest 均不對,含不可見字符。再修改 C# 導入定義,將CharSet從Auto修改為Ansi:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Ansi,CallingConvention=CallingConvention.StdCall)]
public static extern string mySum (string a, string b);
}
在C#中再調用測試:
string strDest="";
string strTmp= RefComm. mySum("12345", ref strDest);
運行查看結果 strTmp 為"12345",但是串 strDest 沒有賦值。第二步實現函數返回串,但是在函數出口參數中沒能進行輸出。再次修改 C# 導入定義,將串b修改為引用(ref):
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Ansi,CallingConvention=CallingConvention.StdCall)]
public static extern string mySum (string a, ref string b);
}
運行時調用失敗,不能繼續執行。
第三步,修改動態鏈接庫實現,將b修改為雙重指針:
LIBEXPORT_API char *mySum(char *a,char **b){sprintf((*b),"%s",a); return *b;}
C#導入定義:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Ansi,CallingConvention=CallingConvention.StdCall)]
public static extern string mySum (string a, ref string b);
}
在C#中調用測試:
string strDest="";
string strTmp= RefComm. mySum("12345", ref strDest);
運行查看結果 strTmp 和 strDest 均為"12345",調用正確。第三步實現了函數出口參數正確輸出結果。
第四步,修改動態鏈接庫實現,實現整數參數的輸出:
LIBEXPORT_API int mySum(int a,int b,int *c){ *c=a+b; return *c;}
C#導入的定義:
public class RefComm
{
[DllImport("LibEncrypt.dll",
EntryPoint=" mySum ",
CharSet=CharSet.Ansi,CallingConvention=CallingConvention.StdCall)]
public static extern int mySum (int a, int b,ref int c);
}
在C#中調用測試:
int c=0;
int iSum= RefComm. mySum(2,3, ref c);
運行查看結果iSum 和c均為5,調用正確。
經過以上幾個步驟的試驗,基本掌握了如何定義動態庫函數以及如何在 C# 定義導入,有此基礎,很快我實現了變長加密函數在 C# 中的調用,至此目標實現。
三、結論
在 C# 中調用 C++ 編寫的動態鏈接庫函數,如果需要出口參數輸出,則需要使用指針,對于字符串,則需要使用雙重指針,對于 C# 的導入定義,則需要使用引用(ref)定義。
對于函數返回值,C# 導入定義和 C++ 動態庫函數聲明定義需要保持一致,否則會出現函數調用失敗。定義導入時,一定注意 CharSet 和 CallingConvention 參數,否則導致調用失敗或結果異常。運行時,動態鏈接庫放在 C# 程序的目錄下即可,我這里是一個 C# 的動態鏈接庫,兩個動態鏈接庫就在同一個目錄下運行。
------------------------------------------------------------------------------------
改寫c++ 到c#?(引)
- 在.h文件中找到所有的struct定義,先改成C#的。用Marshal.SizeOf得到其大小,初步進行測試:看看它和在C/C++程序中用sizeof得到的大小是否相等
- 對應所有C++的類,先寫出所有C#的類的原型,包括成員字段和函數。所有函數里先放著throw new NotImplementedException()這么一句,省得影響編譯
- 對應于C++類的析構函數,在C#用Dispose Pattern實現
- 找到所有用到的Windows API和其他Native API,在C#用static extern方法聲明之,然后對不確定都否工作的那些(比如參數里頭有n個*的那種)進行初步測試
- 在.h文件找到所有宏定義的常量,改成const的字段;而宏方法只能直接改成普通方法(C#沒有inline關鍵字)。對于用宏改了名字的類型,專門記載到一個文檔中,以后直接用文本替換(ctrl+h)搞定之
- 把.cpp文件的代碼逐步copy到C#代碼中,一個函數一個函數的改。基于C/C++標準庫和語言本身特性的代碼語句,一般都可在FCL和C#中找到對應的做法,這也包括指針操作;至于API的調用,前面已經準備好了
- 編譯通過,測試一下
