基于DotNet Core的RPC框架(一) DotBPE.RPC快速开始
0x00 简介
DotBPE.RPC是一款基于dotnet core编写的RPC框架,而它的爸爸DotBPE,目标是实现一个开箱即用的微服务框架,但是它还差点意思,还仅仅在构思和尝试的阶段。但不管怎么说RPC是微服务的基础,先来讲讲RPC的实现吧。DotBPE.RPC底层通信默认实现基于DotNetty,这是由微软Azure团队开发的C#的Netty实现,非常酷。当然你也可以替换成其他Socket通信组件。DotBPE.RPC使用的默认协议名称叫Amp,编解码使用谷歌的Protobuf3,不过这些默认实现都是可以替换的。
源码地址:https://github.com/xuanye/dotbpe.git
0x01 关于Amp协议和Google Protobuf
Amp(A Message Protocol)
Amp(A Message Protocol) ,中文名叫 一个消息协议
,是DotBPE.RPC默认实现的消息协议,在实际开发中,其实是不需要了解消息是如何编解码和传输的,但是了解协议有助于进一步了解框架。协议基本结构如下图所示:
0 1 2 3 4 5 6 7 8 9 10 11 12 13 <length>-14
+------------+----------+---------+------+-------+---------+------------+
| <ver/argc> | <length> | <seq> |<type>|<serId>| <msgid> | <data> |
+------------+----------+---------+------+-------+---------+------------+
Amp协议默认消息头长为14个字节,不包含扩展包头
第0位:ver/argc // 为版本号,暂时来说,默认为0
第1-4位: length //为包总长度(含包头长度)
第5-8位: sequence // 为消息序列号,通过该序列号对应 请求<--->响应
第9位: type // 消息类型,现值有5种,如下:
Request = 1, Response = 2, Notify = 3,NotFound = 4, ERROR = 5
第10-11位: serviceId//消息ID ushort类型
第12-13位: msgId//消息ID ushort类型
在Amp协议中,serviceId标识一类请求,类似应用中的模块,而msgId标识模块中的具体方法
其后紧跟实际的数据
Google Protobuf
Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准,目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。
Protocol Buffers 是一种轻便高效的结构化数据存储格式,可以用于结构化数据串行化,或者说序列化。它很适合做数据存储或 RPC 数据交换格式。可用于通讯协议、数据存储等领域的语言无关、平台无关、可扩展的序列化结构数据格式。目前提供了 多种语言的API,包括C++、 C# 、GO、 JAVA、 PYTHON
我在之前的博客使用CSharp编写Google Protobuf插件中有过介绍如果通过编写插件的方式,来通过定义proto文件,并生成我们需要的代码。
在DotBPE.RPC 中,我使用protobuf来作为服务的描述文件,并通过自定义的插件方式来生成服务端和客户端代理类。
0x02 快速开始
0. 前提
因为DotBPE是基于dotnet core开发的,你本地必须已经有了dotnet core开发环境
使用github托管代码,所以你必须已经安装了git客户端
需要通过protoc生成模板代码,所以你必须已经安装了google protobuf命令行工具
1. 下载示例程序
为了能够解释我们的快速开始程序,你需要一份本地能够运行的示例代码。从github上下载我已经写好的示例代码,可以让你快速的搭建程序,免去一些繁琐,但是又必须的步骤。
>$ # Clone the repository to get the example code: >$ git clone https://github.com/xuanye/dotbpe-sample.git
>$ cd dotbpe-sample
使用VS2017,或者VSCode打开下载好的代码,目录结构如下所示:
frameborder="0" scrolling="no" style="border-width: medium; width: 428px; height: 490px;">
如果你使用VS2017 可以自动帮你还原,如果使用VSCode的话 ,需要运行dotnet restore
下载依赖,成功后使用dotnet build
编译一下看看结果:看着很完美
frameborder="0" scrolling="no" style="border-width: medium; width: 960px; height: 304px;">
2. 运行程序
运行Server
>$ cd HelloDotBPE.Server >$ dotnet run
运行Client
>$ cd HelloDotBPE.Client >$ dotnet run
恭喜!已经使用DotBPE.RPC运行一个Server/Client的应用程序。
3. 来一起看一下代码吧
3.1 服务描述文件proto
首先是DotBPE.RPC框架中对proto的扩展文件,所有的项目都需要这个文件,关于如何扩展proto,我的这篇博客有比较详细的介绍,这里就不重复说了
//dotbpe_option.proto 文件syntax = "proto3";package dotbpe;option csharp_namespace = "DotBPE.ProtoBuf";import "google/protobuf/descriptor.proto";//扩展服务extend google.protobuf.ServiceOptions { int32 service_id = 51001; bool disable_generic_service_client = 51003; //禁止生成客户端代码bool disable_generic_service_server = 51004; //禁止生成服务端代码}
extend google.protobuf.MethodOptions { int32 message_id = 51002;
}extend google.protobuf.FileOptions { bool disable_generic_services_client = 51003; //禁止生成客户端代码bool disable_generic_services_server = 51004; //禁止生成服务端代码bool generic_markdown_doc = 51005; //是否生成文档 本示例中无用bool generic_objectfactory = 51006; //是否生成objectfactory 本示例中无用}
下面的服务描述文件 greeter.proto
才是真正的示例的服务描述文件:比较简单,定义一个Greeter Rpc服务,并定义一个Hello的方法
//greeter.protosyntax = "proto3";
package dotbpe;option csharp_namespace = "HelloDotBPE.Common";// 引入扩展import public "dotbpe_option.proto";// 定义一个服务service Greeter {option (service_id)= 100 ;//消息ID,全局必须唯一// Sends a greetingrpc Hello (HelloRequest) returns (HelloResponse) {option (message_id)= 1 ;//设定消息ID,同一服务内唯一}}// The request message containing the user's name.message HelloRequest { string name = 1;
}// The response message containing the greetingsmessage HelloResponse { string message = 1;
}
通过protoc工具生成模板代码,示例中的代码生成到了 HelloDotBPE.Common_g 目录下,本地可以运行shell命令的同学可以直接到
dotbpe-sample\script\generate 目录运行sh generate_hello.sh
(windows下一般安装cgywin),不能运行的同学也可以在HelloDotBPE目录下,直接运行命令行
protoc -I=../protos --csharp_out=./HelloDotBPE.Common/_g/ --dotbpe_out=./HelloDotBPE.Common/_g/ ../protos/dotbpe_option.proto ../protos/greeter.proto --plugin=protoc-gen-dotbpe=../../tool/protoc_plugin/Protobuf.Gen.exe
当然我还是建议大家安装以下cgywin运行环境,可以运行unix上的一些常用命令。同时在部署到正式环境的时候可以公用开发环境的一些脚本。
3.2 服务端代码
服务实现:
// 服务实现代码public class GreeterImpl : GreeterBase { public override Task<HelloResponse> HelloAsync(HelloRequest request) { // 直接返回Hello Namereturn Task.FromResult(new HelloResponse() { Message = "Hello " + request.Name });}
}
服务端启动类
public class Startup : IStartup{ public void Configure(IAppBuilder app, IHostingEnvironment env) {} public IServiceProvider ConfigureServices(IServiceCollection services) {services.AddDotBPE(); // 添加DotBPE.RPC的核心依赖services.AddServiceActors<AmpMessage>(actors => {actors.Add<GreeterImpl>(); // 注册服务实现}); return services.BuildServiceProvider();}}
启动服务端
class Program{ static void Main(string[] args) {Console.OutputEncoding = System.Text.Encoding.UTF8; //在控制台输出调试日志DotBPE.Rpc.Environment.SetLogger(new DotBPE.Rpc.Logging.ConsoleLogger()); var host = new RpcHostBuilder().UseServer("0.0.0.0:6201") //绑定本地端口6201.UseStartup<Startup>().Build();host.StartAsync().Wait();Console.WriteLine("Press any key to quit!");Console.ReadKey();host.ShutdownAsync().Wait();}}
3.3 客户端代码
class Program{ static void Main(string[] args) {Console.OutputEncoding = Encoding.UTF8; var client = AmpClient.Create("127.0.0.1:6201"); //建立链接通道var greeter = new GreeterClient(client); //客户端代理类while (true){Console.WriteLine("input your name and press enter:"); string name = Console.ReadLine(); if ("bye".Equals(name)){ break;} try{ var request = new HelloRequest() { Name = name }; var result = greeter.HelloAsync(request).Result; Console.WriteLine($"---------------receive form server:{result.Message}-----------");} catch (Exception ex){Console.WriteLine("发生错误:" + ex.Message);}}Console.WriteLine($"---------------close connection-----------");client.CloseAsync();}}
0x03 下一步
下一篇 我将详细讲述DotBPE.RPC中的主要类和调用关系,并介绍如何使用DotNetty实现RPC通信。
事实上我正在编写一个更加复杂的示例https://github.com/xuanye/PiggyMetrics.git,
这原是spring cloud的一个示例程序,我使用DotBPE进行改造,用示例描述DotBPE在真实场景中的应用。包括服务注册和发现,服务间调用,公开HttpApi,监控检查等功能,并通过实践进一步完善DotBPE。初步的功能已经实现,不过还没来的及写文档。该系列的后面将详细描述该系统的实现。
原文地址:http://www.cnblogs.com/xuanye/p/a-dotnet-core-rpc-sln-dotbpe-quickstart.html
.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注
基于DotNet Core的RPC框架(一) DotBPE.RPC快速开始相关推荐
- 基于.NET CORE微服务框架 -谈谈surging API网关
1.前言 对于最近surging更新的API 网关大家也有所关注,也收到了不少反馈提出是否能介绍下Api网关,那么我们将在此篇文章中谈谈surging Api 网关 开源地址:https://gith ...
- 基于.NET CORE微服务框架 -谈谈Cache中间件和缓存降级
1.前言 surging受到不少.net同学的青睐,也提了不少问题,提的最多的是什么时候集成API 网关,在这里回答大家最近已经开始着手研发,应该在1,2个月内会有个初版API网关,其它像Token身 ...
- 基于.NET CORE微服务框架 -谈谈surging的服务容错降级
一.前言 对于不久开源的surging受到不少.net同学的青睐,也受到.net core学习小组的关注,邀请加入.NET China Foundation 以方便国内.net core开源项目的推广 ...
- Dotnet Core应用跨框架版本运行
有时候,我们真想用新框架,可也真不想改代码. 有一个前置的知识需要了解,就是微软 Dotnet Core 框架的版本体系.我前边的文章「Dotnet Core使用特定的SDK&Runtim ...
- 基于.NET CORE微服务框架 -浅析如何使用surging
1.前言 surging受到大家这么强烈的关注,我感到非常意外,比如有同僚在公司的分享会上分享surging, 还有在博客拿其它的RPC框架,微服务做对比等等,这些举动都让我感觉压力很大,毕竟作为个人 ...
- python rpc框架-python使用rpc框架gRPC的方法
概述 gRPC 是谷歌开源的一个rpc(远程程序调用)框架,可以轻松实现跨语言,跨平台编程,其采用gRPC协议(基于HTTP2). rpc: remote procedure call, 翻译过来就是 ...
- RPC框架面试总结-RPC原理及实现
一.什么是RPC RPC是远程调用过程的简写,是一个协议,处于网络通信协议的第五层:会话层,其下就是TCP/IP协议,在建立在其基础上的通信会话协议.RPC定义了交互的模式,而应用程序使用这些模式,来 ...
- java 分布式rpc框架_分布式RPC框架Apache Dubbo(一)
4 Dubbo快速入门 Dubbo作为一个RPC框架,其最核心的功能就是要实现跨网络的远程调用.本小节就是要创建两个应用,一个作为服务的提供方,一个作为服务的消费方.通过Dubbo来实现服务消费方远程 ...
- 基于DOTNET的活动记录框架
写过一段时间的DOTNET程序和ROR程序后,受ROR的ActiveRecord框架启发,故此写了DOTNET版本的活动记录框架.具有CRUD.事务.验证器.支持多数据库连接. 先介绍简单的CRUD操 ...
最新文章
- facebook 直播_什么时候是在Facebook Live上直播的最佳时间? 我分析了5,000个Facebook帖子以找出答案。...
- iscsi模型相关点
- leetcode 222. 完全二叉树的节点个数(dfs)
- C# DateTime简单的定时器用法
- 【Python】TensorBoard已发送内容的清除
- 商家为什么要接受BCH支付?
- [python]json.loads 几种错误 解决方案
- 知识点汇总【一】操作系统三十八问
- OpenLayers 绘制,选中,鼠标悬浮
- 在xp中运行 .air 文件--Adobe AIR Runtime for Window
- 思科模拟器Cisco Packet Tracer的下载与安装
- Java的图标和由来
- ROG 570-E 主板问题:主板发出1长2短的滴滴声,黄灯常亮
- python快速排名seo代码_seo评价机制图(python快速排名seo)
- 程序员拒绝春节带电脑回家被开除;小米国行不再支持安装Google框架;Excel具备图灵完备性,成第一大编程语言 | 架构视点...
- 我的/etc/motd 卡哇伊内~
- fcpx如何清除缓存?Final Cut Pro X 清除缓存方法
- python语言编程-Python成为2018年度编程语言,遥遥领先于其他语言
- 基于OP放大器的有源模拟滤波器设计--基础知识
- 第十五周翻译 ——配置和概况
热门文章
- ElasticSearch——学习笔记
- 面向对象编程设计模式--简单工厂模式讲解(历史上最简单明白的例子)
- ASP.NET Core中使用令牌桶限流
- 池化对象 RecyclableMemoryStream 在 .netcore 中的使用
- EFCore查缺补漏(二):查询
- AgileConfig - RESTful API 介绍
- 如何在 .Net Core 中使用 IHostedService
- C# 9 新特性 —— 增强的 foreach
- 心想技术驱动业务,却在背道而驰
- 谁说.NET不适合搞大数据、机器学习和人工智能