DotBPE.RPC クイック スタート

0x00 はじめに

DotBPE.RPC は、dotnet core に基づいて書かれた RPC フレームワーク であり、その父である DotBPE は、それを達成することを目指しています。はすぐに使用できるマイクロサービス フレームワークですが、まだ構想と試用の段階にありますが、いずれにしても、RPC はマイクロサービスの基礎となる DotBPE.RPC の実装に基づいています。 Microsoft Azure チームによって開発された C# の Netty 実装である DotNetty もちろん、DotBPE.RPC で使用されるデフォルトのプロトコル名は Amp であり、コーデックは Google の Protobuf3 を使用します。 . ですが、これらのデフォルトの実装は置き換えることができます。

ソースコードアドレス: github.com/xuanye/dotbpe.git

0x01 Amp プロトコルと Google Protobuf について

Amp(A Message Protocol)

Amp(A Message Protocol) )、中国語名は メッセージ プロトコル です。これは、DotBPE.RPC によって実装されるデフォルトのメッセージ プロトコルです。実際の開発では、メッセージがどのようにエンコード、デコード、送信されるかを理解する必要はありません。プロトコルはフレームワークをさらに理解するのに役立ちます。 プロトコルの基本構造は以下のとおりです: 一个消息协议 ,是DotBPE.RPC默认实现的消息协议，在实际开发中，其实是不需要了解消息是如何编解码和传输的，但是了解协议有助于进一步了解框架。协议基本结构如下图所示:

      0        1 2 3 4   5 6 7 8     9     10 11     12 13   <length>-14
+------------+----------+---------+------+-------+---------+------------+
| <ver> | <length> |  <seq>  |<type>|<serid>| <msgid> |   <data>   |
+------------+----------+---------+------+-------+---------+------------+</data></msgid></serid></type></seq></length></ver></length>

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打开下载好的代码，目录结构如下所示：

如果你使用VS2017 可以自动帮你还原，如果使用VSCode的话 ，需要运行dotnet restore 下载依赖，成功后使用dotnet build

>$ cd HelloDotBPE.Server   
>$ dotnet run

Amp プロトコルのデフォルトのメッセージ ヘッダーの長さは、拡張ヘッダーを除いて 14 バイトです ビット 0: ver/argc //はバージョン番号です。当面は、デフォルトは 0 ですビット 1-4: length //パケットの全長（ヘッダー長を含む）です

ビット 5-8: sequence //メッセージですシーケンス番号、およびシーケンス番号はリクエストに対応します レスポンス

ビット 9: type // メッセージ タイプ、次の 5 つの現在の値があります:

リクエスト = 1、レスポンス = 2、 Notif

y = 3、NotFound = 4、ERROR = 5

ビット 10-11: serviceId//メッセージ ID ushort タイプ

ビット 12-13: msgId//メッセージ ID ushort タイプ

Amp プロトコルでは、serviceId はアプリケーションのモジュールと同様にリクエストのタイプを識別し、msgId はモジュール内の特定のメソッドを識別します

blockquote>

その後に実際のデータ

Google Protobuf

Google Protocol Buffer (略して Protobuf) は、Google の内部混合言語データ標準であり、現在 48,162 を超えるメッセージ形式定義と 12,183 を超える .proto ファイルが使用されています。これらは、RPC システムおよび永続データ ストレージ システムで使用されます。 🎜🎜プロトコル バッファーは、構造化データのシリアル化またはシリアル化に使用できる軽量で効率的な構造化データ ストレージ形式です。データストレージまたは 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 からダウンロードすると、プログラムをすばやくビルドし、面倒だが必要な手順をいくつか回避できます。 🎜

>$ cd HelloDotBPE.Client   
>$ dotnet run

🎜 VS2017 または VSCode を使用して、ダウンロードしたコードを開きます。ディレクトリ構造 🎜 は次のとおりです: 🎜🎜🎜VS2017を使用している場合は、自動的に復元できますVSCode を使用している場合は、dotnet list を実行して依存関係をダウンロードする必要があります。成功したら、dotnet build を使用してコンパイルし、結果を確認します。これは完璧です🎜。 🎜🎜🎜2. プログラムを実行します🎜 🎜サーバーを実行します🎜

//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
syntax = "proto3";
package dotbpe;

option csharp_namespace = "HelloDotBPE.Common";

// 引入扩展
import public "dotbpe_option.proto";

// 定义一个服务
service Greeter {
  option (service_id)= 100 ;//消息ID，全局必须唯一
  // Sends a greeting
  rpc 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 greetings
message HelloResponse {
  string message = 1;
}

🎜おめでとうございます! DotBPE.RPC を使用してサーバー/クライアント アプリケーションを実行している。 🎜🎜3. 一緒にコードを見てみましょう🎜🎜3.1 サービス記述ファイル proto🎜 1 つ目は、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.proto
syntax = "proto3";
package dotbpe;

option csharp_namespace = "HelloDotBPE.Common";

// 引入扩展
import public "dotbpe_option.proto";

// 定义一个服务
service Greeter {
  option (service_id)= 100 ;//消息ID，全局必须唯一
  // Sends a greeting
  rpc 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 greetings
message 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 Name
       return 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();

        }
    }</startup>

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。初步的功能已经实现，不过还没来的及写文档。该系列的后面将详细描述该系统的实现。

以上がDotBPE.RPC クイック スタートの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。