ASP.NET Core 中断请求了解一下（翻译）

本文主要是介绍ASP.NET Core 中断请求了解一下（翻译），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本文所讲方式仅适用于托管在Kestrel Server中的应用。如果托管在IIS和IIS Express上时，ASP.NET Core Module(ANCM)并不会告诉ASP.NET Core在客户端断开连接时中止请求。但可喜的是，ANCM预计在.NET Core 2.2中会完善这一机制。

1. 引言

假设有一个耗时的Action，在浏览器发出请求返回响应之前，如果刷新了页面，对于浏览器（客户端）来说前一个请求就会被终止。而对于服务端来说，又是怎样呢？前一个请求也会自动终止，还是会继续运行呢？

下面我们通过实例寻求答案。

2. 实例演示

创建一个SlowRequestController，再定义一个Get请求，并通过Task.Delay(10_000)模拟耗时行为。代码如下：

640?wx_fmt=png

如果我们发起请求，那么该页面将耗时10s才能完成显示。
640?wx_fmt=png
如果我们检查运行日志，我们发现其输出符合预期：

如果在第一次请求返回之前，刷新页面，结果将是怎样呢？？

640?wx_fmt=png
从日志中我们可以看出：刷新后，第一个请求虽然在客户端被取消了，但是服务端仍旧会持续运行。

从而可以说明MVC的默认行为： 即使用户刷新了浏览器会取消原始请求，但MVC对其一无所知，已经被取消的请求还是会在服务端继续运行，而最终的运行结果将会被丢弃。

这样就会造成严重的性能浪费。如果服务端能感知用户中断了请求，并终止运行耗时的任务就好了。

幸好，ASP.NET Core开发团队体贴的考虑了这一点，允许我们通过以下两种方式来获取客户端的请求是否被终止。

通过HttpContex的RequestAborted属性：
通过方法注入CancellationToken参数：

640?wx_fmt=png

而这两种方式其实是一样的，因为HttpContext.RequestAborted和cancellationToken对应的是同一个对象：

if(cancellationToken == HttpContext.RequestAborted)
{    // this is true!
}

下面我们就来以cancellationToken为例，看看如何感知客户端请求终止并终止服务端服务。

3. 在Action中使用CancellationToken

CancellationToken是由CancellationTokenSource创建的轻量级对象。当某个CancellationTokenSource被取消时，它会通知所有的消费者CancellationToken。

取消时，CancellationToken的IsCancellationRequested属性将设置为True，表示CancellationTokenSource已取消。

再回到前面的实例，我们有一个长期运行的操作方法（例如，通过调用许多其他API生成只读报告）。由于它是一种昂贵的方法，我们希望在用户取消请求时尽快停止执行操作。

下面的代码显示了通过在action方法中注入一个CancellationToken，并将其传递给Task.Delay，来达到同步终止服务端请求的目的：

640?wx_fmt=png

MVC将使用CancellationTokenModelBinder自动将Action中的任何CancellationToken参数绑定到HttpContext.RequestAborted。当我们在Startup.ConfigureServices()中调用services.AddMvc() 或 services.AddMvcCore()时，CancellationTokenModelBinder模型绑定器就会被自动注册。

通过这个小改动，我们再尝试在第一个请求返回之前刷新页面，从日志中我们发现，第一个请求将不会继续完成。而是当Task.Delay检测到CancellationToken.IsCancellationRequested属性为true时立即停止执行时并抛出TaskCancelledException。
640?wx_fmt=png

简而言之，用户刷新浏览器，在服务端通过抛出TaskCancelledException异常终止了第一个请求，而该异常通过请求管道再传播回来。

在这个场景中，Task.Delay()会监视CancellationToken，因此无需我们手动检查CancellationToken是否被取消。

4. 手动检查CancellationToken状态

如果你正在调用支持CancellationToken的内置方法，比如Task.Delay()或HttpClient.SendAsync()，那么你可以直接传入CancellationToken，并让内部方法负责实际取消。
在其他情况下，您可能正在进行一些同步工作，您希望能够取消这些工作。例如，假设正在构建一份报告来计算公司员工的所有佣金。你循环每个员工，然后遍历他们的每一笔销售。

能够在中途取消此报告生成的简单解决方案是检查for循环内的CancellationToken，如果用户取消请求则跳出循环。
以下示例通过循环10次并执行某些同步（不可取消）工作来表示此类情况，该工作由对Thread.Sleep()来模拟。在每个循环开始时，我们检查CancellationToken，如果取消则抛出异常。这使得我们可以终止一个长时间运行的同步任务。

640?wx_fmt=png

现在，如果你取消请求，则对ThrowIfCancelletionRequested()的调用将抛出一个OperationCanceledException，它将再次传播回过滤器管道和中间件管道。

5. 使用ExceptionFilter捕捉取消异常

ExceptionFilters是一个MVC概念，可用于处理在您的操作方法或操作过滤器中发生的异常。可以参考官方文档。

可以将过滤器应用到控制器级别和操作级别，也可以应用于全局级别。为了简单起见，我们创建一个过滤器并添加到全局过滤器。

640?wx_fmt=png

我们通过重载OnException方法并特殊处理OperationCanceledException异常即可成功捕获取消异常。

Task.Delay()抛出的异常是TaskCancelledException类型，其为OperationCanceledException的基类，所以，以上过滤器也可正确捕捉。

然后注册过滤器：

public class Startup{    public void ConfigureServices(IServiceCollection services){services.AddMvc(options =>{options.Filters.Add<OperationCancelledExceptionFilter>();});}
}

现在再测试，我们发现运行日志将不会包含异常信息，取而代之的是我们自定义的信息。

640?wx_fmt=png