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

如何在ASP.NET Core 6的最小API中实现日志、从配置系统中读取并使用依赖注入

ASP.NET Core 6引入了一个简化的托管模型,可用于实现具有最小依赖性的轻量级API。这些最小的API极大地减少了你需要编写的模板代码,以使你的ASP.NET Core 6应用程序启动和运行。

我们在之前的文章中讨论了如何开始使用最小API。在这篇文章中,我们将探讨最小化API的更多高级方面,包括实现日志、从配置系统中读取以及使用依赖性注入。

要使用本文提供的代码示例,你的系统中应该安装有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项目:

  1. 启动Visual Studio 2022 IDE
  2. 点击 “创建新项目”
  3. 在 “创建新项目 “窗口,从显示的模板列表中选择 “ASP.NET Core Web API”
  4. 点击 “下一步”
  5. 在 “配置你的新项目 “窗口中,指定新项目的名称和位置
  6. 根据你的喜好,可以选择勾选 “将解决方案和项目放在同一目录下 “复选框
  7. 点击 “下一步”
  8. 在接下来显示的 “附加信息 “窗口中,取消勾选 “使用控制器… “的复选框,因为在这个例子中我们将使用最小的API。将 “验证类型 “保留为 “无”(默认)
  9. 确保 “启用Docker”、”为HTTPS配置 “和 “启用开放API支持 “的复选框不被选中,因为我们不会在这里使用任何这些功能
  10. 点击创建

这将在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("/", () => "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("/", () => "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) => "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中使用这一功能。

我将在以后的文章中对最小的API有更多的介绍(例如与安全和中间件的合作)。

作者:DebugUsery
链接:https://juejin.cn/post/7126523723762696228

给TA打赏
共{{data.count}}人
人已打赏
.Net Core

如何在 ASP.NET Core 中使用 Quartz.NET 执行任务调度

2022-7-29 18:59:42

.Net Core

ASP.NET CORE 配置选项

2022-8-2 15:22:33

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
今日签到
有新私信 私信列表
搜索