.NetCore|.Net6 gRPC服務開發及本地調試

来源:https://www.cnblogs.com/CXY-Blog/archive/2022/07/09/16460110.html
-Advertisement-
Play Games

1.在C#中的目錄級別分為： 工程 -》項目-》類 。 2.在一個工程中可以添加多個項目，可以通過工程屬性設置運行時執行當前選中的項目： 選中當前工程 點擊 選擇屬性- 當前選定內容 3.在同一個工程中添加多個項目： 選擇當前工程-》添加-》 新建項目 4.移除同一個工程中的項目：（註意不要卸載項目 ...


前言

最近在項目中實裝應用了gRPC技術，本著能把技術描述出來給別人能看的懂的思想及作為自己學習筆記的心態編寫了此文。因為在實際項目中是webApi介面和gRPC介面使用在同一項目服務中，所以本文的例子也是建立在webApi項目而非控制台項目中。

1、gRPC介紹

gRPC 是Google發起的一個開源遠程過程調用 系統。該系統基於HTTP/2 協議傳輸，使用Protocol Buffers 作為介面描述語言。 其他功能： 認證 雙向流 流控制 超時 最常見的應用場景是： 微服務框架下，多種語言服務之間的高效交互。 將手機服務、瀏覽器連接至後臺 產生高效的客戶端庫-- 維基百科
微軟官網介紹:
gRPC是一種與語言無關的高性能遠程過程調用 (RPC) 框架。
gRPC 的主要好處是：
現代、高性能、輕量級的 RPC 框架。
合約優先的 API 開發，預設使用 Protocol Buffers，允許語言無關的實現。
可用於多種語言的工具來生成強類型伺服器和客戶端。
支持客戶端、伺服器和雙向流式調用。
通過 Protobuf 二進位序列化減少網路使用。
這些優勢使 gRPC 非常適合：
效率至關重要的輕量級微服務。
需要多種語言進行開發的多語言系統。
需要處理流請求或響應的點對點實時服務。

2、gRPC服務端開發

服務端的介面以傳入一個組織id作為入參，返回該組織用戶基本信息為例子 * 首先創建一個webApi項目作為服務端 ![](https://img2022.cnblogs.com/blog/855221/202207/855221-20220709130715436-144401422.png)

  • 程式包管理器控制台添加 Grpc.AspNetCore nuget包引用
    Install-Package Grpc.AspNetCore -Version 2.47.0*

  • 新建一個Grpc及Proto文件夾分別放置 gRPC服務和proto文件（方便管理）

  • 在proto文件夾下新建一個 user.proto 文件(vs 文件模板沒有該尾碼名文件，直接新建任意文件改文件名即可)，在 user.proto文件中定義gRPC服務方法、入參及返回值

點擊查看代碼 

syntax = "proto3";

option csharp_namespace = "GrpcUser";

package UserApi;

service User {
	rpc GetUserByOrganizationId(OrganizationUserRequest) returns (OrganizationUserRequestResponse) {} 
}

message OrganizationUserRequest {
	string organizationid = 1;
}
 

message OrganizationUserRequestResponse {
	string organizationid = 1;
	repeated OrganizationUserItemResponse items = 2;
}

message OrganizationUserItemResponse {
	string id = 1; 
	string name =2;
	int32 sex = 3; 
}
  • 右鍵編輯項目文件，增加一個節點，並把 user.proto 文件包含進去
點擊查看代碼 
<Project Sdk="Microsoft.NET.Sdk.Web">

	<PropertyGroup>
		<TargetFramework>net6.0</TargetFramework>
		<Nullable>enable</Nullable>
		<ImplicitUsings>enable</ImplicitUsings>
	</PropertyGroup>

	<ItemGroup>
		<PackageReference Include="Grpc.AspNetCore" Version="2.47.0" />
		<PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
	</ItemGroup>

	<ItemGroup>
		<Folder Include="Grpc\" />
	</ItemGroup>

	<ItemGroup>
		<Protobuf Include="Proto\user.proto" GrpcServices="Server" Generator="MSBuild:Compile"/>
	</ItemGroup>
</Project>
  • Grpc文件夾下新建類 UserService，並繼承 User.UserBase 並重寫 GetUserByOrganizationId 方法實現並介面業務
點擊查看代碼 

using Grpc.Core;
using GrpcUser;

namespace gRPCServer.Grpc
{
    public class UserService : User.UserBase
    {
        public override Task<OrganizationUserResponse> GetUserByOrganizationId(OrganizationUserRequest request, ServerCallContext context)
        {

            /*******此處實際業務從持久層獲取數據**********/
            var organizationUser = new OrganizationUser(request.Organizationid);
            organizationUser.Items = GetUserInfos();

            return Task.FromResult(MapToResponse(organizationUser));
        }

        private List<UserInfo> GetUserInfos()
        {
            var userInfos = new List<UserInfo>();
            userInfos.Add(new UserInfo
            {
                Id = 1,
                Name = "用戶1",
                Sex = 0
            });

            userInfos.Add(new UserInfo
            {
                Id = 2,
                Name = "用戶2",
                Sex = 1
            });

            return userInfos;
        }

        private OrganizationUserResponse MapToResponse(OrganizationUser organizationUser)
        {
            var response = new OrganizationUserResponse()
            {
                Organizationid = organizationUser.OrganizationId
            };

            organizationUser.Items.ForEach(item => response.Items.Add(new OrganizationUserItemResponse
            {
                Id = item.Id,
                Name = item.Name,
                Sex = item.Sex
            }));

            return response;
        }
    }


    public class OrganizationUser
    {
        public string? OrganizationId { get; set; }
        public List<UserInfo> Items { get; set; }
        public OrganizationUser(string organizationId)
        {
            OrganizationId = organizationId;
        }
    }

    public class UserInfo
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public int Sex { get; set; }
    }
}
  • 在Program 文件中啟用grpc中間件並映射我們寫好的服務

