一行程式碼讓你的專案輕鬆使用Dapr

磊_磊發表於2022-04-19

介紹

Dapr簡化了雲原生開發，讓開發可以把焦點放在應用的業務邏輯上，從而讓程式碼簡單、可移植，那作為一個.Net開發者，我們也希望專案可以快速用上dapr，那究竟應該如何做呢？

Dapr提出了Sidecar(邊車)的概念，在啟動專案時再額外啟動一個Sidecar, 通過Sidecar可以解決程式間通訊，為此官方提供了兩種部署方式：

自託管方式下執行Dapr
在 Kubernetes 模式中部署和執行 Dapr

其中Kubernetes模式部署是通過Kubernetes來完成的，在開發中我們更多的是通過自託管模式使用Dapr，那自託管模式是怎麼做的呢？

使用命令列工具，在專案根目錄輸入：

dapr run --app-id assignment-server --app-port 5038 dotnet run

詳細文件參考：手把手教你學Dapr - 3. 使用Dapr執行第一個.Net程式

參考以上詳細文件操作後，我們就可以在命令列工具中執行dapr invoke --app-id assignment-server --method hello或者Http請求來呼叫對應的應用的方法

看似好像也不是很複雜，但如果你需要除錯dotnet專案呢？再複雜一點的需要啟動多個專案進行除錯呢？埠一多起來的確會顯得很麻煩。

有沒有什麼辦法可以解決呢？有，docker-compose。

但我還不想用這麼重的東西，我想像平時開發專案一樣直接在windows上執行可不可以？

Masa.Utils.Development.Dapr.AspNetCore 它來了

協助管理dapr程式，用於開發時減少對docker compose的依賴

瞌睡了就有人送枕頭，一句話讓我們瞭解到了它的作用，正好解決了我們需要通過命令列來啟動dapr的問題，那下面我們看看這個怎麼用：

入門

本著絕對不多寫一行程式碼的心態，我們準備出發了……

從大佬doddgu的部落格的連結中發現一份原始碼地址，為防止後期文件調整，先fork一份到自己倉庫
```
git clone https://github.com/zhenlei520/dapr-study-room.git
```
使用命令列工具開啟目錄dapr-study-room\Assignment03，然後執行命令
```
dotnet add package Masa.Utils.Development.Dapr.AspNetCore --version 0.4.0-preview.3
```
或使用Visual Studio開啟解決方案Assignment03，選中Assignment.Server並安裝Masa.Utils.Development.Dapr.AspNetCore

開啟Program.cs，並新增DaprStarter（注意看有註釋的那一行）

using Masa.Utils.Development.Dapr.AspNetCore;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDaprStarter();//新增DaprStarter即可
var app = builder.Build();

app.Map("/hello", () => Console.WriteLine("Hello World!"));

app.Run();

使用命令列工具執行命令驗證dapr是否啟動成功

dapr invoke --app-id Assignment-Server-00D861D0C0B7 --method hello

此時會有小夥伴問了，為什麼app-id是Assignment-Server-00D861D0C0B7？

檢視文件後發現Masa.Utils.Development.Dapr.AspNetCore的app-id生成規則為：AppId + AppIdDelimiter + AppIdSuffix，其中

AppId預設：專案名.Replace(".","-")
AppIdSuffix預設：網路卡地址

由於我們的專案名為Assignment.Server，當前電腦的網路卡地址是00D861D0C0B7，所以dapr最終的appid為Assignment-Server-00D861D0C0B7，到這裡，Masa.Utils.Development.Dapr.AspNetCore的使用講解已經完成了

冷知識，為什麼 . 要換成 - ？

因為Dapr的AppId採用FQDN：(Fully Qualified Domain Name)全限定域名：同時帶有主機名和域名的名稱。（通過符號“.”）

為什麼要加網路卡地址作為字尾？

因為目前自託管預設採用mDNS，會導致區域網內使用者的AppId互相汙染。你的同事和你一起在開發，都啟動了A應用，你倆就自動負載了，那後果自然就是請求也到處跑了。

進階

如果我希望自己指定AppId而不是使用預設的規則怎麼辦呢？目前支援三種寫法:

根據規則（配置預設裝配）
根據規則 + 程式碼指定（配置自定義裝配）
根據配置檔案（根據IConfiguration配置生成）

