使用高性能Pipelines構建.NET通訊程式

来源:https://www.cnblogs.com/podolski/archive/2019/05/04/10807204.html
-Advertisement-
Play Games

.NET Standard支持一組新的API,System.Span, System.Memory,還有System.IO.Pipelines。這幾個新的API極大了提升了.NET程式的效能,將來.NET很多基礎API都會使用它們進行重寫。 Pipelines旨在解決.NET編寫Socket通信程式 ...


.NET Standard支持一組新的API,System.Span, System.Memory,還有System.IO.Pipelines。這幾個新的API極大了提升了.NET程式的效能,將來.NET很多基礎API都會使用它們進行重寫。

Pipelines旨在解決.NET編寫Socket通信程式時的很多困難,相信讀者也對此不勝其煩,使用stream模型進行編程,就算能夠解決,也是實在麻煩。

System.IO.Pipelines使用簡單的記憶體片段來管理數據,可以極大的簡化編寫程式的過程。關於Pipelines的詳細介紹,可以看看這裡。現在ASP.NET Core中使用的Kestrel已經在使用這個API。(話說這個東西貌似就是Kestrel團隊搞出來的。)

可能是直接需要用Socket場景有限(物聯網用的還挺多的),Pipelines相關的資料感覺不是很多。官方給出的示例是基於ASCII協議的,有固定結尾的協議,這裡我以物聯網設備常用的BINARY二進位自定義協議為例,講解基於Pipelines的程式套路。

System.IO.Pipelines

與基於Stream的方式不同,pipelines提供一個pipe,用於存儲數據,pipe中間存儲的數據有點鏈表的感覺,可以基於SequencePosition進行slice操作,這樣就能得到一個ReadOnlySequence<T>對象。reader可以進行自定義操作,併在操作完成之後告訴pipe已經處理了多少數據,整個過程是不需要進行記憶體複製操作的,因此性能得到了提升,還少了很多麻煩。可以簡單理解作為伺服器端,流程:

接受數據迴圈:接到數據->放pipe裡面->告訴pipe放了多少數據
處理數據迴圈:在pipe裡面找一條完整數據->交給處理流程->告訴pipe處理了多少數據

協議

有一款設備,binary協議,數據包開頭0x75, 0xbd, 0x7e, 0x97一共4個位元組,隨後跟數據包長度2個位元組(固定2400位元組,不固定長度也可以參照),隨後是數據區。在設備連接成功之後,數據主動從設備發送到PC。

關鍵代碼

雖然是.NET Core平臺的,但是.NET FRAMEWORK 4.6.1上面也可以nuget安裝,直接

install-package system.io.pipelines

進行安裝就可以了。Socket相關處理的代碼不再寫了,只列關鍵的。

代碼第一步是聲明pipe。

private async void InitPipe(Socket socket)
{
    Pipe pipe = new Pipe();
    Task writing = FillPipeAsync(socket, pipe.Writer);
    Task reading = ReadPipeAsync(socket, pipe.Reader);

    await Task.WhenAll(reading, writing);
}

pipe有reader還有一個writer,reader負責讀取pipe數據,主要用在數據處理迴圈,writer負責將數據寫入pipe,主要用在數據接受迴圈。

//寫入迴圈
private async Task FillPipeAsync(Socket socket, PipeWriter writer)
{
    //數據流量比較大,用1M位元組作為buffer
    const int minimumBufferSize = 1024 * 1024;

    while (running)
    {
        try
        {
            //從writer中,獲得一段不少於指定大小的記憶體空間
            Memory<byte> memory = writer.GetMemory(minimumBufferSize);

            //將記憶體空間變成ArraySegment,提供給socket使用
            if (!MemoryMarshal.TryGetArray((ReadOnlyMemory<byte>)memory, out ArraySegment<byte> arraySegment))
            {
                throw new InvalidOperationException("Buffer backed by array was expected");
            }
            //接受數據
            int bytesRead = await SocketTaskExtensions.ReceiveAsync(socket, arraySegment, SocketFlags.None);
            if (bytesRead == 0)
            {
                break;
            }

            //一次接受完畢,數據已經在pipe中,告訴pipe已經給它寫了多少數據。
            writer.Advance(bytesRead);
        }
        catch
        {
            break;
        }

        // 提示reader可以進行讀取數據,reader可以繼續執行readAsync()方法
        FlushResult result = await writer.FlushAsync();

        if (result.IsCompleted)
        {
            break;
        }
    }

    // 告訴pipe完事了
    writer.Complete();
}

