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里面给我们缓存的数据流进行协议解析。

  1. readBuffer: 接收缓冲区, 接收到的数据存放在此数组里

  2. offset: 接收到的数据在接收缓冲区的起始位置

  3. length: 本轮接收到的数据的长度

  4. toBeCopied: 表示当你想缓存接收到的数据时,是否需要为接收到的数据重新创建一个备份而不是直接使用接收缓冲区

  5. 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
这里的数据解析的实现与服务器的实现有点不同,不过下一个版本可能会统一,如果统一起来的话,那么以后数据解析就可以做成和插件一样,同时可以给服务器和客户端使用。

  1. data:也是数据缓存区

  2. 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跨平台或扫描二维码关注


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/329218.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java 注解指导手册 – 终极向导

转载自 Java 注解指导手册 – 终极向导译文出处&#xff1a; Toien Liu 原文出处&#xff1a;Dani Buiza编者的话&#xff1a;注解是java的一个主要特性且每个java开发者都应该知道如何使用它。我们已经在Java Code Geeks提供了丰富的教程, 如Creating Your Own Java Annota…

ajax调用后台java类_ajax调用java后台方法是什么

ajax是一种基于 JavaScript和HTTP请求(HTTP requests)&#xff0c;广泛应用在浏览器的网页开发技术。那么&#xff0c;ajax调用java后台方法是什么?var http_requestfalse;function sendRequest(method,url,content,processResponse){http_requestfalse;if(window.XMLHttpRequ…

用 Visual Studio 发布一个 Azure 云 Web 应用程序

原文&#xff1a;Getting Started 作者&#xff1a;Rick Anderson 翻译&#xff1a;谢炀(Kiler) 校对&#xff1a;孟帅洋(书缘)、刘怡(AlexLEWIS)、何镇汐 设置开发环境 安装最新版本的 Azure SDK for Visual Studio 2015。如果你之前没有装过 Visual Studio 2015&#xff0c;S…

Java中的注解是如何工作的

转载自 Java中的注解是如何工作的&#xff1f;自Java5.0版本引入注解之后&#xff0c;它就成为了Java平台中非常重要的一部分。开发过程中&#xff0c;我们也时常在应用代码中会看到诸如Override&#xff0c;Deprecated这样的注解。这篇文章中&#xff0c;我将向大家讲述到底什…

impdp导入mysql_Oracle数据库的impdp导入操作以及dba_directories使用方法

Oracle数据库的impdp导入操作以及dba_directories使用方法今天从同事那里拿到了导出的dmp文件&#xff0c;当导入时发现了很多问题&#xff0c;记下来以免以后忘记&#xff0c;以下是本人的操作过程&#xff1a;1.首先是创建一个文件夹dump&#xff0c;用来存放dmp文件&#xf…

ASP.NET Core MVC 与 Visual Studio 入门

原文&#xff1a;Getting started with ASP.NET Core MVC and Visual Studio作者&#xff1a;Rick Anderson翻译&#xff1a;娄宇(Lyrics)校对&#xff1a;刘怡(AlexLEWIS)、夏申斌 、张硕(Apple) 这篇教程将告诉你如何使用 Visual Studio 2015 构建一个 ASP.NET Core MVC Web …

深入理解Java:注解(Annotation)自定义注解入门

转载自 深入理解Java&#xff1a;注解&#xff08;Annotation&#xff09;自定义注解入门要深入学习注解&#xff0c;我们就必须能定义自己的注解&#xff0c;并使用注解&#xff0c;在定义自己的注解之前&#xff0c;我们就必须要了解Java为我们提供的元注解和相关定义注解的语…

java快排原理_Java数据结构与算法——快速排序

声明&#xff1a;码字不易&#xff0c;转载请注明出处&#xff0c;欢迎文章下方讨论交流。前言&#xff1a;Java数据结构与算法专题会不定时更新&#xff0c;欢迎各位读者监督。本篇文章介绍排序算法中最常用也是面试中最容易考到的排序算法——快排&#xff0c;包括快排的思想…

厚积薄发,拥抱 .NET 2016

厚积薄发这个词是高三英语老师在高考前写在黑板上&#xff0c;高中三年努力这么久&#xff0c;是时候迎面而上&#xff0c;冲刺向前。所以&#xff0c;一想到.NET 2016&#xff0c;脑海里蹦出的第一个词就是它。 .NET 2016 是 .NET 一次质的飞跃&#xff0c;不管难易&#xff0…

