C#結構體使用淺析
C#結構體使用在C#中調用C++或系統DLL是比較常見的操作。
例如C++中定義的以下結構體:
- struct RCEStruct {
- int Event;
- int Flag;
- char User[40];
- };
C#結構體使用同時有一個公開方法:
extern "C" __declspec WORD CALLBACK GetStruct(RCEStruct* pEventStruc);
我們將它編譯為 MyCppDll.DLL
那么C#結構體使用上我們在C#中可以直接定義相同的結構體和引用GetStruct:
- [StructLayout(LayoutKind.Sequential)]
- public struct RCEStruct {
- public int Event;
- public int Flag;
- public char[40] User;
- }
- [DllImport("MyCppDll.dll", CharSet=CharSet.Auto)]
- public static extern int GetStruct(RCEStruct rce);
注意C#里定義的結構體應該和C++里定義的一樣。這里如果是public string User就有可能出錯(具體我沒試過,不知道C#是否會自動將char[]轉變為string,另外還要注意,在C#中為User賦值時,長度不應超過40)。
通過這種方式我們就可以向C++傳遞或者獲得結構體。但一個限制就是必須在C#端主動調用GetStruct()
還有一種情況,與上一種相反,就是我們不是希望在C#中調用C++類庫,而是想在C++類庫中調用我們已經寫好的C#類庫。這在托管C++里是可以實現的。其中一個應用案例就是在為第三方系統寫C++插件的時候,我們必須在插件端主動調用C#類庫(前提是我們需要使用它,除非我們完全用C++代碼來寫這個插件)。
這樣的話我們的C#結構體使用應該是在C#類庫公開方法,例如:
- public struct RCEStruct {
- public int Event;
- public int Flag;
- public string User;
- }
- public void DoSomething(RCEStruct rce){
- rce.Flag++;
- }
假定編譯成 MyCSharpDll.DLL
C#結構體使用之C++端代碼如下:
- #using ﹤mscorlib.dll﹥
- #using ﹤CuteSuProc.dll﹥
- void SomeMethod(RCEStruct* pEventStruc){
- // 將C++結構體賦值到C#結構體
- MyCSharpDll::RCEStruct* csStruct;
- csStruct-﹥Event = pEventStruc.Event;
- csStruct-﹥Flag = pEventStruc.Flag;
- // csStruct-﹥User ?? 將char轉換成string,在C++里如何處理?
- MyCSharpDll::DoSomething(csStruct);
- // 將C#結構體賦值到C++結構體
- // 因為 pEventStruc 由外界傳入,被 DoSomething 方法修改后,可能仍需要外界知道
- pEventStruc-﹥Event = csStruct.Event;
- pEventStruc-﹥Flag = csStruct.Flag;
- // pEventStruc-﹥User ?? 將string轉換成char[]
- }
托管C++在處理.NET類庫時,有些細節是很繁瑣的,讓人覺得有些暈乎。譬如很多地方要加__gc修飾符。還有像數組,字符串的轉換都比較麻煩。所以上面代碼可能會有些小錯誤。但大致意思就是這樣。很明顯,這樣的做法非常麻煩。對結構體進行操作前,我們進行一次賦值,操作后,又進行一次賦值。
有沒有辦法直接讓C#操作原始的結構體呢?就像C#中操作C++一樣,不需要通過一個中間人?能不能直接這樣:
- #using ﹤mscorlib.dll﹥
- #using ﹤CuteSuProc.dll﹥
- void SomeMethod(RCEStruct* pEventStruc){
- MyCSharpDll::DoSomething(pEventStruc);
- }
答案是否定的。我們沒有辦法直接將C++里的 RCEStruct轉換為 C#里的 RCEStruct。
那么還剩一種方法,就是直接對內存進行操作。因為是結構體,他們肯定是保存在連續內存空間中的。
我們先來看看C#中如何操作內存,也就是非托管的數據。這需要引用System.Runtime.InteropServices命名空間。該命名空間下的Marshal的一些靜態方法提供了這樣的功能:
Marshal.ReadInt32()//從指定內存地址讀取4位
Marshal.PtrToStringAnsi()//從指定內存地址讀取字符串
Marshal.WriteInt32()//將整數寫到指定內存地址
Marshal.WriteByte()//將字符串寫到指定內存地址
我們來看看具體的C#結構體使用代碼:
- using System;
- using System.Text;
- using System.Runtime.InteropServices;
- internal sealed class RCEvent {
- public int Event;
- public int Flag;
- public string User;
- };
- internal sealed class RCEventAgent {
- internal static RCEvent Read(IntPtr ptr){
- RCEvent Event = new RCEvent();
- Event.Event = ReadEvent(ptr);
- Event.Flag = ReadFlag(ptr);
- Event.User = ReadUser(ptr);
- return Event;
- }
- internal static int ReadEvent(IntPtr basePtr) {
- return Marshal.ReadInt32(basePtr);
- }
- internal static int ReadFlag(IntPtr basePtr) {
- return Marshal.ReadInt32(basePtr,4);
- }
- internal static string ReadUser(IntPtr basePtr) {
- return Marshal.PtrToStringAnsi(
- new IntPtr(basePtr.ToInt32() + 8));
- }
- internal static void Write(ClientEvent Event,IntPtr ptr) {
- WriteEvent(ptr,Event.Event);
- WriteFlag(ptr,Event.Flag);
- WriteUser(ptr,Event.User);
- }
- internal static void WriteEvent(IntPtr basePtr,int value) {
- Marshal.WriteInt32(basePtr,value);
- }
- internal static void WriteFlag(IntPtr basePtr,int flag) {
- Marshal.WriteInt32(basePtr,4,flag);
- }
- internal static void WriteUser(IntPtr basePtr,string user) {
- WriteString(basePtr,user,8,40);
- }
- private static void WriteString(
- IntPtr basePtr,string value,int offset,int length) {
- int pos = 0;
- byte[] bytes = Encoding.Default.GetBytes(value);
- while(pos ﹤ length) {
- if (pos ﹤ bytes.Length)
- Marshal.WriteByte(basePtr,offset,bytes[pos]);
- else
- Marshal.WriteByte(basePtr,offset,0);
- pos ++;
- offset ++;
- }
- }
- }
C#結構體使用代碼解析:這樣我們就可以通過ReadEvent和WriteEvent直接在c#中處理該結構體?;蛘咄ㄟ^ ReadXXX() 和 WriteXXX() 直接修改其字段。
- public void DoSomething(IntPtr ptr){
- RCEvent Event = RCEventAgent.Read(ptr);
- Event.Flag ++;
- RCEventAgent.Write(ptr, Event);
- // 或者以下代碼
- // RCEventAgent.WriteFlag( ptr, RCEventAgent.ReadFlag(ptr) + 1 );
- } C++中則可以直接將結構體地址傳給C#:
- #using ﹤mscorlib.dll﹥
- #using ﹤CuteSuProc.dll﹥
- void SomeMethod(RCEStruct* pEventStruc){
- MyCSharpDll::DoSomething(pEventStruc);
- }
C#結構體使用方面的基本情況就向你介紹到這里,希望對你學習了解C#結構體使用有所幫助。
【編輯推薦】