簡潔實用Socket框架DotNettySocket

来源:https://www.cnblogs.com/coldairarrow/archive/2019/08/12/11336771.html
-Advertisement-
Play Games

目錄 "簡介" "產生背景" "使用方式" "TcpSocket" "WebSocket" "UdpSocket" "結尾" 簡介 DotNettySocket是一個.NET跨平臺Socket框架（支持.NET4.5+及.NET Standard2.0+），同時支持TcpSocket、WebSock ...


目錄

簡介

DotNettySocket是一個.NET跨平臺Socket框架（支持.NET4.5+及.NET Standard2.0+），同時支持TcpSocket、WebSocket和UdpSocket，其基於微軟強大的DotNetty框架，力求為Socket通訊提供簡單、高效、優雅的操作方式。

安裝方式：Nuget安裝DotNettySocket即可

項目地址：https://github.com/Coldairarrow/DotNettySocket

產生背景

兩年前最開始接觸物聯網的時候，需要用到Tcp及Udp通訊，為了方便使用，將原始的Socket進行了簡單的封裝，基本滿足了需求，並將框架開源。但是由於精力及實力有限，沒有進一步優化原框架。後來發現了強大的DotNetty框架，DotNetty是微軟Azure團隊開源基於Java Netty框架的移植版，其性能優異、維護團隊強大，許多.NET強大的框架都使用它。DotNetty功能強大，但是用起來還是不夠簡潔（或許是個人感覺），剛好最近項目需要用到WebSocket，因此鄙人抽時間基於DotNetty進行簡單封裝了下，擼出一個力求簡單、高效、優雅的Socket框架。

使用方式

TcpSocket

Tcp是面向連接的，所以服務端對連接的管理就至關重要，框架支持各種事件的處理、給連接設置連接名（身份標識）、通過連接名找到特定連接、連接收發數據、分包、粘包處理。

  • 服務端
using Coldairarrow.DotNettySocket;
using System;
using System.Text;
using System.Threading.Tasks;

namespace TcpSocket.Server
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theServer = await SocketBuilderFactory.GetTcpSocketServerBuilder(6001)
                .SetLengthFieldEncoder(2)
                .SetLengthFieldDecoder(ushort.MaxValue, 0, 2, 0, 2)
                .OnConnectionClose((server, connection) =>
                {
                    Console.WriteLine($"連接關閉,連接名[{connection.ConnectionName}],當前連接數:{server.GetConnectionCount()}");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"服務端異常:{ex.Message}");
                })
                .OnNewConnection((server, connection) =>
                {
                    connection.ConnectionName = $"名字{connection.ConnectionId}";
                    Console.WriteLine($"新的連接:{connection.ConnectionName},當前連接數:{server.GetConnectionCount()}");
                })
                .OnRecieve((server, connection, bytes) =>
                {
                    Console.WriteLine($"服務端:數據{Encoding.UTF8.GetString(bytes)}");
                    connection.Send(bytes);
                })
                .OnSend((server, connection, bytes) =>
                {
                    Console.WriteLine($"向連接名[{connection.ConnectionName}]發送數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnServerStarted(server =>
                {
                    Console.WriteLine($"服務啟動");
                }).BuildAsync();

            Console.ReadLine();
        }
    }
}
  • 客戶端
using Coldairarrow.DotNettySocket;
using System;
using System.Net;
using System.Text;
using System.Threading.Tasks;

