當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

SuperSocket与Netty之实现protobuf协议，包括服务端和客户端

發布時間：2023/12/4 编程问答 30 豆豆

生活随笔收集整理的這篇文章主要介紹了 SuperSocket与Netty之实现protobuf协议，包括服务端和客户端小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

今天準備給大家介紹一個c#服務器框架（SuperSocket）和一個c#客戶端框架（SuperSocket.ClientEngine）。這兩個框架的作者是園區里面的江大漁。首先感謝他的無私開源貢獻。之所以要寫這個文章是因為群里經常有人問這個客戶端框架要如何使用。原因在于服務端框架的文檔比較多，客戶端的文檔比較少，所以很多c#基礎比較差的人就不懂怎么玩起來。今天就這里寫一個例子希望能給部分人拋磚引玉吧。

參考資料：

SuperSocket文檔 http://docs.supersocket.net/

我以前在開源中國的一部分文章：http://my.oschina.net/caipeiyu/blog

這篇文章選擇 protobuf 來實現,選擇protobuf是因為服務器有可能用的是java的netty，客戶端想用SuperSocket.ClientEngine，而netty我看很多人經常用protobuf。

一、SuperSocket服務器

新建一個項目 ProtobufServer 然后添加 SuperSocket 和 protobuf 的依賴包。

添加protobuf依賴包輸入的搜索詞是 Google.ProtocolBuffers
添加SuperSocket依賴包輸入搜索詞是 SuperSocket，要添加兩個SuperSocket.Engine 和 SuperSocket

上面的工作完成后，我們就應該來實現我們的傳輸協議了。傳輸協議打算參考netty的ProtobufVarint32FrameDecoder.java

* BEFORE DECODE (302 bytes) ? ? ? AFTER DECODE (300 bytes)* +--------+---------------+ ? ? ?+---------------+* | Length | Protobuf Data |----->| Protobuf Data |* | 0xAC02 | ?(300 bytes) ?| ? ? ?| ?(300 bytes) ?|* +--------+---------------+ ? ? ?+---------------+

Protobuf Data是protobuf的序列化結果。Length（Base 128 Varints）是表示Protobuf Data的長度。protobuf本身的序列號協議可以參考：https://developers.google.com/protocol-buffers/docs/encoding

我們先看一下SuperSocket的內置的常用協議實現模版看看有沒有合適我們可以直接拿來用的。因為Length使用的是Base 128 Varints一種處理整數的變長二進制編碼算法，所以呢內置的協議實現模板并不能直接拿來使用，所以我們只能自己來實現接口IRequestInfo和IReceiveFilter了，參考：使用 IRequestInfo 和 IReceiveFilter 等等其他對象來實現自定義協議。

這里說明一下：為什么protobuf明明序列化成Protobuf Data 了為什么還要再加一個Length來打包，因為tcp這個流發送會參數粘包、分包，如果不加個協議來解析會讀取錯誤的數據而導致無法反序列化 Protobuf Data （自行谷歌 tcp 粘包、分包）

ProtobufRequestInfo的實現

在實現ProtobufRequestInfo之前要先來考慮一個問題，那就是我們的傳輸協議是長度+protobuf數據，那么我們根本就無法知道獲取到的protobuf數據該如何反序列化。在官方網站提供了一種解決思路：https://developers.google.com/protocol-buffers/docs/techniques#union
就是我們可以弄唯一個數據包，然后這個數據包里面必須包含一個枚舉值，然后還包含了其他類型的數據包，每一個枚舉值對應一個數據包，然后傳送過來后，可以用分支判斷來獲取值。

那我們先設計一個 DefeatMessage.proto包含內容：

然后再把CallMessage和BackMessage補全

然后在我們的路徑packages\Google.ProtocolBuffers.2.4.1.555\tools里面有兩個工具protoc.exe 和 protogen.exe,我們可以執行下面的命令來生成我們的c#代碼

protoc --descriptor_set_out=DefeatMessage.protobin --proto_path=pack --include_imports pack\DefeatMessage.proto

protogen DefeatMessage.protobin

注意路徑要自己修改

如果有報Expected top-level statement (e.g. "message").這么一個錯誤，那就是你cmd的編碼和proto的編碼不一致，要改成一致。

相關文件：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/tree/master/ProtobufServer/Pack

生成完c#代碼后，我們就要設計ProtobufRequestInfo了。這個比較簡單，只要實現IRequestInfo接口。我們這里在實現接口帶的屬性外另加一個 DefeatMessage 和 DefeatMessage.Types.Type，其中DefeatMessage是為了存儲我們解包完數據后反序列化出來的對象，Type是為了方便區分我們應該取出DefeatMessage里面的哪個值。

ProtobufReceiveFilter的實現

代碼比較長，直接看在github上的代碼ProtobufReceiveFilter的實現
實現的注意點參考：使用 IRequestInfo 和 IReceiveFilter 等等其他對象來實現自定義協議。主要是對ss里面給我們緩存的數據流進行協議解析。

readBuffer: 接收緩沖區, 接收到的數據存放在此數組里

