C# 利用結構體對固定格式數據進行解析

制定了一個通訊協議，然後其數據部分有如下格式。

第三列代表的是位元組數，第4列是數據類型。

當傳輸或者收到一個byte數組的時候（下麵Hex數據），按照對應格式進行解析，解析方法有很多種，網上看到了一種方式是以結構體的方式來解析的，類似C/C++方式。

Hex數據:01 01 00 00 10 44 65 76 69 63 65 20 4E 61 6D 65 31 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 31 2E 30 2E 30 00 00 00 00 00 00 00 00 00 00 00 41 42 43 31 32 33 34 35 36 37 00 00 00 00 00 00 56 31 2E 30 2E 30 00 00 00 00 00 00 00 00 00 00 32 30 31 38 2F 31 2F 32 32 00 00 00 00 00 00 00

定義一個結構體：

 1 using System.Runtime.InteropServices;
 2 [StructLayoutAttribute(LayoutKind.Sequential, CharSet = CharSet.Ansi, Pack = 1)]
 3     public struct InfoStruct
 4     {
 5         [MarshalAs(UnmanagedType.U1, SizeConst = 1)]
 6         public byte SlotNum;
 7         [MarshalAs(UnmanagedType.U4,SizeConst =4)]
 8         public UInt32 ModuleID;
 9         [MarshalAs(UnmanagedType.ByValArray,SizeConst =32)]
10         public char[] DeviceName;
11         [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
12         public char[] HardwareNum;
13         [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
14         public char[] HardwareVersion;
15         [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
16         public char[] SoftwareVersion;
17         [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
18         public char[] SoftwareDate;
19     }

再寫一個輔助解析的靜態幫助類，該類提供將結構體轉成byte數組和byte數組轉成結構體功能，我在原來的方法上面添加了泛型，功能不變：

 1 public static class StructHelper
 2     {
 3         /// <summary>
 4         /// byte數組轉目標結構體
 5         /// </summary>
 6         /// <param name="bytes">byte數組</param>
 7         /// <param name="type">目標結構體類型</param>
 8         /// <returns>目標結構體</returns>
 9         public static T ByteToStuct<T>(byte[] DataBuff_) where T:struct
10         {
11             Type t = typeof(T);
12             //得到結構體大小
13             int size = Marshal.SizeOf(t);
14             //數組長度小於結構體大小
15             if (size > DataBuff_.Length)
16             {
17                 return default(T);
18             }
19 
20             //分配結構體大小的記憶體空間
21             IntPtr structPtr = Marshal.AllocHGlobal(size);
22             //將byte數組cpoy到分配好的記憶體空間內
23             Marshal.Copy(DataBuff_, 0, structPtr, size);
24             //將記憶體空間轉換為目標結構體
25             T obj = (T)Marshal.PtrToStructure(structPtr, t);
26             //釋放記憶體空間
27             Marshal.FreeHGlobal(structPtr);
28             return obj;
29         }
30         /// <summary>
31         /// 結構體轉byte數組
32         /// </summary>
33         /// <param name="objstuct">結構體</param>
34         /// <returns>byte數組</returns>
35         public static byte[] StuctToByte(object objstuct)
36         {
37             //得到結構體大小
38             int size = Marshal.SizeOf(objstuct);
39             //創建byte數組
40             byte[] bytes = new byte[size];
41             //分配結構體大小的空間
42             IntPtr structPtr = Marshal.AllocHGlobal(size);
43             //將結構體copy到分配好的記憶體空間內
44             Marshal.StructureToPtr(objstuct, structPtr, false);
45             //從記憶體空間copy到byte數組
46             Marshal.Copy(structPtr, bytes, 0, size);
47             //釋放記憶體空間
48             Marshal.FreeHGlobal(structPtr);
49             return bytes;
50         }
51     }

好了現在結構體有了，轉換方法也有了那麼就來使用一下吧！先將結構體轉為byte數組，然後再還原結構體試試：

 1 static void Main(string[] args)
 2         {
 3             try
 4             {
 5                 InfoStruct Info;
 6                 Info.HardwareNum = "1.0.0".ToCharArray();
 7                 Info.HardwareVersion = "ABC1234567".ToCharArray();
 8                 Info.DeviceName = "Device Name1".ToCharArray();
 9                 Info.ModuleID = 0x10000001;
10                 Info.SlotNum = 1;
11                 Info.SoftwareDate = "2018/1/22".ToCharArray();
12                 Info.SoftwareVersion = "V1.0.0".ToCharArray();
13                 var b =  StructHelper.StuctToByte(Info);
14                 Console.WriteLine("Struct length:"+b.Length);
15                 Console.WriteLine("Hex:"+ByteToolsHelper.ByteArrayToHexString(b," "));
16                 var s = StructHelper.ByteToStuct<InfoStruct>(b);
17                 Console.WriteLine("Name:"+s.DeviceName.GetString());
18             }
19             catch (Exception ex)
20             {
21                 Console.WriteLine(ex.Message);
22             }
23             Console.ReadKey();
24 
25         }

其中ByteToolsHelper.ByteArrayToHexString是我封裝的一個函數，將byte數組轉為Hex字元串，方便顯示和調試可以不用管。

然後調試運行得到結果：

我擦，這是什麼情況？什麼叫“未能封送類型，因為嵌入數組實例的長度與佈局中聲明的長度不匹配？？？？？”

調試一下就可以發現實際結構體標記的SizeConst和ToCharArray()函數得到的長度並不一樣，字元串通過ToCharArray()得到的長度不足導致出現這個異常。

既然是長度不足，那麼就想辦法補足吧。

寫個靜態擴展方法，包含上面的GetString擴展方法：

 1         public static char[] GetFixLengthChar(this string s,int length)
 2         {
 3             char[] chaVal = new char[length];
 4             Array.Copy(s.PadRight(length, '\0').ToCharArray(), chaVal, length);
 5             return chaVal;
 6         }
 7         public static string GetString(this char[] cc)
 8         {
 9             return GetString(cc,true);
10         }
11         public static string GetString(this char[] cc,bool isTrimEnd)
12         {
13             if (isTrimEnd)
14             {
15                 return new string(cc).TrimEnd('\0');
16             }
17             else
18             {
19                 return new string(cc);
20             }
21         }

GetFixLengthChar是將字元串轉為固定長度char數組，GetString是從char數組轉為字元串，因為有'\0'可以用TrimEnd函數去掉，這樣字元串後面就不會有一排空的了。

我們再試試結果：

沒問題！成功的轉換和還原了。