C# 串口操做系列(3) -- 協議篇，二進制協議數據解析

時間 2019-11-10

標籤 c# 串口系列協議二進制數據解析欄目 C# 简体版

原文原文鏈接

C# 串口操做系列(3) -- 協議篇，二進制協議數據解析

標籤： c#buffer object 通信 byte 硬件驅動

2010-05-27 09:54 51565人閱讀評論(215) 收藏舉報

分類：

通信類庫設計（4）

咱們的串口程序，除了通用的，進行串口監聽收發的簡單工具，大多都和下位機有關，這就須要關心咱們的通信協議如何緩存，分析，以及通知界面。算法

咱們先說一下通信協議。通信協議就是通信雙方共同遵循的一套規則，定義協議的原則是儘量的簡單以提升傳輸率，儘量的具備安全性保證數據傳輸完整正確。基於這2點規則，咱們一個通信協議應該是這樣的：頭+數據長度+數據正文+校驗c#

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

這裏我假設的一條數據，協議以下：數組

數據頭： 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(肯定性有限狀態機))

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

代碼以下：

[c-sharp] view plain copy

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