深刻淺出C#結構體——封裝以太網心跳包的結構爲例

目錄

• 1.應用背景
• 2.結構體解析
  • 2.1.結構體存在棧中
  • 2.2.結構體不須要手動釋放
• 3.封裝心跳包結構體
• 4.結構體靜態幫助類
• 5.New出來的結構體是存在堆中仍是棧中？
  • 5.1.不帶形參的結構體構造
  • 5.2.帶形參的結構體構造
• 6.性能測試
• 7.緣由分析
• 8.下一期:結構體與類封裝的心跳包性能對比測試
• 9.IL工具使用分享

1.應用背景

底端設備有大量網絡報文（字節數組）：心跳報文，數據採集報文，告警報文上報。須要有對應的報文結構去解析這些字節流數據。

2.結構體解析

由此，我第一點就想到了用結構體去解析。緣由有如下兩點：

2.1.結構體存在棧中

類屬於引用類型，存在堆中；結構體屬於值類型，存在棧中，在一個對象的主要成員爲數據且數據量不大的狀況下，使用結構會帶來更好的性能。

2.2.結構體不須要手動釋放

屬於託管資源，系統自動管理生命週期，局部方法調用完會自動釋放，全局方法會一直存在。

3.封裝心跳包結構體

心跳協議報文以下：

對應結構體封裝以下：

