在ASP.NET Core 6的最小API中使用日志和DI

如何在ASP.NET Core 6的最小API中實(shí)現(xiàn)日志、從配置系統(tǒng)中讀取并使用依賴(lài)注入

ASP.NET Core 6引入了一個(gè)簡(jiǎn)化的托管模型，可用于實(shí)現(xiàn)具有最小依賴(lài)性的輕量級(jí)API。這些最小的API極大地減少了你需要編寫(xiě)的模板代碼，以使你的ASP.NET Core 6應(yīng)用程序啟動(dòng)和運(yùn)行。

我們?cè)谥暗?a rel="external nofollow" target="_blank">文章中討論了如何開(kāi)始使用最小API。在這篇文章中，我們將探討最小化API的更多高級(jí)方面，包括實(shí)現(xiàn)日志、從配置系統(tǒng)中讀取以及使用依賴(lài)性注入。

CI/CD？持續(xù)集成和持續(xù)交付解釋

也在InfoWorld上。什么是CI/CD？持續(xù)集成和持續(xù)交付解釋

要使用本文提供的代碼示例，你的系統(tǒng)中應(yīng)該安裝有Visual Studio 2022。如果你還沒(méi)有副本，你可以在這里下載Visual Studio 2022。

在Visual Studio 2022中創(chuàng)建一個(gè)ASP.NET Core minimal web API項(xiàng)目

首先，讓我們?cè)赩isual Studio 2022中創(chuàng)建一個(gè)ASP.NET Core項(xiàng)目。按照這些步驟將在Visual Studio 2022中創(chuàng)建一個(gè)新的ASP.NET Core Web API 6項(xiàng)目：

• 啟動(dòng)Visual Studio 2022 IDE
• 點(diǎn)擊 "創(chuàng)建新項(xiàng)目"
• 在 "創(chuàng)建新項(xiàng)目 "窗口，從顯示的模板列表中選擇 "ASP.NET Core Web API";
• 點(diǎn)擊 "下一步"
• 在 "配置你的新項(xiàng)目 "窗口中，指定新項(xiàng)目的名稱(chēng)和位置
• 根據(jù)你的喜好，可以選擇勾選 "將解決方案和項(xiàng)目放在同一目錄下 "復(fù)選框
• 點(diǎn)擊 "下一步"
• 在接下來(lái)顯示的 "附加信息 "窗口中，取消勾選 "使用控制器... "的復(fù)選框，因?yàn)樵谶@個(gè)例子中我們將使用最小的API。將 "驗(yàn)證類(lèi)型 "保留為 "無(wú)"（默認(rèn)）
• 確保 "啟用Docker"、"為HTTPS配置 "和 "啟用開(kāi)放API支持 "的復(fù)選框不被選中，因?yàn)槲覀儾粫?huì)在這里使用任何這些功能
• 點(diǎn)擊創(chuàng)建

這將在Visual Studio 2022中創(chuàng)建一個(gè)新的ASP.NET Core 6 Web API項(xiàng)目。我們將在本文的后續(xù)章節(jié)中使用這個(gè)項(xiàng)目來(lái)處理一個(gè)最小的API。

運(yùn)行一個(gè)最小的網(wǎng)絡(luò)API

你只需寫(xiě)幾行代碼就可以讓你的最小API工作：

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

為一個(gè)最小的網(wǎng)絡(luò)API配置多個(gè)端口

下面的代碼片斷說(shuō)明了你如何配置你的最小API在一個(gè)特定的端口上運(yùn)行：

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

當(dāng)你運(yùn)行應(yīng)用程序并瀏覽到這個(gè)URL時(shí)，你應(yīng)該看到 "Hello World!"信息顯示在你的Web瀏覽器中。

你可以通過(guò)添加URL來(lái)使用多個(gè)端口，如下面的代碼片斷所示：

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

在這種情況下，如果你瀏覽到這些端點(diǎn)中的任何一個(gè)，都會(huì)顯示同樣的 "Hello World!"信息。

你甚至可以從環(huán)境中讀取端口，如下面給出的代碼片斷所示：

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

在最小的Web API中使用日志記錄

你也可以在你的最小API中使用日志。下面是你如何使用Serilog將數(shù)據(jù)記錄到控制臺(tái)：

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

你可以使用Serilog來(lái)創(chuàng)建日志，使應(yīng)用程序重新啟動(dòng)時(shí)也能持續(xù)。Serilog支持將日志記錄到數(shù)據(jù)庫(kù)、文件、云存儲(chǔ)和其他目標(biāo)。下面的代碼片斷說(shuō)明了你如何在最小的API中使用Serilog：

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

下面的代碼片斷說(shuō)明了你如何在最小的API中使用日志記錄：

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

在最小的API中從配置系統(tǒng)中讀取

你也可以在你的最小的API中從配置系統(tǒng)中讀取。下面的代碼片斷顯示了如何實(shí)現(xiàn)這一點(diǎn)：

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

在最小的網(wǎng)絡(luò)API中使用依賴(lài)性注入

如果你想使用一個(gè)HttpClient實(shí)例來(lái)連接到一個(gè)遠(yuǎn)程資源，你可以使用依賴(lài)性注入，如下文給出的代碼片段所示：

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

記住要使用下面的代碼將HttpClient添加到容器中：

builder.Services.AddHttpClient();

你也可以在HttpPost方法中利用依賴(lài)注入的優(yōu)勢(shì)。下面的代碼片段顯示了你如何將IHttpClientFactory的一個(gè)實(shí)例作為參數(shù)傳遞給你的HttpPost方法：

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

在一個(gè)最小的Web API中注入一個(gè)自定義類(lèi)

你也可以在你的最小API中注入一個(gè)自定義類(lèi)的實(shí)例。為了說(shuō)明這一點(diǎn)，我們來(lái)實(shí)現(xiàn)兩種類(lèi)型：IAuthorRepository接口和AuthorRepository類(lèi)。我們將使用這些類(lèi)型在我們的最小API中實(shí)現(xiàn)依賴(lài)性注入。

創(chuàng)建一個(gè)名為IAuthorRepository.cs的新文件并插入以下代碼：

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

AuthorRepository類(lèi)實(shí)現(xiàn)了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);
        }
    }

在最小的網(wǎng)絡(luò)API中注入一個(gè)自定義接口

下面的代碼片段說(shuō)明了你如何注入IAuthorRepository接口的實(shí)例：

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包括一個(gè)偉大的新功能--全局使用指令。為了利用全局使用，創(chuàng)建一個(gè)名為Usings.cs的新文件，并將你所有的使用語(yǔ)句移到那里。你可以在你的ASP.NET Core 6或最小的API中使用這一功能，更多關(guān)于ASP.NET Core 6 API日志DI的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論