//啟用grpc
builder.Services.AddGrpc();

//映射grpc服務
app.MapGrpcService<UserService>();
  • 因為我們的項目是跑在webApi的項目中，所以還要配置內核去監聽另一個埠才能接收並處理gRPC的請求
builder.WebHost.ConfigureKestrel(
    options =>
    {
        //webApi監聽埠
        options.Listen(System.Net.IPAddress.Any, 5157, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http1AndHttp2;
        });

        //grpc監聽埠
        options.Listen(System.Net.IPAddress.Any, 5158, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http2;
        });
    }
    );
  • 完整的Program
點擊查看代碼 
using gRPCServer.Grpc;

var builder = WebApplication.CreateBuilder(args);
builder.WebHost.ConfigureKestrel(
    options =>
    {
        //webApi監聽埠
        options.Listen(System.Net.IPAddress.Any, 5157, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http1AndHttp2;
        });

        //grpc監聽埠
        options.Listen(System.Net.IPAddress.Any, 5158, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http2;
        });
    }
    );


// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

//啟用grpc
builder.Services.AddGrpc();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

//映射grpc服務
app.MapGrpcService<UserService>();

app.UseAuthorization();

app.MapControllers();

app.Run();
  • 這樣，我們的gRPC的服務端就搞定了，完整的項目結構就變成這樣了

3、gRPC客戶端開發

客戶端項目我們也是新建一個webApi項目，併在webapi介面中調用我們的gRPC服務介面獲取數據並以json格式輸出 * 首先新建一個webApi項目

  • 程式包管理器控制台添加 Grpc.AspNetCore nuget包引用
    Install-Package Grpc.AspNetCore -Version 2.47.0
  • 新建文件夾proto，並將 gRPCServer項目的 user.proto 文件拷貝過來
  • 右鍵編輯項目文件，增加一個節點，並把 user.proto 文件包含進去（節點Server屬性要設置為 Client）
