技術文章 » Caller 服務呼叫

Caller 服務呼叫

2022-06-14 15:02:41

前言

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

Caller.Dapr 入門

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

  1. 改造Caller 服務呼叫 - HttpClient的中的伺服器端，使得伺服器端支援dapr呼叫
  2. 調整使用者端程式碼，使使用者端支援通過dapr來做到服務呼叫，並達到與HttpClient呼叫相同的結果

準備工作

  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，更多資訊請參考[文章](https://www.cnblogs. com/zhenlei520/p/16157625.html)

  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，歡迎聯絡我們