C# 串口操作系列(3) -- 协议篇，二进制协议数据解析

古城微笑少年丶 2022-08-07 09:54 156阅读 0赞

[点击打开链接][Link 1]

我们的串口程序，除了通用的，进行串口监听收发的简单工具，大多都和下位机有关，这就需要关心我们的通讯协议如何缓存，分析，以及通知界面。

我们先说一下通讯协议。通讯协议就是通讯双方共同遵循的一套规则，定义协议的原则是尽可能的简单以提高传输率，尽可能的具有安全性保证数据传输完整正确。基于这2点规则，我们一个通讯协议应该是这样的：**头**\+**数据长度**\+**数据正文**\+**校验**

例如：AA 44 05 01 02 03 04 05 EA

这里我假设的一条数据，协议如下：

数据头：     AA 44

数据长度： 05

数据正文： 01 02 03 04 05

校验：       EA

一般数据的校验，都会采用常用的方式，CRC16,CRC32,Xor。

有的数据安全要求高的，不允许丢包的，可能还要加入重发机制或是加入数据恢复算法，在校验后根据前面数据添加恢复字节流以恢复数据。我这里采用的是简单的异或校验，包含数据头的所有字节，依次异或得到的。

协议很简单，我也认为分析协议是很简单的事情，下面我们就如何分析协议来实际的结合c\#看一下。

er…再等等，在我们实际开始编码之前，还有一个规则需要了解，我们有了通讯协议，如何结合串口的协议来分析，需要关心什么呢？哦。一般就是4个问题：**缓存收到的所有数据**，**找到一条完整数据**，**分析数据**，**界面通知**。

如果分的更详细一点，缓存收到的所有数据，我们想到最高效的办法就是顺序表，也就是数组，但数组的操作比较复杂，当你使用完一条数据后，用过的需要移除；新数据如果过多的时候，缓存过大需要清理；数据搬移等等，很有可能一个不小心就会丢数据导致软件出些莫名其妙的小问题。个人建议，使用List<byte>，内部是数组方式实现，每次数据不足够的时候会扩容1倍，数据的增删改都已经做的很完善了。不会出现什么小问题。

找到一条完整数据，如何找到完整数据呢？就我们例子的这个协议，首先在缓存的数据中找AA 44，当我们找到后，探测后面的字节，发现是05，然后看缓存剩下的数据是否足够，不足够就不用判断，减少时间消耗，如果剩余数据>=6个（包含1个字节的校验），我们就算一个校验，看和最后的校验是否一致。

分析数据：鉴于网络的开放性，我无法确定读者对c\#的了解程度，介绍一下，常用的方式就是BitConvert.ToInt32这一系列的方法，把连续的字节（和变量长度一样）读取并转换为对应的变量。c++下使用memcpy，或直接类型转换后进行值拷贝，vb6下使用CopyMemory这个api。

校验：前面说过了。完整性判断的时候需要和校验对比，大多系统都不太严格，不支持重发，所以数据错误就直接丢弃。导致数据错误的原因很多，比如电磁干扰导致数据不完整或错误、硬件驱动效率不够导致数据丢失、我们的软件缓存出错等。这些软件因素数据系统错误，需要修改，但是电磁干扰么，有这个可能的。虽然很少。

其实我知道，就算是我，看别人的博客也是，喜欢看图片，看代码，文字性的东西，一看就头大。那我接下来贴出基于上一篇文章的改进版本，支持协议分析（协议不能配置，可配置的协议不是我们讨论的范畴。可以看看有DFA(确定性有限状态机))

我们修改一下界面，以便能显示收到后分析的数据

![红色部分是新增的][38687_1274925013eiiD.png]

**代码如下：**

**\[c-sharp\]** [ view plain][view plain] [copy][view plain]

