【ASP.NET Core】在 Mini-API 中注入服務

東邪獨孤發表於2023-10-04
ASP.NETAPI

經過版本更新，Mini API 的功能逐步完善，早期支援得不太好的 mini API 現在許多特性都可以用了，比如灰常重要的依賴注入。

我們們先來個相當簡單的注入測試。來，定義一個服務類，為了偷懶，老周這裡就不使用 介面 + 實現類 的方式了。

public class MyService : IDisposable
{
    public MyService()
    {
        Console.WriteLine($"{nameof(MyService)} 隆重開業");
    }

    public void Dispose()
    {
        Console.WriteLine($"{nameof(MyService)} 即將散夥");
    }

    public void DoSomething()
    {
        Console.WriteLine("正忙著呢……別鬧");
    }
}

此服務類提供給外部呼叫的公共方法是 DoSomething。

接下來在容器中註冊一下這個服務。

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddScoped<MyService>();
var app = builder.Build();

畢竟，每個 Web API 的呼叫都是一次訊息往返，所以我選擇將服務類註冊為範圍級別的——請求上下文的範圍記憶體活。

最簡單好用的注入方式是讓服務類的例項透過引數傳入。

app.MapGet("/", (MyService sv) =>
{
    // 呼叫服務類的公共方法
    sv.DoSomething();
    return "三日成精五日成魔七日成鬼";
});

Web API 測試可以不使用第三方工具，dotnet tool 集合有個叫 httprepl 的工具，可以方便使用。此工具需要安裝，命令如下：

dotnet tool install -g microsoft.dotnet-httprepl

安裝完成後，直接在命令終端輸入 httprepl ，回車。就進入了會話模式。假設應用程式的地址是 https://localhost:7249，可以用 connect 命令建立連線。

connect https://localhost:7249

發起請求時，可以用 get、post、put 等命令，對應 HTTP 的請求方式。在上面的例子中，我們們用的是 MapGet 方法註冊的 API，相對路徑是 /。

get /

呼叫成功後會返回文字。

而且，MyService 服務也被呼叫了。

 

接下來我們們改一下程式碼，新增一個引數x。

app.MapGet("/", (int x, MyService sv) =>
{
    sv.DoSomething();
    return $"你提交的引數是：{x}";
});

在呼叫 httprepl 工具時，也可以直接將 URL 作為命令列引數傳給它，能省去使用 connect 命令。

httprepl https://localhost:7249

然後呼叫一下 API 。

get /?x=150

得到的響應如下：

 

從上面的改動可以知道：來自依賴注入的引數能夠被識別。當然，我們們也可以明確指定各個引數的來源。

app.MapGet("/", ([FromQuery]int x, [FromServices]MyService sv) =>
{
    sv.DoSomething();
    return $"你提交的引數是：{x}";
});

再次執行，再次發出請求。

get /?x=399

 

注入服務在 POST 請求中也可以和作不 body 的引數一起用，例如：

app.MapPost("/send", (Pet p, MyService sv) =>
{
    // 呼叫服務
    sv.DoSomething();
    string s = string.Format("寵物ID：{0}，大名叫{1}", p.ID, p.Name);
    // 返回文字
    return s;
});

引數 sv 是依賴注入自動賦值的，而引數 p 是 Pet 例項，由HTTP請求的 body 部分提供（預設識別 JSON 格式）。Pet 類定義如下：

public class Pet
{
    public int ID { get; set; }
    public string? Name { get; set; }
}

這個類結構很簡單，兩個成員，用來測試的，不用在意。

在 HttpRepl 工具中可以用 post /send -h content-type=application/json -c ... 的格式提交，-h 指定 HTTP 頭，-c 指定 body 部分。但是，在命令列中用 -c 引數指定 body 很難寫，而且老容易出錯。最好的做法是配置一個文字編輯器。在編輯器中輸入好內容，儲存關閉檔案，然後 httprepl 工具會自動提交。編輯的檔案是臨時檔案，由工具生成，我們不用管它，只要在輸入好內容後儲存就行。

文字編輯器用啥都行，如記事本。當然，最好設定 VS Code。操作如下：

先進入 httprepl 會話：

httprepl

接著配置 editor.command.default 引數：

pref set editor.command.default "C:\Users\Bug-PC\tools\VSCode\Code.exe"

設定項名稱後面是 VS Code 的路徑。然後，它會提示你最好加上 -w 引數，於是輸入執行：

pref set editor.command.default.arguments "-w"

-w 引數是可以等待 VS Code 響應——等它編輯完關閉後返回 httprepl 工具。

現在，在 httprepl 會話中用 connect 命令連線伺服器。

connect https://localhost:7249

傳送 POST 請求。

post /send -h content-type=application/json

注意 Content Type 是 JSON 資料。執行後會啟動 VS Code，然後我們輸入：

{
    "id": 1234,
    "name": "Jack"
}

完成後記得儲存檔案，並關閉 VS Code。關閉 VS Code 後回到 httprepl 會話，請求自動傳送。

 

如果 mini-API 沒有定義接收注入的引數，也可以用 HttpContext 來主動請求服務例項。請看下面程式碼：

app.MapGet("/", (HttpContext context) =>
{
    // 主動請求服務
    MyService sv = context.RequestServices.GetRequiredService<MyService>();
    sv.DoSomething();
    return "我在這裡等了你上萬年了！";
});

只要在所繫結的委託/方法中提供 HttpContext 型別的引數，就可以自動注入。隨後在方法體中就可以直接引用。

這裡要注意：此處我們們不能用 app.Services 去請求服務，因為它引用的是根容器（應用程式最開始建立的），不能訪問生生命週期為 Scoped 的服務。

我們嘗試把服務註冊為單例項，看能不能用 app.Services 來獲取。

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton<MyService>();
var app = builder.Build();

app.MapGet("/", () =>
{
    // 主動請求服務
    MyService sv = app.Services.GetRequiredService<MyService>();
    sv.DoSomething();
    
    return "我在這裡等了你上萬年了！";
});

執行程式後，在 httprepl 中用 get / 命令測試透過。這說明，單例服務是支援透過 app.Services 獲取的。不過，MyService 例項要等到應用程式結束時才會釋放。

 

相關文章