🔍
📢

ASP.NET Core 3.0 新增功能(翻译自官网文档)

ASP.NET Core 3.0 的新增功能

全文翻译自微软官方文档英文版 What's new in ASP.NET Core 3.0

本文重点介绍了 ASP.NET Core 3.0 中最重要的更改,并提供相关文档的连接。

Blazor

Blazor 是 ASP.NET Core 中的一个新的框架,用于使用 .NET 构建交互式的客户端 Web UI:

  • 使用 C# 而不是 JavaScript 创建丰富的交互式 UI。
  • 共享用 .NET 编写的服务器端和客户端应用程序逻辑。
  • 将 UI 渲染为 HTML 和 CSS,以提供广泛的浏览器支持,包括移动浏览器。

Blazor 框架支持的场景:

  • 可重用的 UI 组件(Razor 组件)
  • 客户端路由
  • 组件布局
  • 对依赖注入的支持
  • 表单与验证
  • 使用 Razor 类库构建组件库
  • JavaScript 互操作

有关更多信息,请参阅:ASP.NET Core 中的 Blazor 简介

Blazor Server

Blazor 将组件渲染逻辑与 UI 更新的逻辑进行了解耦。Blazor Server 支持在服务器上的 ASP.NET Core 应用程序中承载 Razor 组件。UI 的更新通过一个 SignalR 连接进行处理。Blazor Server 在 ASP.NET Core 3.0 中受支持。

Blazor WebAssembly (预览)

Blazor 应用程序也可以使用基于 WebAssembly 的 .NET 运行时直接在浏览器中运行。Blazor WebAssembly 在 ASP.NET Core 3.0 中处于预览状态,且不受支持。未来的 ASP.NET Core 版本将支持 Blazor WebAssembly。

Razor 组件

Blazor 应用程序是由组件 (components) 构建而成的。组件是自包含的用户界面元素,例如页面、对话框或者表单等。组件是普通的 .NET 类,用于定义 UI 呈现逻辑和客户端事件处理程序。您可以创建没有 JavaScript 的富交互式 Web 应用程序。

Blazor 中的组件通常使用 Razor 语法编写,它是 HTML 和 C# 的自然融合。Razor 组件与 Razor Pages(页面)和 MVC 视图 (view) 相似,因为它们都使用 Razor。与基于“请求-响应”模型的页面与视图不同,组件专门用于处理 UI 合成。

gRPC

gRPC

  • 是一种流行的高性能 RPC(远程过程调用)框架。
  • 为 API 开发提供了一种“契约优先“的方式。
  • 使用各种现代的技术,例如:
    • 通过 HTTP/2 传输
    • 使用 Protocol Buffers 作为接口描述语言
    • 二进制序列化格式
  • 提供以下功能:
    • 身份验证
    • 双向的数据流与流程控制
    • 取消与超时

ASP.NET Core 3.0 中的 gRPC 功能包括:

  • Grpc.AspNetCore — 一个用于承载 gRPC 服务的 ASP.NET Core 框架。ASP.NET Core 上的 gRPC 能够与日志记录、依赖注入 (DI) 身份验证和授权等标准的 ASP.NET Core 功能集成在一起。
  • Grpc.Net.Client — 一个面向 .NET Core,构建在 HttpClient 上的 gRPC 客户端。
  • Grpc.Net.ClientFactory — 用于将 gRPC 客户端与 HttpClientFactory 集成。

有关更多信息,参见:ASP.NET Core 上 gRPC 的简介

SignalR

请参见更新 Signal 代码以获取迁移说明。SignalR 现在使用 System.Text.Json 来序列化/反序列化 JSON 消息。有关还原为基于 Newtonsoft.Json 的序列化程序的说明,请参阅切换到 Newtonsoft.Json

在 SignalR 的 JavaScript 和 .NET 客户端中,添加了对自动重新连接的支持。默认情况下,客户端尝试自动重新连接,并在 2, 10 和 30 秒后(如有必要)重试。如果客户端成功重新连接,它将受到一个新的连接 ID。自动重新连接是选择性加入的:

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .withAutomaticReconnect()
    .build();

可以通过传递基于毫秒的持续时间数组来指定重新连接间隔:

