c# - 在自定义中间件中测试 response.WriteAsync()
问题描述
我有一个 ASP.NET Core API,为此我编写了自定义中间件,以便我可以在一个位置处理异常并写入日志。通过 Kestrel 调试并从浏览器或邮递员提交请求时,中间件按要求工作,但是在我的测试中,响应正文始终为空流。
下面是我编写的中间件类和测试, context.Response.WriteAsync(result) 由于某种原因似乎没有刷新流,但我不知道为什么。有人能解释一下吗?
using System;
using System.Net;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Newtonsoft.Json;
using Microsoft.Extensions.Logging;
using System.IO;
namespace APP.API.Middleware
{
public class ExceptionHandler
{
private readonly RequestDelegate request;
private readonly ILogger logger;
public ExceptionHandler(RequestDelegate request, ILogger<ExceptionHandler> logger)
{
this.request = request;
this.logger = logger;
}
public async Task Invoke(HttpContext context)
{
try
{
await request(context);
}
catch (Exception ex)
{
await HandleExceptionAsync(context, ex);
}
}
private Task HandleExceptionAsync(HttpContext context, Exception ex)
{
HttpStatusCode statusCode = HttpStatusCode.InternalServerError;
logger.LogError(ex, "Fatal exception");
var result = JsonConvert.SerializeObject(new { error = ex.Message });
context.Response.ContentType = "application/json";
context.Response.StatusCode = (int)statusCode;
return context.Response.WriteAsync(result);
}
}
}
using System.IO;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.VisualStudio.TestTools.UnitTesting;
namespace APP.Testing.Middleware
{
[TestClass]
public class ExceptionHandler
{
[TestMethod]
public void HandleException()
{
var exceptionHandler = new API.Middleware.ExceptionHandler((innerHttpContext) =>
{
throw new System.Exception("Test exception");
}, new NullLogger<API.Middleware.ExceptionHandler>());
var context = new DefaultHttpContext();
exceptionHandler.Invoke(context).Wait();
context.Response.Body.Seek(0, SeekOrigin.Begin);
var reader = new StreamReader(context.Response.Body);
var text = reader.ReadToEnd();
}
}
}
解决方案
欢迎来到堆栈溢出!
您的响应正文为空,因为您正在写入 a NullStream
(不要与null
value 混淆)。
“没有后备存储的流。使用 Null 将输出重定向到不会消耗任何操作系统资源的流。当在 Null 上调用提供写入的 Stream 方法时,调用只是返回,并且没有写入数据。Null还实现了一个 Read 方法,该方法在不读取数据的情况下返回零。” -文档
Body
属性的默认值HttpResponse
正是NullStream
. 在一个 HTTP 请求到达的真实场景中,NullStream
替换为HttpResponseStream
. 您将无法自行使用它,因为它的可访问性级别设置为internal
.
解决方案
由于单元测试只是模拟真实场景,您可以将 替换为NullStream
您想要的任何类型的流,例如MemoryStream
:
var exceptionHandler = new ExceptionHandler((innerHttpContext) =>
{
throw new Exception("Test exception");
}, new NullLogger<ExceptionHandler>());
var context = new DefaultHttpContext();
context.Response.Body = new MemoryStream(); // <== Replace the NullStream
await exceptionHandler.Invoke(context);
context.Response.Body.Seek(0, SeekOrigin.Begin);
var reader = new StreamReader(context.Response.Body);
var text = reader.ReadToEnd();
不要忘记在单元测试结束时添加一些断言。毕竟,您想执行一些检查,对吗?
Assert.IsFalse(string.IsNullOrEmpty(text));
编辑#1
正如@nkosi 指出的那样,除非您有充分的理由,否则您应该始终使用await
关键字调用异步方法:
await exceptionHandler.Invoke(context);
并用标记方法定义async
并使其返回Task
:
public async Task HandleException()
这样你就可以避免死锁。
还有一点值得指出(但不是必需的)是测试类的命名约定。显然,您可以随意命名它,但请记住,当您的测试类与您要测试的类具有相同的名称时,您最终会出现不必要的名称歧义。当然你可以用命名空间写全名(就像你做的那样),但是由于我的懒惰性质,这太过分了,所以我使用不同的名称来测试类,例如ExceptionHandlerTests
.
推荐阅读
- c++ - 二值图像中覆盖所有真值像素的最短路径是什么?
- python - 使用python计算从点到多边形最近边缘的距离的问题
- node.js - schema.methods 不是函数
- sql-server - 将两行表之间的绝对时间差获取到另一个表中
- amazon-web-services - 构建映像时 dockerfile 中的 AWS 凭证
- google-cloud-platform - 在 Google Cloud 上运行 Batch python 进程
- python - 从 tf.data.Datasets 构建 tf,estimator.DNNClassifier
- java - BottomNavigationView 高度未包裹到底部
- python - 多选菜单 Python
- ruby-on-rails - 具有即时方法列的活动管理员自定义索引