ASP.NET Core 6最小API中使用紀錄檔和DI範例詳解

2022-08-01 14:03:23

在ASP.NET Core 6的最小API中使用紀錄檔和DI

如何在ASP.NET Core 6的最小API中實現紀錄檔、從設定系統中讀取並使用依賴注入

ASP.NET Core 6引入了一個簡化的託管模型，可用於實現具有最小依賴性的輕量級API。這些最小的API極大地減少了你需要編寫的模板程式碼，以使你的ASP.NET Core 6應用程式啟動和執行。

我們在之前的文章中討論瞭如何開始使用最小API。在這篇文章中，我們將探討最小化API的更多高階方面，包括實現紀錄檔、從設定系統中讀取以及使用依賴性注入。

CI/CD？持續整合和持續交付解釋

也在InfoWorld上。什麼是CI/CD？持續整合和持續交付解釋

要使用本文提供的程式碼範例，你的系統中應該安裝有Visual Studio 2022。如果你還沒有副本，你可以在這裡下載Visual Studio 2022。

在Visual Studio 2022中建立一個ASP.NET Core minimal web API專案

首先，讓我們在Visual Studio 2022中建立一個ASP.NET Core專案。按照這些步驟將在Visual Studio 2022中建立一個新的ASP.NET Core Web API 6專案：

啟動Visual Studio 2022 IDE
點選 "建立新專案"
在 "建立新專案 "視窗，從顯示的模板列表中選擇 "ASP.NET Core Web API";
點選 "下一步"
在 "設定你的新專案 "視窗中，指定新專案的名稱和位置
根據你的喜好，可以選擇勾選 "將解決方案和專案放在同一目錄下 "核取方塊
點選 "下一步"
在接下來顯示的 "附加資訊 "視窗中，取消勾選 "使用控制器... "的核取方塊，因為在這個例子中我們將使用最小的API。將 "驗證型別 "保留為 "無"（預設）
確保 "啟用Docker"、"為HTTPS設定 "和 "啟用開放API支援 "的核取方塊不被選中，因為我們不會在這裡使用任何這些功能
點選建立

這將在Visual Studio 2022中建立一個新的ASP.NET Core 6 Web API專案。我們將在本文的後續章節中使用這個專案來處理一個最小的API。

執行一個最小的網路API

你只需寫幾行程式碼就可以讓你的最小API工作：

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
app.MapGet("/", () => "This is an example of a minimal API");
app.Run();

為一個最小的網路API設定多個埠

下面的程式碼片斷說明了你如何設定你的最小API在一個特定的埠上執行：

var app = WebApplication.Create(args);
app.MapGet("/", () =&gt; "Hello World!");
app.Run("http://localhost:5178");

當你執行應用程式並瀏覽到這個URL時，你應該看到 "Hello World!"資訊顯示在你的Web瀏覽器中。

你可以通過新增URL來使用多個埠，如下面的程式碼片斷所示：

app.Urls.Add("http://localhost:5178");
app.Urls.Add("http://localhost:5179");

在這種情況下，如果你瀏覽到這些端點中的任何一個，都會顯示同樣的 "Hello World!"資訊。

你甚至可以從環境中讀取埠，如下面給出的程式碼片斷所示：

var app = WebApplication.Create(args);
var port = Environment.GetEnvironmentVariable("PORT") ?? "5155";
app.MapGet("/", () =&gt; "Hello World!");
app.Run($"http://localhost:{port}");

在最小的Web API中使用紀錄檔記錄

你也可以在你的最小API中使用紀錄檔。下面是你如何使用Serilog將資料記錄到控制檯：

var logger = new LoggerConfiguration()
    .WriteTo.Console()
    .CreateLogger();

你可以使用Serilog來建立紀錄檔，使應用程式重新啟動時也能持續。Serilog支援將紀錄檔記錄到資料庫、檔案、雲端儲存和其他目標。下面的程式碼片斷說明了你如何在最小的API中使用Serilog：

var builder = WebApplication.CreateBuilder(args);
Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .WriteTo.File("logs.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();

下面的程式碼片斷說明了你如何在最小的API中使用紀錄檔記錄：

app.MapGet("/", (ILoggerFactory loggerFactory) => {
    var logger = loggerFactory.CreateLogger("Start");
    logger.LogInformation("Starting...");
    return "Logging at work!";
});

在最小的API中從設定系統中讀取

你也可以在你的最小的API中從設定系統中讀取。下面的程式碼片斷顯示瞭如何實現這一點：

var app = WebApplication.Create(args);
var message = app.Configuration["TextMessage"] ?? "This is a default message.";
app.MapGet("/", () => message);
app.Run();

在最小的網路API中使用依賴性注入

如果你想使用一個HttpClient範例來連線到一個遠端資源，你可以使用依賴性注入，如下文給出的程式碼片段所示：

app.MapGet("/", (IHttpClientFactory httpClientFactory) =&gt; "Inside HttpGet method");

記住要使用下面的程式碼將HttpClient新增到容器中：

builder.Services.AddHttpClient();

你也可以在HttpPost方法中利用依賴注入的優勢。下面的程式碼片段顯示了你如何將IHttpClientFactory的一個範例作為引數傳遞給你的HttpPost方法：

app.MapPost("/", (IHttpClientFactory httpClientFactory) =>
{
    var client = httpClientFactory.CreateClient();
    return Results.Ok();
});

在一個最小的Web API中注入一個自定義類

你也可以在你的最小API中注入一個自定義類的範例。為了說明這一點，我們來實現兩種型別：IAuthorRepository介面和AuthorRepository類。我們將使用這些型別在我們的最小API中實現依賴性注入。

建立一個名為IAuthorRepository.cs的新檔案並插入以下程式碼：

   public interface IAuthorRepository
    {
        public List<Author> GetAuthors();
        public Author GetAuthor(int id);
    }

AuthorRepository類實現了IAuthorRepository介面，如下圖所示：

 public class AuthorRepository: IAuthorRepository
    {
        private readonly List<Author> _authors;
        public AuthorRepository()
        {
            _authors = new List<Author>
            {
                new Author
                {
                    Id = 1,
                    FirstName = "Joydip",
                    LastName = "Kanjilal"
                },
                new Author
                {
                    Id = 2,
                    FirstName = "Steve",
                    LastName = "Smith"
                },
                new Author
                {
                    Id = 3,
                    FirstName = "Julie",
                    LastName = "Lerman"
                },
                new Author
                {
                    Id = 4,
                    FirstName = "Simon",
                    LastName = "Bisson"
                }
            };
        }
        public List<Author> GetAuthors()
        {
            return _authors;
        }
        public Author GetAuthor(int id)
        {
            return _authors.Find(x=> x.Id == id);
        }
    }

在最小的網路API中注入一個自定義介面

下面的程式碼片段說明了你如何注入IAuthorRepository介面的範例：

app.MapGet("api/author/{id:int}", async (IAuthorRepository authorRepository, HttpContext httpContext) =>
{
    var id = int.Parse((string)httpContext.Request.RouteValues["id"]);
    var author = authorRepository.GetAuthor(id);
    if (author == null)
    {
        return Results.NotFound();
    }
    return Results.Ok(author);
});

最後，.NET 6包括一個偉大的新功能--全域性使用指令。為了利用全域性使用，建立一個名為Usings.cs的新檔案，並將你所有的使用語句移到那裡。你可以在你的ASP.NET Core 6或最小的API中使用這一功能，更多關於ASP.NET Core 6 API紀錄檔DI的資料請關注it145.com其它相關文章！