.withAutomaticReconnect([0, 3000, 5000, 10000, 15000, 30000])
//.withAutomaticReconnect([0, 2000, 10000, 30000]) 默认时间间隔

可以传入自定义实现以完全控制重新连接间隔。

如果在上次重新连接间隔之后重新连接失败,则:

  • 客户端认为连接已离线。
  • 客户端停止尝试重新连接。

为了在连接中断时提供 UI 反馈,SignalR 客户端 API 已扩展为包括以下事件处理程序:

  • onreconnecting: 为开发人员提供了禁用 UI 或告知用户该应用程序处于脱机状态的机会。
  • onreconnected: 重新建立连接后,使开发人员有机会更新 UI。

以下代码在尝试连接时使用 onreconnecting 更新 UI:

connection.onreconnecting((error) => {
    const status = `Connection lost due to error "${error}". Reconnecting.`;
    document.getElementById("messageInput").disabled = true;
    document.getElementById("sendButton").disabled = true;
    document.getElementById("connectionStatus").innerText = status;
});

以下代码在连接恢复时使用 onreconnected 更新 UI:

connection.onreconnected((connectionId) => {
    const status = `Connection reestablished. Connected.`;
    document.getElementById("messageInput").disabled = false;
    document.getElementById("sendButton").disabled = false;
    document.getElementById("connectionStatus").innerText = status;
});

当 hub 方法需要授权时,SignalR 3.0 及更高版本为授权处理程序提供自定义资源。该资源是 HubInvocationContext 的实例。HubInvocationContext 包括:

  • HubCallerContext
  • 正在调用的 hub 方法的名称。
  • hub 方法的参数。

考虑以下聊天室应用程序示例,该应用程序允许通过 Azure Active Directory 进行多个组织登录。 具有 Microsoft 账户的任何人都可以登录聊天,但只有所属组织的成员可以禁止用户或查看用户的聊天记录。 该应用可以限制特定用户的某些功能。

public class DomainRestrictedRequirement :
    AuthorizationHandler<DomainRestrictedRequirement, HubInvocationContext>,
    IAuthorizationRequirement
{
    protected override Task HandleRequirementAsync(
        AuthorizationHandlerContext context,
        DomainRestrictedRequirement requirement,
        HubInvocationContext resource)
    {
        if (context.User?.Identity?.Name == null)
        {
            return Task.CompletedTask;
        }

        if (IsUserAllowedToDoThis(
                resource.HubMethodName,
                context.User.Identity.Name))
        {
            context.Succeed(requirement);
        }

        return Task.CompletedTask;
    }

    private bool IsUserAllowedToDoThis(string hubMethodName, string currentUsername)
    {
        if (hubMethodName.Equals("banUser",
            StringComparison.OrdinalIgnoreCase))
        {
            return currentUsername.Equals(
                "bob42@jabbr.net",
                StringComparison.OrdinalIgnoreCase);
        }

        return currentUsername.EndsWith(
                "@jabbr.net",
                StringComparison.OrdinalIgnoreCase));
    }
}

在前面的代码中,DomainRestrictedRequirement 用作自定义 IAuthorizationRequirement。由于传递了 HubInvocationContext 资源,因此内部逻辑可以:

  • 检查正在调用 hub 的上下文。
  • 决定是否允许用户执行特定的 hub 方法。

可以使用策略名称来修饰各个 hub 方法,代码会在运行时进行检查。当客户端尝试调用各个 hub 方法时,DomainRestrictedRequirement 处理程序将会运行并控制对方法的访问。基于 DomainRestrictedRequirement 控制访问的方式:

  • 所有已登录用户都可以调用 SendMessage 方法。
  • 只有使用 @jabbr.net 电子邮件地址登录的用户才能查看用户的历史记录。
  • 只有 bob42@jabbr.net 可以禁止用户进入聊天室。
[Authorize]
public class ChatHub : Hub
{
    public void SendMessage(string message)
    {
    }

    [Authorize("DomainRestricted")]
    public void BanUser(string username)
    {
    }

    [Authorize("DomainRestricted")]
    public void ViewUserHistory(string username)
    {
    }
}

创建 DomainRestricted 策略可能涉及:

  • Startup.cs 中添加新策略。
  • 将自定义的 DomainRestrictedRequirement 需求作为参数提供。
  • 使用授权中间件注册 DomainRestricted
