ASP.NET Core 6最小API中使用日志和DI示例详解

目录
  • 在ASP.NET Core 6的最小API中使用日志和DI
    • 如何在ASP.NET Core 6的最小API中实现日志、从配置系统中读取并使用依赖注入
    • CI/CD?持续集成和持续交付解释
  • 在Visual Studio 2022中创建一个ASP.NET Core minimal web API项目
  • 运行一个最小的网络API
  • 为一个最小的网络API配置多个端口
  • 在最小的Web API中使用日志记录
  • 在最小的API中从配置系统中读取
  • 在最小的网络API中使用依赖性注入
    • 在一个最小的Web API中注入一个自定义类
    • 在最小的网络API中注入一个自定义接口

在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("/", () => "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中使用这一功能,更多关于ASP.NET Core 6 API日志DI的资料请关注我们其它相关文章!

(0)

相关推荐

  • ASP.NET Core之Web API介绍

    目录 1.简单介绍 2.自定义格式化(Format) 1.特定格式的操作结果 2.配置格式化程序 3.添加对 XML 格式的支持 4.强制特定格式化 5.响应格式 URL 映射 6.自定义格式化程序 Protocol Buffers (简称 protobuf) 1.简单介绍 ASP.NET Core Web API 是 ASP.NET Core MVC 的一个功能.ASP.NET Core MVC 包含了对 Web API 的支持.可以构建多种客户端的 HTTP 服务.ASP.NET Core

  • ASP.NET Core在WebApi项目中使用Cookie

    目录 一.Cookie的作用 二.在ASP.NET Core中使用Cookie 1.在控制器中直接使用Cookie 1.1.设置Cookie 1.2.获取Cookie 1.3.删除Cookie信息 2.封装Cookie 一.Cookie的作用 Cookie通常用来存储有关用户信息的一条数据,可以用来标识登录用户,Cookie存储在客户端的浏览器上.在大多数浏览器中,每个Cookie都存储为一个小文件.Cookie表示为键/值对的形式,可以利用键来读取.写入或删除Cookie. 在ASP.NET

  • asp.net core webapi文件上传功能的实现

    最近开发一个新项目,使用了asp.net core 2.0,采用webapi开发后台,postgresql为数据库.最先来的问题就是上传文件的问题. POST文件的一些坑 使用默认模板创建webapi的controller后,post请求,默认有 // POST api/values [HttpPost] public void Post([FromBody]string value) { } 请求使用了[FromBody]标记,用来指示用请求体里获得数据. 对于文件上传请求,直接在这个Post

  • ASP.NET Core 2.0 WebApi全局配置及日志实例

    最新在将原来写的一些webSerivce转换为WebApi,直接就用了ASP.Net Core 2.0的框架,在使用中,发现的与原有的asp.net不同的地方,通过搜索已经慢慢解决,记录下来备用. 一.全局配置 在asp.net中,全局变更配置写在web.config中,如下所示 <?xml version="1.0"?> <configuration> <connectionStrings> <add name="conn"

  • ASP.NET Core中引用OpenAPI服务添加示例

    目录 文章目录 前言:一.将 Swagger 引入 WebAPI 项目二.添加 OpenAPI 服务引用参考文档 前言: 本文使用 .NET Core SDK 3.1 的版本.在我们使用微服务的时候,各个微服务之间会经常调用接口,但是手动写Http请求的代码非常繁琐,在 Visual Studio 2019 的 .NET Core 项目中提供了添加连接的服务的功能,使得我们的工作变得简单容易. 一.将 Swagger 引入 WebAPI 项目 将 Swagger 引入 ASP.NET Core

  • 详解ASP.NET Core Web Api之JWT刷新Token

    前言 如题,本节我们进入JWT最后一节内容,JWT本质上就是从身份认证服务器获取访问令牌,继而对于用户后续可访问受保护资源,但是关键问题是:访问令牌的生命周期到底设置成多久呢?见过一些使用JWT的童鞋会将JWT过期时间设置成很长,有的几个小时,有的一天,有的甚至一个月,这么做当然存在问题,如果被恶意获得访问令牌,那么可在整个生命周期中使用访问令牌,也就是说存在冒充用户身份,此时身份认证服务器当然也就是始终信任该冒牌访问令牌,若要使得冒牌访问令牌无效,唯一的方案则是修改密钥,但是如果我们这么做了,

  • ASP.NET Core 6最小API中使用日志和DI示例详解

    目录 在ASP.NET Core 6的最小API中使用日志和DI 如何在ASP.NET Core 6的最小API中实现日志.从配置系统中读取并使用依赖注入 CI/CD?持续集成和持续交付解释 在Visual Studio 2022中创建一个ASP.NET Core minimal web API项目 运行一个最小的网络API 为一个最小的网络API配置多个端口 在最小的Web API中使用日志记录 在最小的API中从配置系统中读取 在最小的网络API中使用依赖性注入 在一个最小的Web API中

  • ASP.NET Core扩展库之Http通用扩展库的使用详解

    本文将介绍Xfrogcn.AspNetCore.Extensions扩展库对于Http相关的其他功能扩展,这些功能旨在处理一些常见需求, 包括请求缓冲.请求头传递.请求头日志范围.针对HttpClient与HttpRequestMessage.HttpResponseMessage的扩展方法. 一.开启服务端请求缓冲 ASP.NET Core 中请求体是不能多次读取的,由于在MVC中,框架已经读取过请求体,如果你在控制器中再次读取,将会引发异常,如下示例: [ApiController] [Ro

  • C#面向对象编程中依赖反转原则的示例详解

    在面向对象编程中,SOLID 是五个设计原则的首字母缩写,旨在使软件设计更易于理解.灵活和可维护.这些原则是由美国软件工程师和讲师罗伯特·C·马丁(Robert Cecil Martin)提出的许多原则的子集,在他2000年的论文<设计原则与设计模式>中首次提出. SOLID 原则包含: S:单一功能原则(single-responsibility principle) O:开闭原则(open-closed principle) L:里氏替换原则(Liskov substitution pri

  • Go语言中的字符串处理方法示例详解

    1 概述 字符串,string,一串固定长度的字符连接起来的字符集合.Go语言的字符串是使用UTF-8编码的.UTF-8是Unicode的实现方式之一. Go语言原生支持字符串.使用双引号("")或反引号(``)定义. 双引号:"", 用于单行字符串. 反引号:``,用于定义多行字符串,内部会原样解析. 示例: // 单行 "心有猛虎,细嗅蔷薇" // 多行 ` 大风歌 大风起兮云飞扬. 威加海内兮归故乡. 安得猛士兮守四方! ` 字符串支持转义

  • C++中#include头文件的示例详解

    fstream是C++ STL中对文件操作的合集,包含了常用的所有文件操作.在C++中,所有的文件操作,都是以流(stream)的方式进行的,fstream也就是文件流file stream. 最常用的两种操作为: 1.插入器(<<) 向流输出数据.比如说打开了一个文件流fout,那么调用fout<<"Write to file"<<endl;就表示把字符串"Write to file"写入文件并换行. 2.析取器(>>

  • Python中bisect的用法及示例详解

    bisect是python内置模块,用于有序序列的插入和查找. 查找: bisect(array, item) 插入: insort(array,item) 查找 import bisect a = [1,4,6,8,12,15,20] position = bisect.bisect(a,13) print(position) # 用可变序列内置的insert方法插入 a.insert(position,13) print(a) 输出: 5 [1, 4, 6, 8, 12, 13, 15, 2

  • Python中三种花式打印的示例详解

    目录 1. 引言 2. 打印圣诞树 2.1 问题描述 2.2 问题分析 3. 打印字母版圣诞树 3.1 问题描述 3.2 问题分析 4. 打印字母版菱形 4.1 问题描述 4.2 问题分析 5. 总结 1. 引言 在Python中有很多好玩的花式打印,对厉害的高手来说可能是小菜一碟,对入门的小白来说往往让人望而退步,我们今天就来挑战下面三个常见的花式打印吧... 2. 打印圣诞树 2.1 问题描述 编码实现函数christmas_tree(height),该函数输入参数为一个整数表示圣诞树的高度

  • 详解Python中生成随机数据的示例详解

    目录 随机性有多随机 加密安全性 PRNG random 模块 数组 numpy.random 相关数据的生成 random模块与NumPy对照表 CSPRNG 尽可能随机 os.urandom() secrets 最佳保存方式 UUID 工程随机性的比较 在日常工作编程中存在着各种随机事件,同样在编程中生成随机数字的时候也是一样,随机有多随机呢?在涉及信息安全的情况下,它是最重要的问题之一.每当在 Python 中生成随机数据.字符串或数字时,最好至少大致了解这些数据是如何生成的. 用于在 P

  • Go语言中循环语句使用的示例详解

    目录 一.概述 1. 循环控制语句 2. 无限循环 二.Go 语言 for 循环 1. 语法 2. for语句执行过程 3. 示例 4. For-each range 循环 三.循环嵌套 1. 语法 2. 示例 四.break 语句 1. 语法 2. 示例 五. continue 语句 1. 语法 2. 示例 六.goto 语句 1. 语法 2. 示例 一.概述 在不少实际问题中有许多具有规律性的重复操作,因此在程序中就需要重复执行某些语句. 循环程序的流程图: Go 语言提供了以下几种类型循环

  • Python中字典常用操作的示例详解

    目录 前言 初始化 合并字典 字典推导式 Collections 标准库 字典转 JSON 字典转 Pandas 前言 字典是Python必用且常用的数据结构,本文梳理常用的字典操作,看这个就够了,涉及: 初始化 合并字典 字典推导式 Collections 标准库 字典转JSON 字典转Pandas 初始化 # 最常用这种 my_object = { "a": 5, "b": 6 } # 如果你不喜欢写大括号和双引号: my_object = dict(a=5,

随机推荐