Caller 服務調用 - Dapr

前言

上一篇我們講了使用 HttpClient 的方式調用，那麼如果我們現在需要更換爲通過 dapr 實現服務調用，我們需要做哪些事情呢？

Caller.Dapr 入門

如果我們的項目原本使用的是 Caller.HttpClient，現在希望改爲使用 Caller.Dapr，那麼我們需要做什麼呢？

1. 改造 Caller 服務調用 - HttpClient 的中的服務端，使得服務端支持 dapr 調用

2. 調整客戶端代碼，使客戶端支持通過 dapr 來做到服務調用，並達到與 HttpClient 調用相同的結果

準備工作

• 安裝. Net 6.0

1. 創建 ASP.NET Core 空白解決方案Assignment03

2. 將Assignment02文件夾下的Assignment.Server複製到Assignment03的文件夾下，然後將項目Assignment.Server添加到解決方案Assignment03中

3. 選中Assignment.Server並安裝Masa.Utils.Development.Dapr.AspNetCore

   dotnet add package Masa.Utils.Development.Dapr.AspNetCore --version 0.4.0-rc1
   

4. 修改Assignment.Server項目下的Program.cs

   //忽略命名空間引用var builder = WebApplication.CreateBuilder(args);// 添加DaprStarter，用於服務端啓動dapr sidecar，改造服務端支持dapr調用的重點（建議在開發環境下使用，線上環境使用k8s部署）builder.Services.AddDaprStarter(option =>{
       option.AppId = "Assignment-Server";
       option.DaprGrpcPort = 7007;
       option.DaprHttpPort = 7008;
       option.AppIdSuffix = string.Empty;});var app = builder.Build();/// 忽略路由等

   Q: 什麼是 DaprStarter？爲什麼要使用 DaprStarter？
   A: DaprStarter 是 Masa 團隊開發出來用於管理 Dapr sidecar 的包，可以幫助我們在開發環境下很簡單的使用 dapr sidecar

   Q: 爲什麼要指定 AppId、DaprGrpcPort、DaprHttpPort 等信息？
   A: 客戶端調用需要得到 Dapr 的 AppId、設置 DaprGrpcPort、DaprHttpPort 是因爲客戶端演示項目沒有使用 dapr sidecar，如果客戶端項目也使用 dapr sidecar，此處可以不指定 DaprGrpcPort、DaprHttpPort，更多信息請參考文章

5. 創建 ASP.NET Core 空項目Assignment.Client.DaprClientWeb作爲客戶端並安裝Masa.Utils.Caller.DaprClient

   dotnet add package Masa.Utils.Caller.DaprClient --version 0.4.0-rc1
   

6. 修改Assignment.Client.DaprClientWeb項目下的Program.cs

   using Masa.Utils.Caller.Core;using Masa.Utils.Caller.DaprClient;using Microsoft.AspNetCore.Mvc;var builder = WebApplication.CreateBuilder(args);builder.Services.AddCaller(option =>{
       // 注意: 與Caller.HttpClient相比，需要修改的地方
       options.UseDapr(masaDaprClientBuilder =>
       {
           masaDaprClientBuilder.Name = "userCaller"; // 當前Caller的別名(僅有一個Caller時可以不填)，Name不能重複
           masaDaprClientBuilder.IsDefault = true; // 默認的Caller支持注入ICallerProvider獲取（僅有一個Caller時可不賦值）
           masaDaprClientBuilder.AppId = "Assignment-Server";//設置當前caller下Dapr的AppId
       });});var app = builder.Build();app.MapGet("/", () => "Hello HttpClientWeb.V1!");app.MapGet("/Test/User/Get", async ([FromServices] ICallerProvider callerProvider) =>{
       var user = await callerProvider.GetAsync<object, UserDto>("User", new { id = new Random().Next(1, 10) });
       return $"獲取用戶信息成功：用戶名稱爲：{user!.Name}";});app.MapGet("/Test/User/Add", async ([FromServices] ICallerProvider callerProvider) =>{
       var dateTimeOffset = new DateTimeOffset(DateTime.UtcNow);
       string timeSpan = dateTimeOffset.ToUnixTimeSeconds().ToString();
       var userName = "ss_" + timeSpan; //模擬一個用戶名
       string? response = await callerProvider.PostAsync<object, string>("User", new { Name = userName });
       return $"創建用戶成功了，用戶名稱爲：{response}";});app.Run();public class UserDto{
       public int Id { get; set; }
       
       public string Name { get; set; } = default!;}

   相較於Assignment.Client.HttpClientWeb，Assignment.Client.DaprClientWeb僅僅是更改了Program.cs，將UseHttpClient改爲UseDapr，其餘代碼無需修改

7. 添加環境變量DAPR_GRPC_PORT，值爲7007、DAPR_HTTP_PORT，值爲7008

   Q: 爲什麼要添加環境變量？
   A: 由於當前客戶端並未使用 dapr sidecar，若當前客戶端也使用 dapr sidecar，此處可以不添加環境變量

現在 Caller 的 HttpClient 版本就可以使用了，分別啓動Assignment.Server、Assignment.Client.DaprClientWeb服務，瀏覽器訪問http://localhost:5042/Test/User/Get、http://localhost:5042/Test/User/Add，分別輸出對應的獲取用戶信息成功以及創建用戶成功的提示，則證明調用成功了

DaprClient 最佳實踐

