使用.NET 6开发TodoList应用(1)——系列背景

前言

想到要写这样一个系列博客，初衷有两个：一是希望通过一个实践项目，将.NET 6 WebAPI开发的基础知识串联起来，帮助那些想要入门.NET 6服务端开发的朋友们快速上手，对使用.NET 6开发后端服务的技术全貌有一个基本的认识和掌握，顺便把自己的技能树检查一遍；二是希望为国内的.NET环境有一些小小的帮助，最早我自己是做C#桌面应用出身的，但是随着互联网产业的繁盛和微软早年间的固执，使得国内的.NET开发环境收缩到几个固定的领域，以致于很多人今天依然认为C#和.NET不适合做大型的企业级应用，这个观念需要改变了。我无意比较技术和语言之间的好坏，只是更愿意看到国内的技术环境也能呈现出百家争鸣的状态。经过微软这么多年的改变和进步，.NET 6是一个很优秀的框架，这一点自从我最开始接触.NET Core 2起一年一年进化到现在，就深切地感受到，那好东西就拿出来和大家分享一下。

系列说明

在这个系列博客中，我将会使用.NET 6从头开始一步一步开发一个TodoList单体应用，在这个过程中尽可能将多的知识点独立成每篇文章，最后将应用通过Docker进行打包，并使用Github的Action和Azure Container Instance服务实现CI/CD。

选择TodoList的原因是这个项目足够简单，但是也足够去覆盖我希望覆盖到的知识点，对于读者来说，有以下一些建议的前置要求：

• 需要会写C#，不需要.NET (Core)相关的开发经验。
• 需要后端服务的开发经验，对基本的服务端相关特性有一定的认识。
• 有对Clean Architecture的基本理解。

从下一篇文章开始，我们将从需求入手，通过大概30篇左右的文章来实现这个TodoList应用。

系列导航

• 使用.NET 6开发TodoList应用(1)——系列背景
• 使用.NET 6开发TodoList应用(2)——项目结构搭建
• 使用.NET 6开发TodoList应用(3)——引入第三方日志
• 使用.NET 6开发TodoList应用(4)——引入数据存储
• 使用.NET 6开发TodoList应用(5)——领域实体创建
• 使用.NET 6开发TodoList应用(5.1)——实现Repository模式
• 使用.NET 6开发TodoList应用(6)——实现POST请求
• 使用.NET 6开发TodoList应用(6.1)——实现CQRS模式
• 使用.NET 6开发TodoList应用(6.2)——实现AutoMapper
• 使用.NET 6开发TodoList应用(7)——实现GET请求
• 使用.NET 6开发TodoList应用(8)——实现全局异常处理
• 使用.NET 6开发TodoList应用(9)——实现PUT请求
• 使用.NET 6开发TodoList应用(10)——实现PATCH请求
• 使用.NET 6开发TodoList应用(11)——HTTP请求幂等性的考虑
• 使用.NET 6开发TodoList应用(12)——实现接口请求验证
• 使用.NET 6开发TodoList应用(13)——实现ActionFilter
• 使用.NET 6开发TodoList应用(14)——实现查询分页
• 使用.NET 6开发TodoList应用(15)——实现查询过滤
• 使用.NET 6开发TodoList应用(16)——实现查询搜索
• 使用.NET 6开发TodoList应用(17)——实现查询排序
• 使用.NET 6开发TodoList应用(18)——实现数据塑形
• 使用.NET 6开发TodoList应用(19)——实现HATEAOS支持
• 使用.NET 6开发TodoList应用(20)——处理OPTION和HEAD请求
• 使用.NET 6开发TodoList应用(21)——实现Root Document
• 使用.NET 6开发TodoList应用(22)——实现API版本控制
• 使用.NET 6开发TodoList应用(23)——实现缓存
• 使用.NET 6开发TodoList应用(24)——实现请求限流和阈值控制
• 使用.NET 6开发TodoList应用(25)——实现基于JWT的Identity功能
• 使用.NET 6开发TodoList应用(26)——实现RefreshToken
• 使用.NET 6开发TodoList应用(27)——实现Configuration和Option的强类型绑定
• 使用.NET 6开发TodoList应用(28)——实现API的Swagger文档化
• 使用.NET 6开发TodoList应用(29)——实现应用程序健康检查
• 使用.NET 6开发TodoList应用(30)——实现本地化功能
• 使用.NET 6开发TodoList应用(31)——实现Docker打包和部署
• 使用.NET 6开发TodoList应用(32)——实现基于Github Actions和ACI的CI/CD

