Caller 服務調用 - Dapr - ⎝⎛CodingNote.cc ⎞⎠

Caller 服務調用 – Dapr

2022 年 6 月 14 日
筆記
Dapr, MASA Framework

前言

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

Caller.Dapr 入門

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

改造Caller 服務調用 – HttpClient的中的服務端，使得服務端支持dapr調用
調整客戶端代碼，使客戶端支持通過dapr來做到服務調用，並達到與HttpClient調用相同的結果

準備工作

安裝.Net 6.0

創建ASP.NET Core 空白解決方案Assignment03
將Assignment02文件夾下的Assignment.Server複製到Assignment03的文件夾下，然後將項目Assignment.Server添加到解決方案Assignment03中

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

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

修改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，更多信息請參考[文章](//www.cnblogs. com/zhenlei520/p/16157625.html)
創建ASP.NET Core 空項目Assignment.Client.DaprClientWeb作為客戶端並安裝Masa.Utils.Caller.DaprClient
```
dotnet add package Masa.Utils.Caller.DaprClient --version 0.4.0-rc1
```

修改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，其餘代碼無需修改

添加環境變量DAPR_GRPC_PORT，值為7007、DAPR_HTTP_PORT，值為7008

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

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

DaprClient 最佳實踐

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

創建ASP.NET Core 空項目Assignment.Client.DaprClientWeb.V2作為調用方V2版本
選中Assignment.Client.DaprClientWeb.V2並安裝Masa.Utils.Caller.DaprClient
```
dotnet add package Masa.Utils.Caller.DaprClient --version 0.4.0-rc1
```

添加類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)
    {
    }
}

添加類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!;
}

添加環境變量DAPR_GRPC_PORT，值為7007、DAPR_HTTP_PORT，值為7008

最後，分別啟動Assignment.Server、Assignment.Client.DaprClientWeb.V2服務，瀏覽器訪問//localhost:5102/Test/User/Get、//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

//github.com/zhenlei520/MasaFramework.Practice

開源地址

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

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

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

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

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

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

Tags: Dapr MASA Framework