offset: 接收到的數據在接收緩沖區的起始位置

length: 本輪接收到的數據的長度

toBeCopied: 表示當你想緩存接收到的數據時，是否需要為接收到的數據重新創建一個備份而不是直接使用接收緩沖區

rest: 這是一個輸出參數, 它應該被設置為當解析到一個為政的請求后，接收緩沖區還剩余多少數據未被解析

ProtobufAppSession 的實現

ProtobufAppServer 的實現

服務器的實例啟動實現

參考：http://docs.supersocket.net/v1-6/zh-CN/A-Telnet-Example

代碼：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/blob/master/ProtobufServer/Program.cs

主要是接收到數據的一個方法實現，當然ss里面還帶了命令模式的實現，不過這個不在本文章里面說。這里的實現了接收到不同的數據給打印出來，然后接收到CallMessage數據的話就給客戶端回發一條信息

服務器的代碼就到這里，可以編譯運行起來看看有無錯誤。

二、SuperSocket.ClientEngine客戶端

與服務器實現相同，先通過NuGet添加 SuperSocket.ClientEngine 和 protobuf 的依賴包。
有三個實現：

ProtobufPackageInfo的實現

把前面實現服務器時候生成的通訊數據包拷貝過來，然后和實現服務器的ProtobufRequestInfo一樣，只不過這里只是實現接口IPackageInfo而已

ProtobufReceiveFilter的實現

代碼：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/blob/master/ProtobufClient/ProtobufReceiveFilter.cs
這里的數據解析的實現與服務器的實現有點不同，不過下一個版本可能會統一，如果統一起來的話，那么以后數據解析就可以做成和插件一樣，同時可以給服務器和客戶端使用。

data：也是數據緩存區

rest：緩存區還剩下多少

這個實現與服務器的不同就在BufferList本身就已經有處理分包，就不需要我們自己再做處理。

運行主程序實現

具體實現看：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/blob/master/ProtobufClient/Program.cs

這個真的沒有什么好說了。運行效果如下：

這里的打印信息��相對比較簡單，大家可以自己下載源碼來加些打印數據，讓看起來更好看點。

三、java的Netty實現

既然前面提到了Netty，那就順便實現一個簡單的服務器來通訊看看。
使用的是Netty 4.x 參考資料：http://netty.io/wiki/user-guide-for-4.x.html

Netty的實現在網絡上有超級多的例子，這里就簡單的介紹一下就可以，首先先生成java的通訊包代碼

protoc --proto_path=pack --java_out=./ pack/DefeatMessage.proto

protoc --proto_path=pack --java_out=./ pack/BackMessage.proto

protoc --proto_path=pack --java_out=./ pack/CallMessage.proto

這幾個命令要自己靈活改變們不要死死的硬搬。

生成的代碼：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/tree/master/java/NettyProtobufServer/src/main/java

然后創建一個maven項目,添加Netty 和 protobuf 依賴：https://github.com/kotcmm/SuperSocket.ClientEngine.QuickStart/blob/master/java/NettyProtobufServer/pom.xml

<dependencies> ? ? ? ?<dependency> ? ? ? ? ? ?<groupId>com.google.protobuf</groupId> ? ? ? ? ? ?<artifactId>protobuf-java</artifactId> ? ? ? ? ? ?<version>2.6.1</version> ? ? ? ?</dependency> ? ? ? ?<dependency> ? ? ? ? ? ?<groupId>io.netty</groupId> ? ? ? ? ? ?<artifactId>netty-microbench</artifactId> ? ? ? ? ? ?<version>4.1.0.Final</version> ? ? ? ?</dependency> ? ?</dependencies>

ProtobufServerHandler的實現

因為Netty里面已經有幫我們實現了protobuf的解析，所以我們不需要自己實現。我們只要繼承ChannelInboundHandlerAdapter然后通過channelRead就可以拿到解析好的對象，然后轉換成我們自己的類型，就可以直接使用。這里同樣是實現不同類型的消息打印和CallMessage消息就回復信息給客戶端。

ProtobufServer的實現

主要是添加已經有的編碼解碼和消息接收的類就可以了。

整個代碼編寫完成后，直接運行并打開我們前面的客戶端進通訊發數據。運行結果如下：

當然這三個例子直接簡單的說明如何使用框架來解決我們的問題，實際開發過程中肯定不只是我們例子的這么點東西，需要考慮的東西還很多，這里只是寫一些可以運行起來的例子作為拋磚引玉。希望能給不懂的同學有點啟發作用。謝謝您百忙中抽出時間來觀看我的分享。

SuperSocket, 可擴展的 Socket 服務器框架
開源項目SuperSocket的學習筆記
使用LogMaster4Net實現應用程序日志的集中管理

原文地址：http://www.cnblogs.com/caipeiyu/p/5559112.html

.NET社區新聞，深度好文，微信中搜索dotNET跨平臺或掃描二維碼關注

總結

以上是生活随笔為你收集整理的SuperSocket与Netty之实现protobuf协议，包括服务端和客户端的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：用 Visual Studio 和 AS
下一篇：用 Visual Studio 发布一个