Assignment.Client.DaprClientWeb的寫法比較簡單，其用法與Assignment.Client.HttpClientWeb基本一致，與 Caller.HttpClient 類似，DaprClient 我們推薦使用下面的寫法:

1. 創建 ASP.NET Core 空項目Assignment.Client.DaprClientWeb.V2作爲調用方 V2 版本

2. 選中Assignment.Client.DaprClientWeb.V2並安裝Masa.Utils.Caller.DaprClient

   dotnet add package Masa.Utils.Caller.DaprClient --version 0.4.0-rc1
   

3. 添加類ServerCallerBase (對應服務端服務)

   using Masa.Utils.Caller.DaprClient;namespace Assignment.Client.DaprClientWeb.V2;/// <summary>/// 注意：ServerCallerBase是抽象類喲（抽象類不會被DI註冊）, 與使用Caller.HttpClient相比，需要修改的是繼承的基類改爲DaprCallerBase/// </summary>public abstract class ServerCallerBase : DaprCallerBase{
       protected override string AppId { get; set; } = "Assignment-Server";//設置當前Caller需要請求的服務端項目Dapr的AppId
       
       public ServerCallerBase(IServiceProvider serviceProvider) : base(serviceProvider)
       {
       }}

4. 添加類UserCaller.cs

   namespace Assignment.Client.DaprClientWeb.V2;public class UserCaller : ServerCallerBase{
       public UserCaller(IServiceProvider serviceProvider) : base(serviceProvider)
       {
       }
       
       /// <summary>
       /// 調用服務獲取用戶信息
       /// </summary>
       /// <param >用戶id</param>
       /// <returns></returns>
       public Task<UserDto?> GetUserAsync(int id)
           => CallerProvider.GetAsync<object, UserDto>("User", new { id = id });
       
       /// <summary>
       /// 調用服務添加用戶
       /// </summary>
       /// <param ></param>
       /// <returns></returns>
       public Task<string?> AddUserAsync(string userName)
           => CallerProvider.PostAsync<object, string>("User", new { Name = userName });}public class UserDto{
       public int Id { get; set; }
       
       public string Name { get; set; } = default!;}

5. 添加環境變量DAPR_GRPC_PORT，值爲7007、DAPR_HTTP_PORT，值爲7008

最後，分別啓動Assignment.Server、Assignment.Client.DaprClientWeb.V2服務，瀏覽器訪問http://localhost:5102/Test/User/Get、http://localhost:5102/Test/User/Add，分別輸出對應的獲取用戶信息成功以及創建用戶成功的提示，則證明調用成功了

常見問題

在開發中我們會遇到各種各樣的問題，下面就來列舉幾個我們項目中遇到的問題：

• 一個項目在同一個 k8s 集羣部署了兩套環境，爲什麼會出現代碼調用混亂（開發環境調用線上環境）？

  在於同一個K8s集羣下，dapr會將服務組網，並將它們認爲是同一個服務(AppId一致的服務)。

• 如何解決同一個 k8s 集羣中調用混亂的問題？

  解決方案有兩種：
  1. 將不同環境下的服務分別部署在不同的K8s集羣
  2. 根據環境調整相對應服務的dapr sidecar的配置，其`AppId`的命名規則：`AppId`-`環境名`。修改自定義Caller的規則：
      
  public abstract class CustomizeDaprCallerBase : DaprCallerBase
  {
      protected CustomizeDaprCallerBase(IServiceProvider serviceProvider) : base(serviceProvider)
      {
          var hostEnvironment = serviceProvider.GetRequiredService<IWebHostEnvironment>();
          if (!hostEnvironment.IsDevelopment() || hostEnvironment.IsStaging())
              AppId = AppId + "-" + hostEnvironment.EnvironmentName;
      }
  }

• 如何修改支持自定義 Header？

  目前Caller.Dapr不支持自定義Header，目前只能使用`SendAsync`才能自定義Header，不過此功能已經在0.5.0的開發計劃中，在0.5.0中會支持

總結

使用 Masa 提供的 Caller 服務，有助於我們的項目在前期沒有使用 Dapr 的情況下先利用Caller.HttpClient做緩衝，等後期時機成熟，只需要更改相對應的 CallerBase 即可，其他代碼基本不需要調整，減輕了我們的開發成本，並且不同的 Caller 仍然可以很靈活的調整超時時間、Header 等信息，並且 Caller 默認提供了處理異常的功能，當調用出錯後，會自動拋出異常，讓我們可以更專心的處理業務。

但目前 Caller 還有不足之處，目前Caller.Dapr版針對請求頭處理的並不完善，除此之外，目前不支持 Content-Type 爲非 Json 類型，這塊功能會在 0.5.0 版本中加以支持完善

本章源碼

Assignment03

https://github.com/zhenlei520/MasaFramework.Practice

開源地址

MASA.BuildingBlocks：https://github.com/masastack/MASA.BuildingBlocks

MASA.Contrib：https://github.com/masastack/MASA.Contrib

MASA.Utils：https://github.com/masastack/MASA.Utils

MASA.EShop：https://github.com/masalabs/MASA.EShop

MASA.Blazor：https://github.com/BlazorComponent/MASA.Blazor

如果你對我們的 MASA Framework 感興趣，無論是代碼貢獻、使用、提 Issue，歡迎聯繫我們

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/HiemycRkW674uTco_p7LWw