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

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

    我们先说一下通讯协议。通讯协议就是通讯双方共同遵循的一套规则，定义协议的原则是尽可能的简单以提高传输率，尽可能的具有安全性保证数据传输完整正确。基于这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，内部是数组方式实现，每次数据不足够的时候会扩容1倍，数据的增删改都已经做的很完善了。不会出现什么小问题。

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

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

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

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

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

   

代码如下：

 

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.IO.Ports;
using System.Text.RegularExpressions;
namespace SerialportSample
{
    public partial class SerialportSampleForm : Form
    {
        private SerialPort comm = new SerialPort();
        private StringBuilder builder = new StringBuilder();//避免在事件处理方法中反复的创建，定义到外面。
        private long received_count = 0;//接收计数
        private long send_count = 0;//发送计数
        private bool Listening = false;//是否没有执行完invoke相关操作
        private bool Closing = false;//是否正在关闭串口，执行Application.DoEvents，并阻止再次invoke
        private List<byte> buffer = new List<byte>(4096);//默认分配1页内存，并始终限制不允许超过
        private byte[] binary_data_1 = new byte[9];//AA 44 05 01 02 03 04 05 EA
        public SerialportSampleForm()
        {
            InitializeComponent();
        }
        //窗体初始化
        private void Form1_Load(object sender, EventArgs e)
        {
            //初始化下拉串口名称列表框
            string[] ports = SerialPort.GetPortNames();
            Array.Sort(ports);
            comboPortName.Items.AddRange(ports);
            comboPortName.SelectedIndex = comboPortName.Items.Count > 0 ? 0 : -1;
            comboBaudrate.SelectedIndex = comboBaudrate.Items.IndexOf("19200");
            //初始化SerialPort对象
            comm.NewLine = "/r/n";
            comm.RtsEnable = true;//根据实际情况吧。
            //添加事件注册
            comm.DataReceived += comm_DataReceived;
        }
        void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            if (Closing) return;//如果正在关闭，忽略操作，直接返回，尽快的完成串口监听线程的一次循环
            try
            {
                Listening = true;//设置标记，说明我已经开始处理数据，一会儿要使用系统UI的。
                int n = comm.BytesToRead;//先记录下来，避免某种原因，人为的原因，操作几次之间时间长，缓存不一致
                byte[] buf = new byte[n];//声明一个临时数组存储当前来的串口数据
                received_count += n;//增加接收计数
                comm.Read(buf, 0, n);//读取缓冲数据
                /
                //<协议解析>
                bool data_1_catched = false;//缓存记录数据是否捕获到
                //1.缓存数据
                buffer.AddRange(buf);
                //2.完整性判断
                while (buffer.Count >= 4)//至少要包含头（2字节）+长度（1字节）+校验（1字节）
                {
                    //请不要担心使用>=，因为>=已经和>,<,=一样，是独立操作符，并不是解析成>和=2个符号
                    //2.1 查找数据头
                    if (buffer[0] == 0xAA && buffer[1] == 0x44)
                    {
                        //2.2 探测缓存数据是否有一条数据的字节，如果不够，就不用费劲的做其他验证了
                        //前面已经限定了剩余长度>=4，那我们这里一定能访问到buffer[2]这个长度
                        int len = buffer[2];//数据长度
                        //数据完整判断第一步，长度是否足够
                        //len是数据段长度,4个字节是while行注释的3部分长度
                        if (buffer.Count < len + 4) break;//数据不够的时候什么都不做
                        //这里确保数据长度足够，数据头标志找到，我们开始计算校验
                        //2.3 校验数据，确认数据正确
                        //异或校验，逐个字节异或得到校验码
                        byte checksum = 0;
                        for (int i = 0; i < len + 3; i++)//len+3表示校验之前的位置
                        {
                            checksum ^= buffer[i];
                        }
                        if (checksum != buffer[len + 3]) //如果数据校验失败，丢弃这一包数据
                        {
                            buffer.RemoveRange(0, len + 4);//从缓存中删除错误数据
                            continue;//继续下一次循环
                        }
                        //至此，已经被找到了一条完整数据。我们将数据直接分析，或是缓存起来一起分析
                        //我们这里采用的办法是缓存一次，好处就是如果你某种原因，数据堆积在缓存buffer中
                        //已经很多了，那你需要循环的找到最后一组，只分析最新数据，过往数据你已经处理不及时
                        //了，就不要浪费更多时间了，这也是考虑到系统负载能够降低。
                        buffer.CopyTo(0, binary_data_1, 0, len + 4);//复制一条完整数据到具体的数据缓存
                        data_1_catched = true;
                        buffer.RemoveRange(0, len + 4);//正确分析一条数据，从缓存中移除数据。
                    }
                    else
                    {
                        //这里是很重要的，如果数据开始不是头，则删除数据
                        buffer.RemoveAt(0);
                    }
                }
                //分析数据
                if (data_1_catched)
                {
                    //我们的数据都是定好格式的，所以当我们找到分析出的数据1，就知道固定位置一定是这些数据，我们只要显示就可以了
                    string data = binary_data_1[3].ToString("X2") + " " + binary_data_1[4].ToString("X2") + " " +
                        binary_data_1[5].ToString("X2") + " " + binary_data_1[6].ToString("X2") + " " +
                        binary_data_1[7].ToString("X2");
                    //更新界面
                    this.Invoke((EventHandler)(delegate { txData.Text = data; }));
                }
                //如果需要别的协议，只要扩展这个data_n_catched就可以了。往往我们协议多的情况下，还会包含数据编号，给来的数据进行
                //编号，协议优化后就是： 头+编号+长度+数据+校验
                //
                /
                builder.Clear();//清除字符串构造器的内容
                //因为要访问ui资源，所以需要使用invoke方式同步ui。
                this.Invoke((EventHandler)(delegate
                {
                    //判断是否是显示为16禁止
                    if (checkBoxHexView.Checked)
                    {
                        //依次的拼接出16进制字符串
                        foreach (byte b in buf)
                        {
                            builder.Append(b.ToString("X2") + " ");
                        }
                    }
                    else
                    {
                        //直接按ASCII规则转换成字符串
                        builder.Append(Encoding.ASCII.GetString(buf));
                    }
                    //追加的形式添加到文本框末端，并滚动到最后。
                    this.txGet.AppendText(builder.ToString());
                    //修改接收计数
                    labelGetCount.Text = "Get:" + received_count.ToString();
                }));
            }
            finally
            {
                Listening = false;//我用完了，ui可以关闭串口了。
            }
        }
        private void buttonOpenClose_Click(object sender, EventArgs e)
        {
            //根据当前串口对象，来判断操作
            if (comm.IsOpen)
            {
                Closing = true;
                while (Listening) Application.DoEvents();
                //打开时点击，则关闭串口
                comm.Close();
            }
            else
            {
                //关闭时点击，则设置好端口，波特率后打开
                comm.PortName = comboPortName.Text;
                comm.BaudRate = int.Parse(comboBaudrate.Text);
                try
                {
                    comm.Open();
                }
                catch(Exception ex)
                {
                    //捕获到异常信息，创建一个新的comm对象，之前的不能用了。
                    comm = new SerialPort();
                    //现实异常信息给客户。
                    MessageBox.Show(ex.Message);
                }
            }
            //设置按钮的状态
            buttonOpenClose.Text = comm.IsOpen ? "Close" : "Open";
            buttonSend.Enabled = comm.IsOpen;
        }
        //动态的修改获取文本框是否支持自动换行。
        private void checkBoxNewlineGet_CheckedChanged(object sender, EventArgs e)
        {
            txGet.WordWrap = checkBoxNewlineGet.Checked;
        }
        private void buttonSend_Click(object sender, EventArgs e)
        {
            //定义一个变量，记录发送了几个字节
            int n = 0;
            //16进制发送
            if (checkBoxHexSend.Checked)
            {
                //我们不管规则了。如果写错了一些，我们允许的，只用正则得到有效的十六进制数
                MatchCollection mc = Regex.Matches(txSend.Text, @"(?i)[/da-f]{2}");
                List<byte> buf = new List<byte>();//填充到这个临时列表中
                //依次添加到列表中
                foreach (Match m in mc)
                {
                    buf.Add(byte.Parse(m.Value, System.Globalization.NumberStyles.HexNumber));
                }
                //转换列表为数组后发送
                comm.Write(buf.ToArray(), 0, buf.Count);
                //记录发送的字节数
                n = buf.Count;
            }
            else//ascii编码直接发送
            {
                //包含换行符
                if (checkBoxNewlineSend.Checked)
                {
                    comm.WriteLine(txSend.Text);
                    n = txSend.Text.Length + 2;
                }
                else//不包含换行符
                {
                    comm.Write(txSend.Text);
                    n = txSend.Text.Length;
                }
            }
            send_count += n;//累加发送字节数
            labelSendCount.Text = "Send:" + send_count.ToString();//更新界面
        }
        private void buttonReset_Click(object sender, EventArgs e)
        {
            //复位接受和发送的字节数计数器并更新界面。
            send_count = received_count = 0;
            labelGetCount.Text = "Get:0";
            labelSendCount.Text = "Send:0";
        }
    }
}

 

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

01 02 03 04 05

也就是数据段内容。

 

运行截图：

 

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

 

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

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

 

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

 

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

 

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

2010示例代码

2008示例代码