附：.NET 6 Web API项目代码上的变化

创建项目

mkdir ProjectName && cd ProjectName
dotnet new sln -n SampleApi
dotnet new project -f net6.0 -n SampleApi -o SampleApi
dotnet sln SampleApi.sln add SampleApi/SampleApi.csproj
dotnet restore
dotnet run -p SampleApi/SampleApi.csproj

.NET 6 WebAPI Program.cs的变更

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();

Change 1: Top-level statements

顶级声明使得我们在编写Program类时可以不用再定义该类，省略Main函数定义，直接开始写方法体。编译器会在编译阶段为我们自动加上命名空间和相关定义。

Change 2: Implicit using directives

隐式using指令是编译器根据项目类型，在编译阶段自动生成一个名为

CompanyEmployees.GlobalUsings.g.cs

的文件，内容如下：

// <auto-generated/>
global using global::Microsoft.AspNetCore.Builder;
global using global::Microsoft.AspNetCore.Hosting;
global using global::Microsoft.AspNetCore.Http;
global using global::Microsoft.AspNetCore.Routing;
global using global::Microsoft.Extensions.Configuration;
global using global::Microsoft.Extensions.DependencyInjection;
global using global::Microsoft.Extensions.Hosting;
global using global::Microsoft.Extensions.Logging;
global using global::System;
global using global::System.Collections.Generic;
global using global::System.IO;
global using global::System.Linq;
global using global::System.Net.Http;
global using global::System.Net.Http.Json;
global using global::System.Threading;
global using global::System.Threading.Tasks;

也可以在

CompanyEmployees.csproj

工程配置文件中修改以下属性，禁用全局隐式using指令这一特性：

<!-- <ImplicitUsings>enable</ImplicitUsings> -->
<ImplicitUsings>disable</ImplicitUsings>

Change 3: No Startup class

到了.NET 6，陪伴我们好几个版本至今的

ConfigureServices

and

Configure

方法终于消失了，取而代之的是这两部分的配置都集中在了

Program.cs

中。曾经写过

.NET Core WebAPI

的小伙伴不难看出来现在应该写在哪里。

对于一些大型项目来说，这两部分我们肯定不能就这样写在

Program.cs

里面，后面将会想办法把这两部分单独拆开进行配置。

当然，老版本的含有

Startup.cs

的项目在.NET 6下打开没有任何问题。

关于Pipeline的一些知识点

Pipeline Sequence

1. ExceptionHandler
2. HSTS
3. HttpsRedirection
4. Static Files
5. Routing
6. CORS
7. Authentication
8. Authorization
9. Custom Middlewares
10. Endpoint Configuration

app.Run和app.Use

app.Run

用于终止Pipeline的链式调用并向客户端返回

public static void Run(this IApplicationBuilder app, RequestDelegate handler);
public delegate Task RequestDelegate(HttpContext context);

app.Use

用于向Pipeline中插入一段逻辑作为链式调用的其中一个环节

public static IApplicationBuilder Use(this IApplicationBuilder app, Func<HttpContext,
Func<Task>, Task> middleware);

app.Map和app.MapWhen

这两个方法都是用于在middleware的链式调用中进行分支Pipeline调用链处理。

public static IApplicationBuilder Map(this IApplicationBuilder app, PathString
pathMatch, Action<IApplicationBuilder> configuration)

public static IApplicationBuilder MapWhen(this IApplicationBuilder app,
Func<HttpContext, bool> predicate, Action<IApplicationBuilder> configuration)

app.MapGet、app.MapPost、app.MapPut、app.Delete、app.MapMethods

在.NET 6中一个新增的特性叫做

Minimal APIs

，允许应用程序以这种形式响应客户端的请求，在快速构建微服务应用的过程中十分好用，在这个系列里，因为构建的是一个单体应用，这部分知识点我打算放到第二个系列关于微服务开发实践中去，看有没有更合适的场景去展示。