協議篇，二進制協議數據解析

我們先說一下通訊協議。通訊協議就是通訊雙方共同遵循的一套規則，定義協議的原則是盡可能的簡單以提高傳輸率，盡可能的具有安全性保證數據傳輸完整正確。基於這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(確定性有限狀態機))

    我們修改一下界面，以便能顯示收到后分析的數據

    

 

代碼如下：

 

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示例代碼