1.  using System;  
2.  using System.Collections.Generic;  
3.  using System.ComponentModel;  
4.  using System.Data;  
5.  using System.Drawing;  
6.  using System.Linq;  
7.  using System.Text;  
8.  using System.Windows.Forms;  
9.  using System.IO.Ports;  
10. using System.Text.RegularExpressions;  
11. namespace SerialportSample  
12. \{  
13.     public partial class SerialportSampleForm : Form  
14.     \{  
15.         private SerialPort comm = new SerialPort();  
16.         private StringBuilder builder = new StringBuilder();//避免在事件处理方法中反复的创建，定义到外面。  
17.         private long received\_count = 0;//接收计数  
18.         private long send\_count = 0;//发送计数  
19.         private bool Listening = false;//是否没有执行完invoke相关操作  
20.         private bool Closing = false;//是否正在关闭串口，执行Application.DoEvents，并阻止再次invoke  
21.         private List<byte> buffer = new List<byte>(4096);//默认分配1页内存，并始终限制不允许超过  
22.         private byte\[\] binary\_data\_1 = new byte\[9\];//AA 44 05 01 02 03 04 05 EA  
23.         public SerialportSampleForm()  
24.         \{  
25.             InitializeComponent();  
26.         \}  
27.         //窗体初始化  
28.         private void Form1\_Load(object sender, EventArgs e)  
29.         \{  
30.             //初始化下拉串口名称列表框  
31.             string\[\] ports = SerialPort.GetPortNames();  
32.             Array.Sort(ports);  
33.             comboPortName.Items.AddRange(ports);  
34.             comboPortName.SelectedIndex = comboPortName.Items.Count > 0 ? 0 : -1;  
35.             comboBaudrate.SelectedIndex = comboBaudrate.Items.IndexOf("19200");  
36.             //初始化SerialPort对象  
37.             comm.NewLine = "/r/n";  
38.             comm.RtsEnable = true;//根据实际情况吧。  
39.             //添加事件注册  
40.             comm.DataReceived += comm\_DataReceived;  
41.         \}  
42.         void comm\_DataReceived(object sender, SerialDataReceivedEventArgs e)  
43.         \{  
44.             if (Closing) return;//如果正在关闭，忽略操作，直接返回，尽快的完成串口监听线程的一次循环  
45.             try  
46.             \{  
47.                 Listening = true;//设置标记，说明我已经开始处理数据，一会儿要使用系统UI的。  
48.                 int n = comm.BytesToRead;//先记录下来，避免某种原因，人为的原因，操作几次之间时间长，缓存不一致  
49.                 byte\[\] buf = new byte\[n\];//声明一个临时数组存储当前来的串口数据  
50.                 received\_count += n;//增加接收计数  
51.                 comm.Read(buf, 0, n);//读取缓冲数据  
52.                 /  
53.                 //<协议解析>  
54.                 bool data\_1\_catched = false;//缓存记录数据是否捕获到  
55.                 //1.缓存数据  
56.                 buffer.AddRange(buf);  
57.                 //2.完整性判断  
58.                 while (buffer.Count >= 4)//至少要包含头（2字节）+长度（1字节）+校验（1字节）  
59.                 \{  
60.                     //请不要担心使用>=，因为>=已经和>,<,=一样，是独立操作符，并不是解析成>和=2个符号  
61.                     //2.1 查找数据头  
62.                     if (buffer\[0\] == 0xAA && buffer\[1\] == 0x44)  
63.                     \{  
64.                         //2.2 探测缓存数据是否有一条数据的字节，如果不够，就不用费劲的做其他验证了  
65.                         //前面已经限定了剩余长度>=4，那我们这里一定能访问到buffer\[2\]这个长度  
66.                         int len = buffer\[2\];//数据长度  
67.                         //数据完整判断第一步，长度是否足够  
68.                         //len是数据段长度,4个字节是while行注释的3部分长度  
69.                         if (buffer.Count < len + 4) break;//数据不够的时候什么都不做  
70.                         //这里确保数据长度足够，数据头标志找到，我们开始计算校验  
71.                         //2.3 校验数据，确认数据正确  
72.                         //异或校验，逐个字节异或得到校验码  
73.                         byte checksum = 0;  
74.                         for (int i = 0; i < len + 3; i++)//len+3表示校验之前的位置  
75.                         \{  
76.                             checksum ^= buffer\[i\];  
77.                         \}  
78.                         if (checksum != buffer\[len + 3\]) //如果数据校验失败，丢弃这一包数据  
79.                         \{  
80.                             buffer.RemoveRange(0, len + 4);//从缓存中删除错误数据  
81.                             continue;//继续下一次循环  
82.                         \}  
83.                         //至此，已经被找到了一条完整数据。我们将数据直接分析，或是缓存起来一起分析  
84.                         //我们这里采用的办法是缓存一次，好处就是如果你某种原因，数据堆积在缓存buffer中  
85.                         //已经很多了，那你需要循环的找到最后一组，只分析最新数据，过往数据你已经处理不及时  
86.                         //了，就不要浪费更多时间了，这也是考虑到系统负载能够降低。  
87.                         buffer.CopyTo(0, binary\_data\_1, 0, len + 4);//复制一条完整数据到具体的数据缓存  
88.                         data\_1\_catched = true;  
89.                         buffer.RemoveRange(0, len + 4);//正确分析一条数据，从缓存中移除数据。  
90.                     \}  
91.                     else  
92.                     \{  
93.                         //这里是很重要的，如果数据开始不是头，则删除数据  
94.                         buffer.RemoveAt(0);  
95.                     \}  
96.                 \}  
97.                 //分析数据  
98.                 if (data\_1\_catched)  
99.                 \{  
100.                     //我们的数据都是定好格式的，所以当我们找到分析出的数据1，就知道固定位置一定是这些数据，我们只要显示就可以了  
101.                     string data = binary\_data\_1\[3\].ToString("X2") + " " + binary\_data\_1\[4\].ToString("X2") + " " +  
102.                         binary\_data\_1\[5\].ToString("X2") + " " + binary\_data\_1\[6\].ToString("X2") + " " +  
103.                         binary\_data\_1\[7\].ToString("X2");  
104.                     //更新界面  
105.                     this.Invoke((EventHandler)(delegate \{ txData.Text = data; \}));  
106.                 \}  
107.                 //如果需要别的协议，只要扩展这个data\_n\_catched就可以了。往往我们协议多的情况下，还会包含数据编号，给来的数据进行  
108.                 //编号，协议优化后就是： 头+编号+长度+数据+校验  
109.                 //</协议解析>  
110.                 /  
111.                 builder.Clear();//清除字符串构造器的内容  
112.                 //因为要访问ui资源，所以需要使用invoke方式同步ui。  
113.                 this.Invoke((EventHandler)(delegate  
114.                 \{  
115.                     //判断是否是显示为16禁止  
116.                     if (checkBoxHexView.Checked)  
117.                     \{  
118.                         //依次的拼接出16进制字符串  
119.                         foreach (byte b in buf)  
120.                         \{  
121.                             builder.Append(b.ToString("X2") + " ");  
122.                         \}  
123.                     \}  
124.                     else  
125.                     \{  
126.                         //直接按ASCII规则转换成字符串  
127.                         builder.Append(Encoding.ASCII.GetString(buf));  
128.                     \}  
129.                     //追加的形式添加到文本框末端，并滚动到最后。  
130.                     this.txGet.AppendText(builder.ToString());  
131.                     //修改接收计数  
132.                     labelGetCount.Text = "Get:" + received\_count.ToString();  
133.                 \}));  
134.             \}  
135.             finally  
136.             \{  
137.                 Listening = false;//我用完了，ui可以关闭串口了。  
138.             \}  
139.         \}  
140.         private void buttonOpenClose\_Click(object sender, EventArgs e)  
141.         \{  
142.             //根据当前串口对象，来判断操作  
143.             if (comm.IsOpen)  
144.             \{  
145.                 Closing = true;  
146.                 while (Listening) Application.DoEvents();  
147.                 //打开时点击，则关闭串口  
148.                 comm.Close();  
149.             \}  
150.             else  
151.             \{  
152.                 //关闭时点击，则设置好端口，波特率后打开  
153.                 comm.PortName = comboPortName.Text;  
154.                 comm.BaudRate = int.Parse(comboBaudrate.Text);  
155.                 try  
156.                 \{  
157.                     comm.Open();  
158.                 \}  
159.                 catch(Exception ex)  
160.                 \{  
161.                     //捕获到异常信息，创建一个新的comm对象，之前的不能用了。  
162.                     comm = new SerialPort();  
163.                     //现实异常信息给客户。  
164.                     MessageBox.Show(ex.Message);  
165.                 \}  
166.             \}  
167.             //设置按钮的状态  
168.             buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";  
169.             buttonSend.Enabled = comm.IsOpen;  
170.         \}  
171.         //动态的修改获取文本框是否支持自动换行。  
172.         private void checkBoxNewlineGet\_CheckedChanged(object sender, EventArgs e)  
173.         \{  
174.             txGet.WordWrap = checkBoxNewlineGet.Checked;  
175.         \}  
176.         private void buttonSend\_Click(object sender, EventArgs e)  
177.         \{  
178.             //定义一个变量，记录发送了几个字节  
179.             int n = 0;  
180.             //16进制发送  
181.             if (checkBoxHexSend.Checked)  
182.             \{  
183.                 //我们不管规则了。如果写错了一些，我们允许的，只用正则得到有效的十六进制数  
184.                 MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)\[/da-f\]\{2\}");  
185.                 List<byte> buf = new List<byte>();//填充到这个临时列表中  
186.                 //依次添加到列表中  
187.                 foreach (Match m in mc)  
188.                 \{  
189.                     buf.Add(byte.Parse(m.Value, System.Globalization.NumberStyles.HexNumber));  
190.                 \}  
191.                 //转换列表为数组后发送  
192.                 comm.Write(buf.ToArray(), 0, buf.Count);  
193.                 //记录发送的字节数  
194.                 n = buf.Count;  
195.             \}  
196.             else//ascii编码直接发送  
197.             \{  
198.                 //包含换行符  
199.                 if (checkBoxNewlineSend.Checked)  
200.                 \{  
201.                     comm.WriteLine(txSend.Text);  
202.                     n = txSend.Text.Length + 2;  
203.                 \}  
204.                 else//不包含换行符  
205.                 \{  
206.                     comm.Write(txSend.Text);  
207.                     n = txSend.Text.Length;  
208.                 \}  
209.             \}  
210.             send\_count += n;//累加发送字节数  
211.             labelSendCount.Text = "Send:" + send\_count.ToString();//更新界面  
212.         \}  
213.         private void buttonReset\_Click(object sender, EventArgs e)  
214.         \{  
215.             //复位接受和发送的字节数计数器并更新界面。  
216.             send\_count = received\_count = 0;  
217.             labelGetCount.Text = "Get:0";  
218.             labelSendCount.Text = "Send:0";  
219.         \}  
220.     \}  
221. \}