配置預設裝配（也是上面介紹的一行程式碼的方式）

修改Program.cs檔案

// 省略上述程式碼
builder.Services.AddDaprStarter();

根據規則 + 程式碼指定（配置自定義裝配）

修改Program.cs檔案

// 省略上述程式碼
builder.Services.AddDaprStarter(opt =>
{
    opt.AppId = "masa-dapr-test";
    opt.AppPort = 5001;
    opt.AppIdSuffix = "";
    opt.DaprHttpPort = 8080;
    opt.DaprGrpcPort = 8081;
});

基於預設裝配的升級版，在預設裝配基礎上通過指定特殊引數完成特殊需求，未配置的引數將使用預設值

根據IConfiguration配置生成

修改appsettings.json

{
  "DaprOptions": {
    "AppId": "masa-dapr-test",
    "AppPort": 5001,
    "AppIdSuffix": "",
    "DaprHttpPort": 8080,
    "DaprGrpcPort": 8081
  }
}

修改Program.cs

builder.Services.AddDaprStarter(builder.Configuration.GetSection("DaprOptions"));

優勢：更改appsettings.json配置後，dapr sidecar會自動更新，專案無需重啟

Masa.Utils.Development.Dapr.AspNetCore的設計思路

設計思路基於兩個方面，其一本機自動啟動dapr sidecar還可以正常除錯.Net專案，其二簡化配置

技術選型

我們有兩種啟動dapr sidecar的方式：

dapr run
daprd

兩者之間的差別如下所示：

完整的對比可檢視：https://docs.dapr.io/reference/arguments-annotations-overview/

通過對比我們發現，我們的目標使用daprd與Dapr CLI都可以實現，那為什麼Masa.Utils.Development.Dapr選擇的是Dapr CLI，而不是daprd呢？

核心的原因是dapr可以通過dapr list命令很簡單的就獲取到當前執行的所有dapr程式，而daprd無法獲取。如果使用daprd，那我們就需要使用C#程式碼通過操作dll獲取具體執行的dapr命令，且多平臺支援不好，所以暫時用了Dapr CLI

更優秀的Dapr管理需要做到什麼？

使用簡單
引數可配置
功能支援選擇性啟動
Dapr保活
配置支援動態更新

為了能更方便的使用，我們做了以下約定：

針對dapr的非必填項，預設關閉不啟用，手動配置引數後開啟
針對dapr的必填項: app-id、app-port、dapr-http-port、dapr-grpc-port 自動生成並配置

app-id 生成規則

其中dapr的app-id預設生成規則為：AppId + AppIdDelimiter + AppIdSuffix，其中

AppId預設：專案名.Replace(".","-")
AppIdDelimiter預設：-
AppIdSuffix預設：當前機器網路卡地址

當AppIdSuffix賦值為空字串，dapr的AppId的生成規則為：AppId

app-port 獲取

private ushort GetAppPort(DaprOptions options)
{
  var server = _serviceProvider.GetRequiredService<IServer>();
  var addresses = server.Features.Get<IServerAddressesFeature>()?.Addresses;
  if (addresses is { IsReadOnly: false, Count: 0 })
      throw new Exception("Failed to get the startup port, please specify the port manually");

  return addresses!
      .Select(address => new Uri(address))
      .Where(address
          => (options.EnableSsl is true && address.Scheme.Equals(Uri.UriSchemeHttps, StringComparison.OrdinalIgnoreCase))
          || address.Scheme.Equals(Uri.UriSchemeHttp, StringComparison.OrdinalIgnoreCase))
      .Select(address => (ushort)address.Port).FirstOrDefault();
}

為了防止啟動過程中修改埠，過早的獲取到被棄用的埠。因此我們使用後臺任務啟動dapr sidecar

dapr-http-port、dapr-grpc-port獲取

因為支援使用者配置，所以我們遵循下面的順序

如果指定埠，被佔用則自動kill port所在程式，保證可以sidecar可以正常啟動

為什麼埠占用就要先kill，複用不行嗎？

因為sidecar有初始化配置，程式調整的程式碼影響到sidecar配置變更我們無法檢測，所以啟動時保證是最新的是比較合適的選擇
如果未指定埠，則交還給dapr，通過Dapr CLI的規則生成對應的http-port或grpc-port