<Project Sdk="Microsoft.NET.Sdk.Web">
	<PropertyGroup>
		<TargetFramework>net6.0</TargetFramework>
		<Nullable>enable</Nullable>
		<ImplicitUsings>enable</ImplicitUsings>
	</PropertyGroup>

	<ItemGroup>
		<PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
	</ItemGroup>

	<ItemGroup>
		<Folder Include="Controllers\" />
	</ItemGroup>

	<ItemGroup>
		<Protobuf Include="Proto\user.proto" GrpcServices="Client" Generator="MSBuild:Compile"/>
	</ItemGroup>
</Project>
  • 在Program文件中註入 Grpc客戶端
//註入grpc客戶端
builder.Services.AddGrpcClient<GrpcUser.User.UserClient>(
    options =>
    {
        options.Address = new Uri("http://localhost:5158"); //grpcServer項目配置的grpc服務監聽埠
    });
  • 新建控制器 UserController 調用 grpcClient獲取數據
using Microsoft.AspNetCore.Mvc;
using GrpcUser;

namespace gRPCClient.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class UserController : ControllerBase
    {
        private User.UserClient _userClient;
        public UserController(User.UserClient userClient)
        {
            _userClient = userClient;
        }

        /// <summary>
        /// 獲取用戶
        /// </summary>
        /// <param name="organizationId"></param>
        /// <returns></returns>
        [HttpGet]
        
        public async Task<OrganizationUserResponse> GetUser(string organizationId)
        {
            var user = await _userClient.GetUserByOrganizationIdAsync(new OrganizationUserRequest { Organizationid = organizationId });

            return user;
        }
    }
}

  • 先啟動 grpcSever項目，然後再啟動 client項目，在swagger頁面調用 GetUser方法即可獲取到grpc介面返回數據，Grpc服務於客戶端調用就搭建好了

  • 完整項目結構

4、gRPC服務端介面本地調試

grpcServer的介面服務不能像webApi一樣直接啟動就能進行調試，需要藉助一些第三方中間件進行協助測試。我這邊使用的是grpcui 進行對本地grpc服務介面的開發調試，下麵是grpcui的安裝及使用步驟

  • grpcui是Go語言編寫的，所以第一步我們先要進行Go環境的搭建。

  • 打開Go官網 ，下載並安裝

  • 安裝完成，以管理員身份打開PowerShell,並修改Go環境變數
    go env -w GO111MODULE=on

  • 因為Go 包源在外網，所以我們要設置一些代理，方便安裝
    go env -w GOPROXY=https://goproxy.cn,direct

  • 安裝grpcui
    go install github.com/fullstorydev/grpcui/cmd/grpcui@latest

  • 安裝完成即可使用命令測試是否安裝成功
    grpcui --help

  • 安裝完調試工具還需要修改一些我們的grpcService項目，讓項目把grpc服務介面給反射出來，grpcui工具才能獲取到相應介面並以webUi的方式進行調試

  • 程式包管理器控制台添加 Grpc.AspNetCore.Server.Reflection nuget包引用
    Install-Package Grpc.AspNetCore.Server.Reflection -Version 2.47.0

  • 項目註入grpc服務反射包服務
    builder.Services.AddGrpcReflection();

  • 啟用grpc映射
    app.MapGrpcReflectionService();

  • 最終gRPCServer項目的Program 文件配置如下

using gRPCServer.Grpc;

var builder = WebApplication.CreateBuilder(args);
builder.WebHost.ConfigureKestrel(
    options =>
    {
        //webApi監聽埠
        options.Listen(System.Net.IPAddress.Any, 5157, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http1AndHttp2;
        });

        //grpc監聽埠
        options.Listen(System.Net.IPAddress.Any, 5158, listenOptions =>
        {
            listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http2;
        });
    }
    );


// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

//啟用grpc
builder.Services.AddGrpc();
//啟用grpc反射
builder.Services.AddGrpcReflection();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

//映射grpc服務
app.MapGrpcService<UserService>();

//映射grpc反射服務
app.MapGrpcReflectionService();

app.UseAuthorization();

app.MapControllers();