至此，你只要按这个协议格式发送数据到软件打开的串口。就能在数据的data标签显示出你的数据内容，我们现在是直接显示为：

01 02 03 04 05

也就是数据段内容。

**运行截图：**

![请注意红色部分][38687_12749250133JEj.png]

发送模拟数据的界面，使用通用工具SSCOMM32.exe

![sscomm32.exe 发送模拟数据的界面][sscomm32.exe]

我们在回顾一下，一般二进制格式数据就是这样分析，分析数据长度是否足够，找到数据头，数据长度，校验，然后分析。

分析方式很多。结合各自实际情况操作，可以使用序列化方式，但是wince不支持，也可以用BitConvert方式将连续的字节读取为某个类型的变量。

希望看到这里，能给你带来帮助，欢迎大家和我讨论，希望经验丰富的朋友不吝赐教。上一篇中，有朋友说用BeginInvoke可以避免死锁问题，我暂时没有线，没有测试成功，改天测试后再公布结果。

DataReceived事件中，最高效的做法是指缓存数据，然后异步的去分析数据。但是，这样较复杂，在效率要求不是很高的情况下（大多数情况），可以在DataReceived事件中缓存数据后，立刻进行数据完整性检查，有效性检查，分析数据，以及更新界面。但这么做有一个隐患，底层串口操作的效率依赖于数据分析和界面更新，任何一个环节频繁耗时过长，都会造成数据的堆积。文章只假设都不拖时间的情况。

谢谢观赏，通讯协议分析系列，未完待续……

[2010示例代码][2010]

[2008示例代码][2008]

[Link 1]: http://blog.csdn.net/wuyazhe/article/details/5627253
[38687_1274925013eiiD.png]: /images/20220805/67dd05cfd707414aba650b3e46d19302.png
[view plain]: http://blog.csdn.net/wuyazhe/article/details/5627253#
[38687_12749250133JEj.png]: /images/20220805/9ef4490d690a4580a4e3b5f3c6f84eb4.png
[sscomm32.exe]: /images/20220805/96219628bc1b4f6f88ecec38bcdc0c96.png
[2010]: http://d.download.csdn.net/down/2398674/wuyazhe
[2008]: http://d.download.csdn.net/down/2503235/wuyazhe