services
    .AddAuthorization(options =>
    {
        options.AddPolicy("DomainRestricted", policy =>
        {
            policy.Requirements.Add(new DomainRestrictedRequirement());
        });
    });

SignalR hub 使用终结点路由。SignalR hub 连接先前已显式地完成:

app.UseSignalR(routes =>
{
    routes.MapHub<ChatHub>("hubs/chat");
});

在以前的版本中,开发人员需要在各个不同的位置启用控制器、Razor 页面和 SignalR hub。显式的连接导致一系列几乎相同的路由片段:

app.UseSignalR(routes =>
{
    routes.MapHub<ChatHub>("hubs/chat");
});

app.UseRouting(routes =>
{
    routes.MapRazorPages();
});

SignalR 3.0 hub 可以通过终结点路由进行路由。使用终结点路由,通常可以在 UseRouting 中配置所有的路由:

app.UseRouting(routes =>
{
    routes.MapRazorPages();
    routes.MapHub<ChatHub>("hubs/chat");
});

ASP.NET Core 3.0 SignalR 添加了:

客户端到服务器的流。通过客户端到服务器的流传输,服务器端方法可以采用 IAsyncEnumerable<T> 或者 ChannelReader<T> 的实例。在以下 C# 实例中,hub 上的 UploadStream 方法将从客户端接收字符串流:

public async Task UploadStream(IAsyncEnumerable<string> stream)
{
    await foreach (var item in stream)
    {
        // 处理流中的内容
    }
}

.NET 客户端应用程序可以将一个 IAsyncEnumerable<T> 或者 ChannelReader<T> 的实例作为上述 UploadStream hub 方法的 stream 参数进行传递。

for 循环完成,且本地函数退出之后,将流完成发送(After the for loop has completed and the local function exits, the stream completion is sent):

async IAsyncEnumerable<string> clientStreamData()
{
    for (var i = 0; i < 5; i++)
    {
        var data = await FetchSomeData();
        yield return data;
    }
}

await connection.SendAsync("UploadStream", clientStreamData());

JavaScript 客户端应用将 SignalR Subject (或者一个 RxJS Subject) 用于上述 UploadStream hub 方法的 stream 参数。

let subject = new signalR.Subject();
await connection.send("StartStream", "MyAsciiArtStream", subject);

当 JavaScript 代码捕获到字符串并准备将其发送到服务器时,它可以使用 subject.next 方法来处理字符串。

subject.next("example");
subject.complete();

使用类似前面两个代码段的代码,可以创建实时流式传输体验。

新的 JSON 序列化

现在默认情况下,ASP.NET Core 3.0 使用 System.Text.Json 进行 JSON 序列化:

  • 异步读取和写入 JSON。
  • 针对 UTF-8 文本进行了优化。
  • 通常会比 Newtonsoft.Json 具有更高的性能。

要将 Json.NET 添加到 ASP.NET Core 3.0 请参阅添加基于 Newtonsoft.Json 的 JSON 格式支持

新的 Razor 指令

以下列表包含了新的 Razor 指令:

  • @attribute@attribute 指令将给定属性应用于生成页面或者视图的类。例如:@attribute [Authorize]
  • @implements@implements 指令为生成的类实现一个接口。例如:@implements IDisposable

证书与 Kerberos 身份验证

证书身份验证要求:

  • 配置服务器以接收证书。
  • Startup.Configure 中添加身份验证中间件。
  • Startup.ConfigureServices 中添加证书身份验证服务。
public void ConfigureServices(IServiceCollection services)
{
    services.AddAuthentication(
        CertificateAuthenticationDefaults.AuthenticationScheme)
            .AddCertificate();
    // 其他服务配置已移除。
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseAuthentication();
    // 其他应用配置已移除。
}

证书身份验证的选项 (Options) 提供以下功能:

  • 接受自签名证书。
  • 检查证书吊销。
  • 检查提供的证书是否具有正确的使用标志。

默认的用户主体 (user principal) 是根据证书属性构建的。用户主体包含一个事件。通过相应该事件,可以补充或者替换该主体。有关更多信息,请参见在 ASP.NET Core 中配置证书身份验证