namespace UdpSocket.Client
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theClient = await SocketBuilderFactory.GetUdpSocketBuilder()
                .OnClose(server =>
                {
                    Console.WriteLine($"客戶端關閉");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"客戶端異常:{ex.Message}");
                })
                .OnRecieve((server, point, bytes) =>
                {
                    Console.WriteLine($"客戶端:收到來自[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnSend((server, point, bytes) =>
                {
                    Console.WriteLine($"客戶端發送數據:目標[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnStarted(server =>
                {
                    Console.WriteLine($"客戶端啟動");
                }).BuildAsync();

            while (true)
            {
                await theClient.Send(Guid.NewGuid().ToString(), new IPEndPoint(IPAddress.Parse("127.0.0.1"), 6003));
                await Task.Delay(1000);
            }
        }
    }
}

WebSocket

WebSocket與TcpSocket介面基本保持一致，僅有的區別就是TcpSocket支持位元組的收發並且需要自行處理分包粘包。而WebSocket直接收發字元串（UTF-8）編碼，並且無需考慮分包粘包。框架目前沒有支持WSS，建議解決方案是使用Nginx轉發即可（相關資料一搜便有）

  • 服務端
using Coldairarrow.DotNettySocket;
using System;
using System.Threading.Tasks;

namespace WebSocket.Server
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theServer = await SocketBuilderFactory.GetWebSocketServerBuilder(6002)
                .OnConnectionClose((server, connection) =>
                {
                    Console.WriteLine($"連接關閉,連接名[{connection.ConnectionName}],當前連接數:{server.GetConnectionCount()}");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"服務端異常:{ex.Message}");
                })
                .OnNewConnection((server, connection) =>
                {
                    connection.ConnectionName = $"名字{connection.ConnectionId}";
                    Console.WriteLine($"新的連接:{connection.ConnectionName},當前連接數:{server.GetConnectionCount()}");
                })
                .OnRecieve((server, connection, msg) =>
                {
                    Console.WriteLine($"服務端:數據{msg}");
                    connection.Send(msg);
                })
                .OnSend((server, connection, msg) =>
                {
                    Console.WriteLine($"向連接名[{connection.ConnectionName}]發送數據:{msg}");
                })
                .OnServerStarted(server =>
                {
                    Console.WriteLine($"服務啟動");
                }).BuildAsync();

            Console.ReadLine();
        }
    }
}
  • 控制台客戶端
using Coldairarrow.DotNettySocket;
using System;
using System.Threading.Tasks;

namespace WebSocket.ConsoleClient
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theClient = await SocketBuilderFactory.GetWebSocketClientBuilder("127.0.0.1", 6002)
                .OnClientStarted(client =>
                {
                    Console.WriteLine($"客戶端啟動");
                })
                .OnClientClose(client =>
                {
                    Console.WriteLine($"客戶端關閉");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"異常:{ex.Message}");
                })
                .OnRecieve((client, msg) =>
                {
                    Console.WriteLine($"客戶端:收到數據:{msg}");
                })
                .OnSend((client, msg) =>
                {
                    Console.WriteLine($"客戶端:發送數據:{msg}");
                })
                .BuildAsync();

            while (true)
            {
                await theClient.Send(Guid.NewGuid().ToString());

                await Task.Delay(1000);
            }
        }
    }
}
  • 網頁客戶端
<!DOCTYPE HTML>
<html>
<head>
    <meta charset="utf-8">
    <title>菜鳥教程(runoob.com)</title>

    <script type="text/javascript">
        function WebSocketTest() {
            if ("WebSocket" in window) {
                var ws = new WebSocket("ws://127.0.0.1:6002");

                ws.onopen = function () {
                    console.log('連上服務端');
                    setInterval(function () {
                        ws.send("111111");
                    }, 1000);
                };

                ws.onmessage = function (evt) {
                    var received_msg = evt.data;
                    console.log('收到' + received_msg);
                };

                ws.onclose = function () {
                    console.log("連接已關閉...");
                };
            }

            else {
                alert("您的瀏覽器不支持 WebSocket!");
            }
        }
    </script>

</head>
<body>
    <div id="sse">
        <a href="javascript:WebSocketTest()">運行 WebSocket</a>
    </div>
</body>
</html>

UdpSocket

Udp天生便是收發一體的，以下分為服務端與客戶端僅僅是為了方便理解

  • 服務端
using Coldairarrow.DotNettySocket;
using System;
using System.Text;
using System.Threading.Tasks;

namespace UdpSocket.Server
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theServer = await SocketBuilderFactory.GetUdpSocketBuilder(6003)
                .OnClose(server =>
                {
                    Console.WriteLine($"服務端關閉");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"服務端異常:{ex.Message}");
                })
                .OnRecieve((server, point, bytes) =>
                {
                    Console.WriteLine($"服務端:收到來自[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                    server.Send(bytes, point);
                })
                .OnSend((server, point, bytes) =>
                {
                    Console.WriteLine($"服務端發送數據:目標[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnStarted(server =>
                {
                    Console.WriteLine($"服務端啟動");
                }).BuildAsync();

            Console.ReadLine();
        }
    }
}
  • 客戶端
