C#如何利用结构体对固定格式数据进行解析

本文为大家分享了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
  {
    /// 
    /// byte数组转目标结构体
    /// 
    /// byte数组
    /// 目标结构体类型
    /// 目标结构体
    public static T ByteToStuct(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;
    }
    /// 
    /// 结构体转byte数组
    /// 
    /// 结构体
    /// byte数组
    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(b);
        Console.WriteLine("Name:"+s.DeviceName.GetString());
      }
      catch (Exception ex)
      {
        Console.WriteLine(ex.Message);
      }
      Console.ReadKey();

    }

其中ByteToolsHelper.ByteArrayToHexString是我封装的一个函数,将byte数组转为Hex字符串,方便显示和调试可以不用管。

然后调试运行得到结果:

C#如何利用结构体对固定格式数据进行解析_第1张图片

我擦,这是什么情况?什么叫“未能封送类型,因为嵌入数组实例的长度与布局中声明的长度不匹配?????”

调试一下就可以发现实际结构体标记的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函数去掉,这样字符串后面就不会有一排空的了。

我们再试试结果:

C#如何利用结构体对固定格式数据进行解析_第2张图片

没问题!成功的转换和还原了。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

你可能感兴趣的:(C#如何利用结构体对固定格式数据进行解析)