Windows 身份验证 已扩展到了 Linux 和 macOS 上。在以前的版本中,Windows 身份验证仅限于 IISHttpSys。在 ASP.NET Core 3.0 中,Kestrel 能够在 Windows, Linux 和 macOS 上为加入了 Windows 域的主机使用 Negotiate(协商), KerberosNTLM。Kestrel 对这些身份验证架构的支持由 Microsoft.AspNetCore.Authentication.Negotiate NuGet 包提供。与其他身份验证服务一样,在用用程序范围内配置身份验证,然后配置服务:

public void ConfigureServices(IServiceCollection services)
{
    services.AddAuthentication(NegotiateDefaults.AuthenticationScheme)
        .AddNegotiate();
    // 其他服务配置已移除。
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseAuthentication();
    // 其他应用配置已移除。
}

主机要求:

  • Windows 主机必须将服务主体名称 (SPN) 添加到承载该应用程序的用户账户中。
  • Linux 和 macOS 主机必须加入域。
    • 必须为 Web 进程创建 SPN。
    • 必须在主机上生成和配置密钥表文件

有关更多信息,请参见在 ASP.NET Core 中配置 Windows 身份验证

模板变更

Web UI 模板(Razor Pages, 带有控制器和视图的 MVC)已删除以下内容:

Angular 模板已更新为使用 Angular 8。

默认情况下,Razor 类库 (RCL) 模板默认为用于 Razor 组件开发。Visual Studio 中新的模板选项为页面和视图提供模板支持。在命令行中从模板创建 RCL 时,请传入 -support-pages-and-views 选项 (dotnet new razorclasslib -support-pages-and-views)。

通用主机

ASP.NET Core 3.0 模板使用 .NET 通用主机。以前的版本使用 WebHostBuilder。使用 .NET Core 通用主机(HostBuilder),可以更好地将 ASP.NET Core 应用程序与其他非特定与 Web 的服务器方案集成。有关更多信息,请参见 HostBuilder 替换 WebHostBuilder

主机配置

在发布 ASP.NET Core 3.0 之前,带有 ASPNETCORE_ 前缀的环境变量会被加载,用于 Web 主机的主机配置。在 3.0 中,AddEvironmentVariables 用于加载带有 DOTNET_ 以前追的环境变量,以使用 CreateDefaultBuilder 进行主机配置。

Startup 构造函数注入的更改

通用主机仅支持一下类型的 Startup 构造函数注入:

仍然可以将所有服务以参数的形式直接注入 Startup.Configure 方法,参见 通用主机限制 Startup 构造函数注入 (aspnet/Announcements #353).

Kestrel

  • 为了迁移到通用主机,Kestrel 配置已更新。在 3.0 中,Kestrel 在 ConfigureWebHostDefaults 提供的 Web 主机构建器 (host builder) 上进行配置。
  • 连接适配器 (Connection Adapter) 已从 Kestrel 中删除,并由连接中间件代替 (Connection Middleware)。该中间件类似于 ASP.NET Core 管道中的 HTTP 中间件,但用于较低级别的连接。
  • Kestrel 传输层已在 Connections.Abstractions 中作为公共接口公开。
  • 标头 (header) 和尾部 (trailer) 之间的歧义已通过将尾部标头 (trailing header) 移动到新的集合来解决。
  • 同步 IO API(例如 HttpRequest.Body.Read)是引起线程饥饿进而导致程序崩溃的常见原因。在 3.0 中,默认情况下 AllowSynchronousIO 被禁用。

有关更多信息,请参见Kestrel - 从 ASP.NET Core 2.2 迁移到 3.0

默认启用 HTTP/2

默认情况下,Kestrel 中为 HTTPS 端点启用了 HTTP/2。当操作系统支持时,对 IIS 或者 HTTP.sys 的 HTTP/2 的支持将被启用。

请求计数器

Hosting EventSource (Microsoft.AspNetCore.Hosting) 发出与传入请求有关的以下 EventCounter:

  • requests-per-second
  • total-requests
  • current-requests
  • failed-requests

终结点路由

终结点路由得到了增强,该路由使各种框架(例如 MVC)可以与中间件更好地协同工作:

  • 中间件和终结点的顺序可以在 Startup.Configure 的请求处理管道中进行配置。
  • 终结点和中间件与其他基于 ASP.NET Core 的技术(例如运行状况检查)进行良好的编排。
  • 终结点可以在中间件和 MVC 中实现各种策略,例如 CORS 或者授权等。
  • 过滤器和特性 (attribute) 可以被放置在控制器的方法上。

有关更多信息,请参见 ASP.NET Core 中的路由

运行状况检查

运行状况检查通过通用主机使用终结点路由。在 Startup.Configure 中,使用终结点 URL 或者相对路径,在终结点构建器上调用 MapHealthChecks

app.UseEndpoints(endpoints =>
{
    endpoints.MapHealthChecks("/health");
});

运行状况检查终结点可以:

  • 指定一个或多个允许的主机/端口。
  • 要求授权。
  • 要求 CORS。

有关更多信息,请参见以下文章:

HttpContext 上的管道

现在可以使用 System.IO.Pipelines API 读取请求正文并写入响应正文。HttpRequest.BodyReader 属性提供了一个 PipeReader,可以用于读取请求正文;HttpResponse.BodyWriter 属性提供了一个 PipeWriter,可以用于写入响应正文。HttpRequest.BodyReaderHttpRequest.Body 流的相似物; HttpResponse.BodyWriterHttpResponse.Body 流的相似物。

IIS 中改进了的错误报告

现在,在 IIS 中托管 ASP.NET Core 应用程序时的启动错误会生成更丰富的诊断数据。这些错误会在适用的情况下使用堆栈跟踪,报告给 Windows 事件日志。此外,所有的警告、错误和未处理的异常,都会记录到 Windows 事件日志中。

服务角色服务和辅助角色 SDK

.NET Core 3.0 引入了新的辅助角色服务 (Worker Service) 应用模板。该模板是在 .NET Core 中编写长时间运行的服务的起点。

有关更多信息,请参见:

Forwarded 标头中间件的改进

在早期版本的 ASP.NET Core 中,应用在部署到 Azure Linux 或者除 IIS 之外的任何反向代理之后,调用 UseHstsUseHttpsRedirection 都是有问题的。转发 Linux 和非 IIS 反向代理的方案中介绍了以前版本的修复方式。

此场景已在 ASP.NET Core 3.0 中修复。当 ASPNETCORE_FORWARDEDHEADERS_ENABLED 环境变量设置为 true 时,主机将启用 Forwarded 标头中间件。在 ASP.NET Core 的容器镜像中,ASPNETCORE_FORWARDEDHEADERS_ENABLED 已被设置为 true

性能提升

ASP.NET Core 3.0 包括许多改进,可以减少内存使用并提高吞吐量:

  • 在将内置的依赖注入容器用于 scoped 服务时,减少内存的使用量。
  • 减少整个框架的内存分配,包括中间件的各类场景和路由。
  • 减少 WebSocket 连接的内存使用量。
  • 减少 HTTPS 连接的内存使用量,并提高吞吐量。
  • 新的、经过优化的、完全异步的 JSON 序列化器。
  • 减少表单 (form) 解析的内存使用量,并提高吞吐量。

ASP.NET Core 3.0 仅可在 .NET Core 3.0 上运行

从 ASP.NET Core 3.0开始,.NET Framework 不再是受支持的目标框架。以 .NET Framework 为目标的项目可以继续通过使用 .NET Core 2.1 LTS 版本在完全受支持的状态下运行。绝大多数与 ASP.NET Core 2.1.x 相关的软件包,都将在 .NET Core 2.1 的三年长期支持期内获得支持。(Most ASP.NET Core 2.1.x related packages will be supported indefinitely, beyond the 3 year LTS period for .NET Core 2.1.)

有关迁移的更多信息,请参见 将代码从 .NET Framework 移植到 .NET Core

使用 ASP.NET Core 共享框架

Microsoft.AspNetCore.App 元包中包含的 ASP.NET Core 3.0 共享框架 (shared framework) 不再需要项目文件中的显式 <PackageReference /> 元素。在项目文件中使用 Microsoft.NET.Sdk.Web SDK 时,将自动引用共享框架:

<Project Sdk="Microsoft.NET.Sdk.Web">

从 ASP.NET Core 共享框架中移除的程序集

从 ASP.NET Core 3.0 共享程序集中移除的最值得注意的程序集是:

有关共享框架中所移除程序集的完整列表,请参阅 从 Microsoft.AspNetCore.App 3.0 中移除的程序集