app.Run();

  • 啟動gRPC項目

  • PowerShell 執行命令 grpcui -plaintext {grpc服務的ip埠地址} 即可開啟webUi界面調試grpc介面

  • 啟動的WebUI調試頁面

在此頁面我們就可以像使用Postman調試webApi一樣調試我們的grpc介面了

參考資料：
微軟gRPC使用教程：https://docs.microsoft.com/en-us/aspnet/core/grpc/?view=aspnetcore-6.0
grpcui測試grpc服務教程：https://docs.microsoft.com/en-us/aspnet/core/grpc/test-tools?view=aspnetcore-6.0
grpcui項目教程：https://github.com/fullstorydev/grpcui


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • sleep()和wait()有什麼不同之處呢？
    Aspose簡介 Aspose.Total是Aspose公司旗下全套文件格式處理解決方案，提供最完整、最高效的文檔處理解決方案集，無需任何其他軟體安裝和依賴。主要提供.net、java、C++d三個開發語言的工具包，通過它，可以對辦公文檔格式的轉換和文檔內容的線上編輯，如：Word, Excel, ...
  • Java面向對象（一）
    Java面向對象（一） 一、面向過程（POP）與面向對象（OOP） 二者都是一種思想，面向對象是相對於面向過程而言的。面向過程，強調的是功能行為，以函數為最小單位，考慮怎麼做。面向對象，將功能封裝進對 象，強調具備了功能的對象，以類/對象為最小單位，考慮誰來做。 面向對象的三大特征： 封裝 繼承 多 ...
  • java稀疏數組
    稀疏組織 當一個數組中大部分元素為0，或者為同一個值的數組時，可以用稀疏數組來保存該數組 稀疏數組，記錄一共有幾行幾列，有多少個不同值 把具有不同值的元素和行里了及值記錄在一個小規模的數組中，從而縮小程式的規模！ 我們定義一下原始數組： 原始數組如下： 0 0 3 0 0 0 0 0 0 4 0 0 ...
  • 一文聊透 Netty IO 事件的編排利器 pipeline | 詳解所有 IO 事件的觸發時機以及傳播路徑
    歡迎關註公眾號：bin的技術小屋，本文圖片載入不出來的話可查看公眾號原文 本系列Netty源碼解析文章基於 4.1.56.Final版本 1. 前文回顧 在前邊的系列文章中，筆者為大家詳細剖析了 Reactor 模型在 netty 中的創建，啟動，運行，接收連接，接收數據，發送數據的完整流程，在詳細 ...
  • synchronized和Lock的不同之處簡介說明
    一年一度的面試高峰期又來了，技術學習群的很多朋友問我有沒有關於JVM基礎面試題，網上各種面試題沒有分類很混亂，無法系統性參考學習。 於是，我就把之前整理的以及我面試過的真題和答案都整理了一份分享給大家。共計108道面試題！ 持續根據技術群反饋不端更新，將涵蓋內容包括: Java設計模式、Spring ...
  • Elasticsearch 入門實戰(3)--REST API 使用
    Arrays類的常用方法 代碼示例： public class ArrayDemo { public static void main(String[] args) { int[] a={1,2,57,8,1,58,4,51,5,45,15,1}; System.out.println(a); // ...
  • 讀經典【1】重構：改善既有代碼的設計
    Java Development Kit 簡稱 JDK，任何需要開發 Java 程式的環境都需要進行安裝 JDK。 JDK 下載地址：https://www.oracle.com/java/technologies/downloads Windows 電腦安裝 JDK 1. 下載 JDK 在 JDK ...
  • C# 11 的新特性和改進前瞻
    前言 .NET 7 的開發還剩下一個多月就要進入 RC，C# 11 的新特性和改進也即將敲定。在這個時間點上，不少新特性都已經實現完畢併合併入主分支 C# 11 包含的新特性和改進非常多，類型系統相比之前也有了很大的增強，在確保靜態類型安全的同時大幅提升了語言表達力。 那麼本文就按照方向從 5 個大 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類