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


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

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

相关文章

android sharedpreferences工具类

package com.xt.deeptest5g.Utils;import android.content.Context; import android.content.SharedPreferences;/*** author : ZJS* e-mail : * date : 20-7-30下午7:46* desc : 用户账户信息保存工具类* version : 1.0*/ public class SharedPreferencesUtils {/*** 保存…

学习心得——刘文瑞

19级青鸟3班 刘文瑞以前因为经常玩游戏的原因&#xff0c;导致我对软件特别感兴趣&#xff0c;但是由于学习到的东西不多&#xff0c;经常是在玩游戏&#xff0c;真正能运用到计算机上的知识实在是少的可伶。像是代码之类的东西&#xff0c;以前只是听说过&#xff0c;但是一点…

教你如何定位及优化SQL语句的性能问题

转载自 教你如何定位及优化SQL语句的性能问题 在现如今的软件开发中&#xff0c;关系型数据库是做数据存储最重要的工具。无论是Oracale还是Mysql&#xff0c;都是需要通过SQL语句来和数据库进行交互的&#xff0c;这种交互我们通常称之为CRUD。在CRUD操作中&#xff0c;最最…

JS中的(IIFE)(立即调用函数)

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>06_IIEF</title> </head> <body> <!-- 1. 理解* 全称: Immediately-Invoked Function Expression 立即调用函数表达式* 别名: 匿…

SQL Server on Ubuntu——Ubuntu上的SQL Server(全截图)

本文从零开始一步一步介绍如何在Ubuntu上搭建SQL Server 2017&#xff0c;包括安装系统、安装SQL等相关步骤和方法&#xff08;仅供测试学习之用&#xff0c;基础篇&#xff09;。 一&#xff0e; 创建Ubuntu系统&#xff08;Create Ubuntu System&#xff09; 1. 前提准…

dp与px相互转换

package com.xt.deeptest5g.Utils;import android.content.res.Resources;/*** author : ZJS* e-mail : 15574564770163.com* date : 20-7-30下午9:02* desc : dp与px相互转换* version : 1.0*/ public class DensityUtil {public float density;public DensityUtil() {den…

学习心得——袁康凯

19级青鸟3班 袁康凯时光荏苒&#xff0c;不知不觉来济南信息工程学校已经二个多月&#xff0c;失去的很多&#xff0c;但收获的更多。失去很多以前嗤之以鼻却又丢弃不掉的坏毛病&#xff0c;认识了很多新同学新老师&#xff0c;学习了很多新知识。环境的巨大变化让我不断地改变…

面试必考的网络协议相关题目应该如何回答

转载自 面试必考的网络协议相关题目应该如何回答 最近&#xff0c;正处于校招季。很多小伙伴已经拿到了如愿以偿的Offer&#xff0c;有些小伙伴还在努力着。 平常&#xff0c;也会有一些粉丝会在公众号留言&#xff0c;或者在微信上问我一些面试题。其中有一类问题是除了Jav…

使用CSharp编写Google Protobuf插件

什么是 Google Protocol Buffer&#xff1f; Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准&#xff0c;目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。 Protocol Bu…

JS中关于能不能加分号

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>01_分号问题</title> </head> <body><!-- 1. js一条语句的后面可以不加分号 2. 是否加分号是编码风格问题, 没有应该不应该&…

浅析onWindowsFocusChanged()方法

浅析onWindowsFocusChanged()方法

jsp使用cookie实现记住用户名和密码

首先说一下实现的功能&#xff1a; 用户打开注册页面&#xff0c;最下面有个记住用户名和密码的复选框&#xff0c;如果勾选上&#xff0c;则在登录页面会自动将用户名和密码赋值到文本框中&#xff0c;使用java中的cookie实现&#xff0c;下面就是代码&#xff1a; 注册页面代…

集群、分布式、负载均衡区别

转载自 集群、分布式、负载均衡区别 参考&#xff1a;http://virtualadc.blog.51cto.com/3027116/615836” 集群 集群的概念 计算机集群通过一组松散集成的计算机软件和/或硬件连接起来高度紧密地协作完成计算工作。在某种意义上&#xff0c;他们可以被看作是一台计算机。集…

万圣节之夜

万 圣 节 昨天两位班主任就说今天班级有活动&#xff0c;从今天下午就开始了。18级下午都在布置教室&#xff0c;19级暂时没有行动。午休醒来之后&#xff0c;一脸高兴的去3班上课去。一进教室&#xff0c;同学们都在趴着睡觉呢。有点安静的不习惯了都。其中有个前排的女同学脸…

Visual Studio的未来特性展望

今天&#xff08;5月12日&#xff0c;西雅图&#xff09;的Build大会上&#xff0c;Microsoft的Amanda Silver和Tim Sneath针对Visual Studio 2017未来将会提供的特性做了演讲。Microsoft所聚焦的一个领域是改进IDE对所有用户的无障碍访问&#xff0c;包括视力障碍者。 事实上…

JS中函数的prototype属性和对象的__proto__属性

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>02_显式原型与隐式原型</title> </head> <body> <!-- 1. 每个函数function都有一个prototype&#xff0c;即显式原型 2. 每个实例…

EL表达式和Jstl常见的用法

一、使用EL表达式获取集合中的数据&#xff1a; <%Map names new HashMap();names.put("one", "1");names.put("two", "2");request.setAttribute("names", names);int a 2;request.setAttribute("a", a);Us…

线上防雪崩利器——熔断器设计原理与实现

转载自 线上防雪崩利器——熔断器设计原理与实现 本文来自作者投稿&#xff0c;作者林湾村龙猫&#xff0c;这是一篇他根据工作中遇到的问题总结出的最佳实践。 上周六&#xff0c;我负责的业务在凌晨00-04点的支付全部失败了。 结果一查&#xff0c;MD&#xff0c;晚上银行…

手持ActivityLifecycleCallbacks,监听前后台状态如此舒服

手持ActivityLifecycleCallbacks&#xff0c;监听前后台状态如此舒服

ASP.NET Core 菜鸟之路:从Startup.cs说起

1.前言 本文主要是以Visual Studio 2017 默认的 WebApi 模板作为基架&#xff0c;基于Asp .Net Core 1.0&#xff0c;本文面向的是初学者&#xff0c;如果你有 ASP.NET Core 相关实践经验&#xff0c;欢迎在评论区补充。与早期版本的 ASP.NET 对比&#xff0c;最显著的变化之一…