//讀取迴圈
private async Task ReadPipeAsync(Socket socket, PipeReader reader)
{
    while (running)
    {
        //等待writer寫數據
        ReadResult result = await reader.ReadAsync();
        //獲得記憶體區域
        ReadOnlySequence<byte> buffer = result.Buffer;
        SequencePosition? position = null;

        do
        {
            //尋找head的第一個位元組所在的位置
            position = buffer.PositionOf((byte)0x75);
            if (position != null)
            {
                //由於是連續四個位元組作為head,需要進行比對,我這裡直接使用了ToArray方法,還是有了記憶體拷貝動作,不是很理想,但是寫起來很方便。
                //對性能有更高要求的場景,可以進行slice操作後的單獨比對,這樣不需要記憶體拷貝動作
                var headtoCheck = buffer.Slice(position.Value, 4).ToArray();
                //SequenceEqual需要引用System.Linq
                if (headtoCheck.SequenceEqual(new byte[] { 0x75, 0xbd, 0x7e, 0x97 }))
                {
                    //到這裡,認為找到包開頭了(從position.value開始),接下來需要從開頭處截取整包的長度,需要先判斷長度是否足夠
                    if (buffer.Slice(position.Value).Length >= 2400)
                    {
                        //長度足夠,那麼取出ReadOnlySequence,進行操作
                        var mes = buffer.Slice(position.Value, 2400);
                        //這裡是數據處理的函數,可以參考官方文檔對ReadOnlySequence進行操作,文檔裡面使用了span,那樣性能會好一些。我這裡簡單實用ToArray()操作,這樣也有了記憶體拷貝的問題,但是處理的直接是byte數組了。
                        await ProcessMessage(mes.ToArray());
                        //這一段就算是完成了,從開頭位置,一整個包的長度就算完成了
                        var next = buffer.GetPosition(2400, position.Value);
                        //將buffer處理過的捨棄,替換為剩餘的buffer引用
                        buffer = buffer.Slice(next);
                    }
                    else
                    {
                        //長度不夠,說明數據包不完整,等下一波數據進來再拼接,跳出迴圈。
                        break;
                    }
                }
                else
                {
                    //第一個是0x75但是後面不匹配,可能有數據傳輸問題,那麼需要捨棄第一個,0x75後面的位元組開始再重新找0x75
                    var next = buffer.GetPosition(1, position.Value);
                    buffer = buffer.Slice(next);
                }
            }
        }
        while (position != null);

        //數據處理完畢,告訴pipe還剩下多少數據沒有處理(數據包不完整的數據,找不到head)
        reader.AdvanceTo(buffer.Start, buffer.End);

        if (result.IsCompleted)
        {
            break;
        }
    }

    reader.Complete();
}

以上代碼基本解決了以下問題:

  • 數據接收不完整,找不到開頭結尾,導致數據大量丟棄,或者自己維護一個queue的代碼複雜性
  • 數據接收與處理的同步問題
  • 一次性收到多條數據的情況

後記

本文只是解釋了pipeline處理的模式,對於茫茫多的ToArray方法,可以使用基於Span的操作進行優化(有時間就來填坑)。另外,如果在await ProcessMessage(mes.ToArray());這裡,直接使用Task.Run(()=>ProcessMessage(mes);代替的話,實測會出現莫名其妙的問題,很有可能是pipe運行快,在系統調度Task之前,已經將記憶體釋放導致的,如果需要優化這一塊的話,需要格外註意。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • join()函數的用法 join()函數連接字元串數組。將字元串、元組、列表中的元素以指定的字元(分隔符)連接生成一個新的字元串 語法:'sep'.join(seq) 參數說明sep:分隔符。可以為空seq:要連接的元素序列、字元串、元組、字典上面的語法即:以sep作為分隔符,將seq所有的元素合併 ...
  • 相同的樹 難度分類 簡單 題目描述 給定兩個二叉樹,編寫一個函數來檢驗它們是否相同。 如果兩個樹在結構上相同,並且節點具有相同的值,則認為它們是相同的。 示例 1: 輸入: 1 1 / \ / \ 2 3 2 3 [1,2,3], [1,2,3] 輸出: true 示例 2: 輸入: 1 1 / \ ...
  • 難度分類 簡單 題目描述 兩個整數之間的漢明距離指的是這兩個數字對應二進位位不同的位置的數目。給出兩個整數 x 和 y,計算它們之間的漢明距離 註意: 0 ≤ x, y < 231. 示例: 輸入: x = 1, y = 4 輸出: 2 解釋: 1 (0 0 0 1) 4 (0 1 0 0) ↑ ↑ ...
  • [學習筆記] 3)Spring Cloud是什麼?馬克-to-win@馬克java社區:i)Spring Cloud是一個微服務框架,Spring Cloud基於微服務基礎框架Netflix進行了upgrade,同時又能和Spring Boot開發框架集成開發。ii)Sping Cloud是Spri ...
  • String字元串 字元串由String類提供,除了直接使用單雙引號或其它字面量創建字元串,也可以使用String.new()方法來創建。 Ruby中的 字元串是可變對象 。 字元串的連接 直接連接即可: 單雙引號 這和Perl一樣,和Shell也類似。單引號是強引用,雙引號是弱引用。 雙引號的一個 ...
  • 我們現在知道了Python是一門解釋型語言,代碼想運行,必須通過解釋器執行,Python的解釋器本身也可以看作是個程式(翻譯官司是哪國人不重要),這個程式是什麼語言開發的呢? 答案是好幾種語言? what? 因為Python有好幾種解釋器,分別基於不同語言開發,每個解釋器特點不同,但都能正常運行我們 ...
  • Ruby中設計了很多種比較方式,所有對象都能進行 這幾種比較。此外,當實現了 =、 、between?`這幾個比較方法。 這些比較方法的定義位置和意義分別如下。 在BasicObject中定義了 : :比較內容是否相同,更多時候是描述兩者是否相等,比如 的內容是不同的,但是相等 :和 是相反的 :比 ...
  • rbenv rbenv可以管理多個版本的ruby。可以分為3種範圍(或者說不同生效作用域)的版本: local版:本地,針對各項目範圍 global版:全局,沒有shell和local版時使用global版 shell版:當前終端,只針對當前所在終端 查找優先順序為 。 1.安裝rbenv 2.安裝r ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...