天天看點

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 name="id">使用者id</param>
        /// <returns></returns>
        public Task<UserDto?> GetUserAsync(int id)
            => CallerProvider.GetAsync<object, UserDto>("User", new { id = id });
    
        /// <summary>
        /// 調用服務添加使用者
        /// </summary>
        /// <param name="userName"></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,歡迎聯系我們

本文來自部落格園,作者:磊_磊,轉載請注明原文連結:https://www.cnblogs.com/zhenlei520/p/16324804.html

本文版權歸作者和部落格園共有,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連結,否則保留追究法律責任的權利

繼續閱讀