主頁 > .NET開發 > C#開源類別庫SimpleTCP

C#開源類別庫SimpleTCP

2021-09-13 06:01:04 .NET開發

目錄
  • 簡介
  • 使用方法
    • 實作客戶端
    • 實作服務端
  • 總結

簡介

作業中經常遇到需要實作TCP客戶端或服務端的時候,如果每次都自己寫會很麻煩且無聊,使用SuperSocket庫又太大了,這時候就可以使用SimpleTCP了,當然僅限于C#語言,

SimpleTCP是一個簡單且非常有用的 .NET 庫,用于處理啟動和使用 TCP 套接字(客戶端和服務器)的重復性任務,使用起來非常方便、代碼也少,它的內部不是直接使用的Socket,而是在TcpClient的基礎上進行了再次封裝,介面更簡單、明了,

它的主要特點如下:

  • 原始碼簡單:原始碼就幾個類,每個類也不大,在了解TcpClient用法的基礎上不需要注釋就可以看懂,
  • 功能單一:不像其它庫一樣功能繁多,它只專注于實作簡單的TCP客戶端、服務端,使用起來不用擔心增加系統的復雜性,
  • 使用簡單:后面的示例會具體講解,啟動一個客戶端或服務端只需要幾行代碼,想擴展功能也很簡單,

說一下它的不足之處(在我看來完全可以接受):

  • 已停止更新:最后更新時間是2017年,不過庫的功能比較簡單、單一,也沒那么多更新的內容,
  • 性能不是最優的:底層是基于TcpClient的,性能注定不會太高,但能用TcpClient的地方都可以用它,

使用方法

在專案中直接參考SimpleTCP.dll即可, dll檔案可以通過NuGet安裝或從github下載原始碼編譯,
SimpleTCP內部有一個特殊字符分割字串的協議可以直接使用,也可以在DataReceived事件處理程式中實作自己的協議,

實作客戶端

實作一個客戶端的代碼如下:

//初始化
var client = new SimpleTcpClient();            

//設定編碼格式,默認是UTF8
client.StringEncoder = System.Text.ASCIIEncoding.ASCII;
//設定分隔符,默認是0x13
client.Delimiter = Encoding.ASCII.GetBytes("\r")[0];

//收到分割資料的事件,遇到分隔符就會觸發事件
client.DelimiterDataReceived += (sender, msg) => 
{
    Console.WriteLine("DelimiterStr-"+DateTime.Now.ToString()+ msg.MessageString);
};

//收到資料的事件,可以在這里實作自己的協議
client.DataReceived += (sender, msg) => 
{
    //位元組陣列
    Console.WriteLine("Data:"+BitConverter.ToString(msg.Data));
    //字串訊息
    Console.WriteLine("ReceivedStr:" + msg.MessageString);
};

DelimiterDataReceivedDataReceived內部使用了兩個不同的位元組鏈表,決議起來互不影響,這兩個事件的處理程式中盡量不要做耗時的操作,否則會影響后續的資料接收

SimpleTCP沒有心跳、重連功能,也沒找到反饋客戶端連接狀態的屬性(不建議使用內部TcpClient的連接狀態),我們可以直接擴展這些功能,代碼如下:

bool exit = false;
bool connected = false;
Task.Factory.StartNew(() => 
{
    while (!exit) 
    {
        try
        {
            if (connected)
            {
                //發送心跳
                client.Write("");
                Task.Delay(10000).Wait();
            }
            else
            {
                //斷線重連
                client.Connect("127.0.0.1", 4196);
                connected = true;
                Task.Delay(1000).Wait();
            }
        }
        catch (Exception)
        {
            connected = false;
            client.Disconnect();
        }
    }               
    
}, TaskCreationOptions.LongRunning);

把上面的代碼按順序復制到控制臺的Main函式中,然后加入下面的代碼就可以收發資料了:

while (true) 
{
    string strLine = Console.ReadLine();
    if (strLine == "esc") 
    {
        exit = true;
        client.Disconnect();
        return;
    }
    if (connected) 
    { 
        //獲取服務端回復的訊息,最多等待3秒,收到訊息時會提前回傳
        //也可以使用Write、WriteLine方法發送資料,WriteLine會自動在后面加上設定的分隔符
        var replyMsg = client.WriteLineAndGetReply(strLine, TimeSpan.FromSeconds(3));
        if (replyMsg != null) 
        {
            Console.WriteLine(replyMsg);
        }
    }
}