using Coldairarrow.DotNettySocket;
using System;
using System.Net;
using System.Text;
using System.Threading.Tasks;

namespace UdpSocket.Client
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var theClient = await SocketBuilderFactory.GetUdpSocketBuilder()
                .OnClose(server =>
                {
                    Console.WriteLine($"客戶端關閉");
                })
                .OnException(ex =>
                {
                    Console.WriteLine($"客戶端異常:{ex.Message}");
                })
                .OnRecieve((server, point, bytes) =>
                {
                    Console.WriteLine($"客戶端:收到來自[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnSend((server, point, bytes) =>
                {
                    Console.WriteLine($"客戶端發送數據:目標[{point.ToString()}]數據:{Encoding.UTF8.GetString(bytes)}");
                })
                .OnStarted(server =>
                {
                    Console.WriteLine($"客戶端啟動");
                }).BuildAsync();

            while (true)
            {
                await theClient.Send(Guid.NewGuid().ToString(), new IPEndPoint(IPAddress.Parse("127.0.0.1"), 6003));
                await Task.Delay(1000);
            }
        }
    }
}

結尾

以上所有示例在源碼中都有，若覺得不錯請點贊加星星，希望能夠幫助到大家。

有任何問題請及時反饋或加群交流

QQ群1:（已滿）

QQ群2:579202910


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

