DotBPE.RPC快速開始

大家讲道理
發布: 2017-05-31 14:37:00
原創
2405 人瀏覽過

0x00 簡介

DotBPE.RPC是一款基於dotnet core編寫的RPC框架,而它的爸爸DotBPE,目標是實現一個開箱即用的微服務框架,但是它還差點意思,還僅僅在構思和嘗試的階段。 ,先來講講RPC的實現吧。通訊元件。 ##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> | <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, Not
if
y = 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
下載依賴,成功後使用DotBPE.RPC快速開始dotnet build

編譯一下看看結果:看著很完美

#2. 運行程式
運行ServerDotBPE.RPC快速開始

>$ 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.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&#39;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();

        }
    }
登入後複製

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中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板