注:WriteLineAndGetReply內部使用的是DataReceived,不會自動去除分隔符

實作服務端

服務端功能比較簡單,把收到分割資料加工后回傳客戶端,代碼如下:

//初始化
var server = new SimpleTcpServer();
//設定編碼格式,默認是UTF8
server.StringEncoder = System.Text.ASCIIEncoding.ASCII;
server.Delimiter =  Encoding.ASCII.GetBytes("\r")[0];

//分割資料接收事件
server.DelimiterDataReceived += (sender, msg) => 
{
    Console.WriteLine(msg.TcpClient.Client.RemoteEndPoint.ToString()+":" + msg.MessageString);
    msg.ReplyLine("Reply-" + msg.MessageString);
};

//資料接收資料
server.DataReceived += (sender, msg) =>
{
    Console.WriteLine(msg.TcpClient.Client.RemoteEndPoint.ToString() + ":" + msg.MessageString);
};

//客戶端連接事件
server.ClientConnected += (sender, msg) => 
{
    Console.WriteLine("ClientConnected:" + msg.Client.RemoteEndPoint.ToString());
};

//客戶端斷開事件
server.ClientDisconnected += (sender, msg) =>
{
    Console.WriteLine("ClientDisconnected:" + msg.Client.RemoteEndPoint.ToString());
};

//開始監聽
server.Start(4196);
//監聽的IP
var listeningIps = server.GetListeningIPs();
//監聽的V4Ip
var listeningV4Ips = server.GetListeningIPs().Where(ip => ip.AddressFamily == System.Net.Sockets.AddressFamily.InterNetwork);



Task.Factory.StartNew(() =>
{
    while (true)
    {   
        //連接數監控
        int clientsConnected = server.ConnectedClientsCount;
        Console.WriteLine("當前連接的客戶端數:" + clientsConnected);
        Task.Delay(10000).Wait();
    }

}, TaskCreationOptions.LongRunning);            
Console.ReadLine();

//停止監聽
server.Stop();
Console.WriteLine("停止服務端!");
Console.ReadLine();

總結

上面的代碼主要為了展示庫的功能,實際使用時可能就幾行代碼,性能要求不高的專案都可以使用,

專案和庫的原始碼鏈接如下:

  • TcpTest 提取碼:wvj0
  • SimpleTCP-master.zip 提取碼:kycj(推薦在github上下載)

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/299548.html

標籤:.NET技术

上一篇:C#開源類別庫SimpleTCP

下一篇:記一次 .NET 某桌面奇俠游戲 非托管記憶體泄漏分析

標籤雲
其他(123570) Java(13369) Python(12731) C(7545) 區塊鏈(7372) JavaScript(7059) 基礎類(6313) AI(6244) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4120) MySQL(4012) Linux(3394) C語言(3288) C++語言(3117) Java相關(2746) 疑難問題(2699) 單片機工控(2479) Web開發(1951) 網絡通信(1793) 數據庫相關(1767) VB基礎類(1755) PHP(1727) 開發(1646) 系統維護與使用區(1617) .NETCore(1586) 基礎和管理(1579) JavaEE(1566) C++(1527) 專題技術討論區(1515) Windows客戶端使用(1484) HtmlCss(1466) ASP.NET(1428) Unity3D(1354) VCL組件開發及應用(1353) HTML(CSS)(1220) 其他技術討論專區(1200) WindowsServer(1192) .NET技术(1165) 交換及路由技術(1149) 語言基礎算法系統設計(1133) WindowsSDKAPI(1124) 界面(1088) JavaSE(1075) Qt(1074) VBA(1048) 新手樂園(1016) 其他開發語言(947) Go(907) HTML5(901) 新技術前沿(898) 硬件設計(872) 區塊鏈技術(860) 網絡編程(857) 非技術版(846) 一般軟件使用(839) 網絡協議與配置(835) Eclipse(790) Spark(750) 下載資源懸賞專區(743)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布