-Advertisement-
Play Games
更多相關文章
  • 工作流設計過程
    1.業務場景：用戶登錄，收到消息通知，審批業務，根據配置的流程繼續流轉，最終審核發送回給申請人(終審同意結束，終審不同意申請人可以繼續修改提交)。 2.思路過程： 3..資料庫設計： 4.代碼過程： ...
  • abp(net core)+easyui+efcore實現倉儲管理系統——使用 WEBAPI實現CURD (十三)
    上接(abp(net core)+easyui+efcore實現倉儲管理系統——使用 WEBAPI實現CURD (十二))，在這一篇文章中我們創建視圖模型、列表視圖、添加菜單。 ...
  • （16）ASP.NET Core 通用主機（HostBuilder）
    1.前言 ASP.NET Core應用程式可以配置和啟動主機（Host）。主機負責應用程式啟動和生命周期管理。通用主機用於無法處理HTTP請求的應用程式。通用主機的用途是將HTTP管道從Web主機API中分離出來，從而啟用更多的主機方案。 基於通用主機的消息、後臺任務和其他非HTTP工作負載可從橫切 ...
  • .NET Core 數據結構與演算法 1-1
    .NET Core 數據結構與演算法 1 1 本節內容為順序表 簡介 線性表是簡單、基本、常用的數據結構。線性表是線性結構的抽象 (Abstract)，線性結構的特點是結構中的數據元素之間存在一對一的線性關係。這 種一對一的關係指的是數據元素之間的位置關係，即： 除第一個位置的數據元素外，其它數據元素 ...
  • RBAC許可權框架_MVC許可權框架
    RBAC許可權框架(Role-Based Access Control)基於角色的許可權訪問控制的框架,通過用戶-角色-許可權的關聯,非常方便的進行許可權管理,在這裡不再說明什麼是RBAC,請自行百度. 謝謝大家的捧場,如文章中有錯誤或者,請聯繫我或者給我發郵件[email protected],修正後 ...
  • C# 修飾符
    訪問修飾符 訪問修飾符 C# 中常用的有 private、public、protected、internal 4個訪問修飾符。 private：私有訪問是允許的最低訪問級別，私有成員只有在聲明它們的類和結構中才可以訪問。 public：公共訪問是允許的最高訪問級別，對訪問公共成員沒有限制。 prot ...
  • C#簡單工廠案例
    using System; namespace Application { class JianDanGongChang { static void Main(string[] args) { Factory factory=new Factory(); DianNao diannao=factor... ...
  • 阿拉伯數字轉換為中文數字/中文數字轉換為阿拉伯數字
    項目中經常會格式化數據，轉換數字的使用情況比較多，記錄一下數字轉換的方法！ 如果需要轉換為繁體中文，將數組裡的漢字換成繁體中文即可。 1.阿拉伯數字轉換為中文數字 2.中文數字轉換為阿拉伯數字 ...
一周排行
    -Advertisement-
    Play Games
  • Dapr Outbox 執行流程
    Dapr Outbox 是1.12中的功能。 本文只介紹Dapr Outbox 執行流程，Dapr Outbox基本用法請閱讀官方文檔 。本文中appID=order-processor，topic=orders 本文前提知識：熟悉Dapr狀態管理、Dapr發佈訂閱和Outbox 模式。 Outbo ...
  • Advanced .Net Debugging 7：托管堆與垃圾收集
    引言 在前幾章我們深度講解了單元測試和集成測試的基礎知識，這一章我們來講解一下代碼覆蓋率,代碼覆蓋率是單元測試運行的度量值,覆蓋率通常以百分比表示，用於衡量代碼被測試覆蓋的程度，幫助開發人員評估測試用例的質量和代碼的健壯性。常見的覆蓋率包括語句覆蓋率（Line Coverage）、分支覆蓋率（Bra ...
  • C#S7.NET實現西門子PLCDB塊數據採集的完整步驟
    前言 本文介紹瞭如何使用S7.NET庫實現對西門子PLC DB塊數據的讀寫，記錄了使用電腦模擬，模擬PLC，自至完成測試的詳細流程，並重點介紹了在這個過程中的易錯點，供參考。 用到的軟體： 1.Windows環境下鏈路層網路訪問的行業標準工具（WinPcap_4_1_3.exe）下載鏈接：http ...
  • WPF控制項：密碼框綁定MVVM
    從依賴倒置原則（Dependency Inversion Principle, DIP）到控制反轉（Inversion of Control, IoC）再到依賴註入（Dependency Injection, DI）的演進過程，我們可以理解為一種逐步抽象和解耦的設計思想。這種思想在C#等面向對象的編 ...
  • Python中的私有屬性與私有方法
    關於Python中的私有屬性和私有方法 Python對於類的成員沒有嚴格的訪問控制限制，這與其他面相對對象語言有區別。關於私有屬性和私有方法，有如下要點： 1、通常我們約定，兩個下劃線開頭的屬性是私有的（private）。其他為公共的（public）； 2、類內部可以訪問私有屬性（方法）； 3、類外 ...
  • C++ 訪問說明符詳解：封裝數據，控制訪問，提升安全性
    C++ 訪問說明符 訪問說明符是 C++ 中控制類成員（屬性和方法）可訪問性的關鍵字。它們用於封裝類數據並保護其免受意外修改或濫用。 三種訪問說明符： public：允許從類外部的任何地方訪問成員。 private：僅允許在類內部訪問成員。 protected：允許在類內部及其派生類中訪問成員。 示 ...
  • static_cast與dynamic_cast到底是什麼？
    寫這個隨筆說一下C++的static_cast和dynamic_cast用在子類與父類的指針轉換時的一些事宜。首先，【static_cast，dynamic_cast】【父類指針，子類指針】，兩兩一組，共有4種組合：用 static_cast 父類轉子類、用 static_cast 子類轉父類、使用 ...
  • C語言數據結構：雙向鏈表的增刪操作
    /******************************************************************************************************** * * * 設計雙向鏈表的介面 * * * * Copyright (c) 2023-2 ...
  • @ComponentScan註解的實現，Spring掃描包的過程
    相信接觸過spring做開發的小伙伴們一定使用過@ComponentScan註解 @ComponentScan("com.wangm.lifecycle") public class AppConfig { } @ComponentScan指定basePackage，將包下的類按照一定規則註冊成Be ...
  • opensips開啟python支持
    操作系統 ：CentOS 7.6_x64 opensips版本： 2.4.9 python版本：2.7.5 python作為腳本語言，使用起來很方便，查了下opensips的文檔，支持使用python腳本寫邏輯代碼。今天整理下CentOS7環境下opensips2.4.9的python模塊筆記及使用 ...
所有分類