ASP.NET Core 中的请求和响应操作Request and response operations in ASP.NET Core
本文介绍如何读取请求正文和写入响应正文。写入中间件时,可能需要这些操作的代码。除写入中间件外,通常不需要自定义代码,因为操作由 MVC 和 Razor Pages 处理。
请求正文和响应正文有两个抽象元素: 和 Pipe。对于请求读取, 是 Stream, 是 。对于响应写入,HttpResponse.Body 是 ,HttpResponse.BodyWriter
是 PipeWriter。
建议使用替代流。在一些简单操作中,使用流会比较简单,但管道具有性能优势,并且在大多数场景中更易于使用。ASP.NET Core 开始在内部使用管道替代流。示例包括:
TextReader
TextWriter
HttpResponse.WriteAsync
流不会从框架中删除。流将继续在 .NET 中使用,并且许多流类型不具有等效的管道,如 FileStreams
和 ResponseCompression
。
若要查看翻译为非英语语言的代码注释,请在 此 GitHub 讨论问题中告诉我们。
此代码有效,但存在一些问题:
- 在追加到
StringBuilder
之前,示例创建另一个字符串 (encodedString
),该字符串会立即被丢弃。此过程发生在流中的所有字节上,因此结果是为整个请求正文大小分配额外的内存。 - 该示例在新行上进行拆分之前读取整个字符串。检查字节数组中的新行会更有效。
下面是修复上面其中一些问题的示例:
上面的此示例:
- 不在 中缓冲整个请求正文(除非没有任何换行符)。
- 如果换行符稀疏,则大部分请求正文都在字符串中进行缓冲。
- 该代码会继续创建字符串 (
remainingString
) 并将它们添加到字符串缓冲区,这将导致额外的分配。
这些问题是可修复的,但代码逐渐变得复杂,几乎没有什么改进。管道提供了一种以最低的代码复杂性解决这些问题的方法。
下面的示例显示了如何使用 PipeReader
处理相同的场景:
此示例解决了流实现中的许多问题:
- 不需要字符串缓冲区,因为
PipeReader
会处理未使用的字节。 - 编码后的字符串将直接添加到返回的字符串列表。
- 除了字符串使用的内存之外,无需再为创建的字符串分配内存(
ToArray()
调用除外)。
Body
和 BodyReader/BodyWriter
属性均可用于 HttpRequest
和 HttpResponse
。将 设置为另一个流时,一组新的适配器会自动使每种类型彼此适应。如果将 HttpRequest.Body
设置为新流,则 HttpRequest.BodyReader
将自动设置为包装 HttpRequest.Body
的新 PipeReader
。