[StructLayout(LayoutKind.Sequential, Pack = 1)] // 按1字節對齊
    public struct TcpHeartPacket
    {

      [MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]   //結構體內定長數組
      public byte[] head;

      public byte type;

      [MarshalAs(UnmanagedType.ByValArray, SizeConst = 2)]
      public byte[] length;
     
      [MarshalAs(UnmanagedType.ByValArray, SizeConst = 6)]
      public byte[] Mac;
     
      [MarshalAs(UnmanagedType.ByValArray, SizeConst = 104)]
      public byte[] data;//數據體
     
      [MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
      public byte[] tail;
    }

4.結構體靜態幫助類

主要實現了字節數組向結構體轉換方法，以及結構體向字節數組的轉換方法。

public class StructHelper
    {
        //// <summary>
        /// 結構體轉byte數組
        /// </summary>
        /// <param name="structObj">要轉換的結構體</param>
        /// <returns>轉換後的byte數組</returns>
        public static byte[] StructToBytes(Object structObj)
        {
            //獲得結構體的大小
            int size = Marshal.SizeOf(structObj);
            //建立byte數組
            byte[] bytes = new byte[size];
            //分配結構體大小的內存空間
            IntPtr structPtr = Marshal.AllocHGlobal(size);
            //將結構體拷到分配好的內存空間
            Marshal.StructureToPtr(structObj, structPtr, false);
            //從內存空間拷到byte數組
            Marshal.Copy(structPtr, bytes, 0, size);
            //釋放內存空間
            Marshal.FreeHGlobal(structPtr);
            //返回byte數組
            return bytes;
        }

        /// <summary>
        /// byte數組轉結構體
        /// </summary>
        /// <param name="bytes">byte數組</param>
        /// <param name="type">結構體類型</param>
        /// <returns>轉換後的結構體</returns>
        public static object BytesToStuct(byte[] bytes, Type type)
        {
            //獲得結構體的大小
            int size = Marshal.SizeOf(type);
            //byte數組長度小於結構體的大小
            if (size > bytes.Length)
            {
                //返回空
                return null;
            }
            //分配結構體大小的內存空間
            IntPtr structPtr = Marshal.AllocHGlobal(size);
            try
            {
                //將byte數組拷到分配好的內存空間
                Marshal.Copy(bytes, 0, structPtr, size);
                //將內存空間轉換爲目標結構體
                return Marshal.PtrToStructure(structPtr, type);
            }
            finally 
            {
                //釋放內存空間
                Marshal.FreeHGlobal(structPtr);
            }

        }

    }

5.New出來的結構體是存在堆中仍是棧中？

有同事說new出來的都會放在堆裏，我半信半疑。怎麼去肯定，new出來的結構體到底放在哪裏有兩種方式，一種是使用Visual Studio的調試工具查看，這種方法找了很久沒找到怎麼去查看，路過的高手煩請指點下；第二種方法就是查看反編譯dll的IL（Intermediate Language）語言。查看最終是以怎樣的方式去實現的。不懂IL想了解IL的能夠看此篇文章

5.1.不帶形參的結構體構造

• 調用代碼

//初始化結構體
  TcpHeartPacket tcpHeartPacket = new TcpHeartPacket();
  //將上報的心跳報文ReceviveBuff利用結構體靜態幫助類StructHelper的BytesToStuct方法將字節流轉化成結構體
  tcpHeartPacket = (TcpHeartPacket)StructHelper.BytesToStuct(ReceviveBuff, tcpHeartPacket.GetType());

從對應的IL代碼能夠看出只是initobj，並無newobj，其中newobj表示分配內存，完成對象初始化；而initobj表示對值類型的初始化。

• newobj用於分配和初始化對象；而initobj用於初始化值類型。所以，能夠說，newobj在堆中分配內存，並完成初始化；而initobj則是對棧上已經分配好的內存，進行初始化便可，所以值類型在編譯期已經在棧上分配好了內存。

• newobj在初始化過程當中會調用構造函數；而initobj不會調用構造函數，而是直接對實例置空。

• newobj有內存分配的過程；而initobj則只完成數據初始化操做。

initobj 的執行結果是，將tcpHeartPacket中的引用類型初時化爲null，而基元類型則置爲0。
綜上，new 結構體（無參狀況）是放在棧中的，只是作了null/0初始化。

5.2.帶形參的結構體構造

接下來看下帶形參的結構體存放位置。
簡化版帶形參的結構體以下：

public struct TcpHeartPacket
    {

        public TcpHeartPacket(byte _type)
        {
            type = _type;
         }
        public byte type;

    }

調用以下：

//帶形參結構體new初始化
  TcpHeartPacket tcpHeartPacket = new TcpHeartPacket(0x1);
//類的new作對比
  IWorkThread __workThread = new WorkThread();

IL代碼以下：

造成了鮮明的對比，new帶參的結構體。IL只是去call（調用）ctor（結構體的構造函數），而下面的new類則直接就是newobj，實例化了一個對象存到堆空間去了。

綜合5.1,5.2代表結構體的new確實是存在棧裏的，而類的new是存在堆裏的。

6.性能測試

測試結果以下：

使用結構體解析包須要幾十個微妙，其實效率仍是不好的。我用類封裝成包，解析了，只須要幾個微妙，性能差5到10倍。

7.緣由分析

主要時間消耗在了BytesToStuct方法，代碼詳見4

• 心跳包裏面用了不少byte[]字節數組，而字節數組自己須要在堆裏開闢空間；
• 該方法進行了裝箱拆箱操做；
• 分配內存在堆上，仍是在堆上進行了copy操做；
  拆裝箱的IL代碼以下：

裝箱使用的box指令，取消裝箱是 unbox.any 指令

8.下一期:結構體與類封裝的心跳包性能對比測試

當數據比較大的時候，結構體這種數據複製機制會帶來較大的開銷。也難怪微軟給出的準則中有一條：「當類型定義大於16字節時不要選用struct」。最終我也選擇了類來封裝以太網包的解析，性能能夠達到微妙級，會在下一篇文章《結構體與類封裝的心跳包性能對比測試》中做詳細描述。

9.IL工具使用分享

• 使用ildasm工具
  VS2013外部工具中添加ildasm.exe
• 使用dnSpy工具
  dnSpy的github地址

---

版權聲明：本文爲博主原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處連接和本聲明。

本文連接：http://www.javashuo.com/article/p-gtslbark-mr.html