CGLIB 实现代理对象API

转载自 CGLIB 实现代理对象API1. 加入库cglib库cglib-2.2.jarasm库(cglib 需要asm库,如果没有加入asm的jar文件,就会报asm错误)asm-3.1.jar 2. 定义CGLIB操作类package com.machome.cglibtest;import java.lang.reflect.Method;import com.machome.model.StuService;import net…

android java split_Java中的split函数的用法

Java中的 split 函数是用于按指定字符(串)或正则去分割某个字符串&#xff0c;结果以字符串数组形式返回&#xff1b;例如:String str"1234abc";String[] a str.split("");System.out.println("处理结果: "a[0]","a[1]); //输出的…

第二章指南(4.2)添加 Controller

原文&#xff1a;Adding a controller翻译&#xff1a;娄宇(Lyrics)校对&#xff1a;刘怡(AlexLEWIS)、何镇汐、夏申斌、孟帅洋(书缘) Model-View-Controller (MVC) 架构模式将一个应用程序分离成三个主要的组件&#xff1a; Model、View 以及Controller 。 MVC 模式帮助你创建…

jdk和cglib简单理解

转载自 jdk和cglib简单理解之前使用cglib的时候不需要将classLoader作为参数传入&#xff0c;但动态代理却要&#xff0c;带着这个疑惑进入这个方法&#xff1a;Proxy.newProxyInstance(classLoader, interfaces, InvocationHandler)要在classLoader里去找interfaces&#xff0…

mysql引擎总结_MySQL存储引擎对比总结

存储引擎是数据库的核心&#xff0c;对于mysql来说&#xff0c;存储引擎是以插件的形式运行的。虽然mysql支持种类繁多的存储引擎&#xff0c;但是常用的就那么几种。这篇文章主要是对其进行一个总结和对比。一、引言在mysql5之后&#xff0c;支持的存储引擎有十几个&#xff0…

DotNet Core 介绍

前言 asp.net core rtm 6月底即将发布&#xff0c;自己也想着为社区做点共享&#xff0c;刚好最近不太忙&#xff0c;看到社区的小伙伴们都在为dotnet core的推广而贡献力量&#xff0c;项目中刚好在用rc2版本&#xff0c;就多写些文章来帮助那些还在学习的朋友们吧。 目录 dot…

jdbc java_Java中使用JDBC

JDBC简介JDBC(Java Data Base Connectivity,java数据库连接)是一种用于执行SQL语句的Java API&#xff0c;可以为多种关系数据库提供统一访问&#xff0c;它由一组用Java语言编写的类和接口组成。本文中中使用的数据库数据库软件&#xff1a;MySQL5.6数据库&#xff1a;test表&…

动态代理proxy与CGLib的区别

转载自 动态代理proxy与CGLib的区别昨天被人问及动态代理与CGlib的区别&#xff0c;赶紧回顾一下&#xff1a; 什么是代理&#xff1f;静态代理与动态代理静态代理实例JDK动态代理实例CGLib 简介CGLib 与JDK动态代理的区别代理模式是Java中常见的一种模式&#xff0c;英文名字叫…

【干货】”首个“ .NET Core 验证码组件

前言 众所周知&#xff0c;Dotnet Core目前没有图形API&#xff0c;以前的System.Drawing程序集并没有包含在Dotnet Core 1.0环境中。不过在dotnet core labs项目里可以见到MS已经在移植这个项目&#xff0c;不过目前的版本只能在Windows上和NET541或DNX环境中才可以使用。 不过…

java 招聘要求_Java程序员如何进阶,一般招聘都有哪些要求?

作为当前市场上应用领域最广、人才需求最大的编程语言&#xff0c;Java一直是人们入行IT行业的选择。然而&#xff0c;随着大批量的人涌入Java开发行业&#xff0c;企业的招聘门槛也在无形中抬高&#xff0c;提升专业技能成为新手Java程序员实现升职加薪的有效途径。分析各大招…

朝花夕拾——Java的synthetic修饰词

转载自 朝花夕拾——Java的synthetic修饰词Ok&#xff0c;目前为止&#xff0c;我还只是Android coder&#xff0c;一切对其他的学习都是以Android 为主线的支线任务。所以为什么会提到这个方法呢&#xff1f;是来自于google官方的性能建议文档的这样一句话&#xff1a;Consid…