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

定義一個結構體：

using System.Runtime.InteropServices;
[StructLayoutAttribute(LayoutKind.Sequential, CharSet = CharSet.Ansi, Pack = 1)]
    public struct InfoStruct
    {
        [MarshalAs(UnmanagedType.U1, SizeConst = 1)]
        public byte SlotNum;
        [MarshalAs(UnmanagedType.U4,SizeConst =4)]
        public UInt32 ModuleID;
        [MarshalAs(UnmanagedType.ByValArray,SizeConst =32)]
        public char[] DeviceName;
        [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
        public char[] HardwareNum;
        [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
        public char[] HardwareVersion;
        [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
        public char[] SoftwareVersion;
        [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
        public char[] SoftwareDate;
    }

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

public static class StructHelper
    {
        /// <summary>
        /// byte數組轉目標結構體
        /// </summary>
        /// <param name="bytes">byte數組</param>
        /// <param name="type">目標結構體類型</param>
        /// <returns>目標結構體</returns>
        public static T ByteToStuct<T>(byte[] DataBuff_) where T:struct
        {
            Type t = typeof(T);
            //得到結構體大小
            int size = Marshal.SizeOf(t);
            //數組長度小於結構體大小
            if (size > DataBuff_.Length)
            {
                return default(T);
            }

            //分配結構體大小的內存空間
            IntPtr structPtr = Marshal.AllocHGlobal(size);
            //將byte數組cpoy到分配好的內存空間內
            Marshal.Copy(DataBuff_, 0, structPtr, size);
            //將內存空間轉換為目標結構體
            T obj = (T)Marshal.PtrToStructure(structPtr, t);
            //釋放內存空間
            Marshal.FreeHGlobal(structPtr);
            return obj;
        }
        /// <summary>
        /// 結構體轉byte數組
        /// </summary>
        /// <param name="objstuct">結構體</param>
        /// <returns>byte數組</returns>
        public static byte[] StuctToByte(object objstuct)
        {
            //得到結構體大小
            int size = Marshal.SizeOf(objstuct);
            //創建byte數組
            byte[] bytes = new byte[size];
            //分配結構體大小的空間
            IntPtr structPtr = Marshal.AllocHGlobal(size);
            //將結構體copy到分配好的內存空間內
            Marshal.StructureToPtr(objstuct, structPtr, false);
            //從內存空間copy到byte數組
            Marshal.Copy(structPtr, bytes, 0, size);
            //釋放內存空間
            Marshal.FreeHGlobal(structPtr);
            return bytes;
        }
    }

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

static void Main(string[] args)
        {
            try
            {
                InfoStruct Info;
                Info.HardwareNum = "1.0.0".ToCharArray();
                Info.HardwareVersion = "ABC1234567".ToCharArray();
                Info.DeviceName = "Device Name1".ToCharArray();
                Info.ModuleID = 0x10000001;
                Info.SlotNum = 1;
                Info.SoftwareDate = "2018/1/22".ToCharArray();
                Info.SoftwareVersion = "V1.0.0".ToCharArray();
                var b =  StructHelper.StuctToByte(Info);
                Console.WriteLine("Struct length:"+b.Length);
                Console.WriteLine("Hex:"+ByteToolsHelper.ByteArrayToHexString(b," "));
                var s = StructHelper.ByteToStuct<InfoStruct>(b);
                Console.WriteLine("Name:"+s.DeviceName.GetString());
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
            Console.ReadKey();

        }

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

然后調試運行得到結果：

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

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

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

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

        public static char[] GetFixLengthChar(this string s,int length)
        {
            char[] chaVal = new char[length];
            Array.Copy(s.PadRight(length, '\0').ToCharArray(), chaVal, length);
            return chaVal;
        }
        public static string GetString(this char[] cc)
        {
            return GetString(cc,true);
        }
        public static string GetString(this char[] cc,bool isTrimEnd)
        {
            if (isTrimEnd)
            {
                return new string(cc).TrimEnd('\0');
            }
            else
            {
                return new string(cc);
            }
        }

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

我們再試試結果：

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

附上Demo程序下載地址：鏈接：https://pan.baidu.com/s/1aGBzkCKzMOi7JsOT7ZAj_g 密碼：1wdd