HttpResponse 类

定义

命名空间:

Microsoft.AspNetCore.Http

程序集:

Microsoft.AspNetCore.Http.Abstractions.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

表示单个 HTTP 请求的传出端。

public ref class HttpResponse abstract

public abstract class HttpResponse

type HttpResponse = class

Public MustInherit Class HttpResponse

继承

Object

HttpResponse

构造函数

HttpResponse()

表示单个 HTTP 请求的传出端。

属性

Body	获取或设置响应正文 Stream。
BodyWriter	获取响应正文 PipeWriter
ContentLength	获取或设置响应标头的值 Content-Length 。
ContentType	获取或设置响应标头的值 Content-Type 。
Cookies	获取一个对象，该对象可用于管理此响应的 Cookie。
HasStarted	获取一个值，该值指示是否已将响应标头发送到客户端。
Headers	获取响应标头。
HttpContext	获取 HttpContext 此响应的 。
StatusCode	获取或设置 HTTP 响应代码。

方法

CompleteAsync()	刷新所有剩余的响应标头、数据或尾部。 如果响应处于无效状态（例如 Content-Length 不匹配），则可能会引发此错误。
OnCompleted(Func<Object,Task>, Object)	添加在响应发送到客户端后要调用的委托。
OnCompleted(Func<Task>)	添加在响应发送到客户端后要调用的委托。
OnStarting(Func<Object,Task>, Object)	添加在将响应标头发送到客户端之前要调用的委托。 在此处注册的回调按相反的顺序运行。
OnStarting(Func<Task>)	添加在将响应标头发送到客户端之前要调用的委托。 在此处注册的回调按相反的顺序运行。
Redirect(String)	将 HTTP 302) (临时重定向响应返回到客户端。
Redirect(String, Boolean)	向客户端返回 (HTTP 301 或 HTTP 302) 的重定向响应。
RegisterForDispose(IDisposable)	注册一个 对象，以便在请求完成处理后由主机处置。
RegisterForDisposeAsync(IAsyncDisposable)	注册一个 对象，以便在请求完成处理后由主机进行异步处置。
StartAsync(CancellationToken)	通过调用 OnStarting () 并使标头不可修改来启动响应。

扩展方法

GetTypedHeaders(HttpResponse)	获取强类型 HTTP 响应标头。
WriteAsJsonAsync(HttpResponse, Object, JsonTypeInfo, String, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为指定的内容类型。
WriteAsJsonAsync(HttpResponse, Object, Type, JsonSerializerOptions, String, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为指定的内容类型。
WriteAsJsonAsync(HttpResponse, Object, Type, JsonSerializerOptions, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为 application/json; charset=utf-8。
WriteAsJsonAsync(HttpResponse, Object, Type, JsonSerializerContext, String, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为指定的内容类型。
WriteAsJsonAsync(HttpResponse, Object, Type, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为 application/json; charset=utf-8。
WriteAsJsonAsync<TValue>(HttpResponse, TValue, JsonSerializerOptions, String, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为指定的内容类型。
WriteAsJsonAsync<TValue>(HttpResponse, TValue, JsonSerializerOptions, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为 application/json; charset=utf-8。
WriteAsJsonAsync<TValue>(HttpResponse, TValue, JsonTypeInfo<TValue>, String, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为指定的内容类型。
WriteAsJsonAsync<TValue>(HttpResponse, TValue, CancellationToken)	将指定值作为 JSON 写入响应正文。 响应内容类型将设置为 application/json; charset=utf-8。
WriteAsync(HttpResponse, String, Encoding, CancellationToken)	使用给定编码将给定文本写入响应正文。
WriteAsync(HttpResponse, String, CancellationToken)	将给定文本写入响应正文。 将使用 UTF-8 编码。
Clear(HttpResponse)	清除 HTTP 响应。 此调用会重置响应标头、响应状态代码和响应正文。
Redirect(HttpResponse, String, Boolean, Boolean)	向客户端返回 (HTTP 301、HTTP 302、HTTP 307 或 HTTP 308) 的重定向响应。
AppendTrailer(HttpResponse, String, StringValues)	将给定的尾部标头添加到将在响应正文末尾发送的尾部集合。 可能会引发 Check SupportsTrailers(HttpResponse) 或 InvalidOperationException。
DeclareTrailer(HttpResponse, String)	将给定的尾部名称添加到“Trailer”响应标头。 必须在发送响应标头之前执行此操作。
SupportsTrailers(HttpResponse)	指示服务器是否支持为此响应发送尾部标头。
SendFileAsync(HttpResponse, IFileInfo, Int64, Nullable<Int64>, CancellationToken)	使用 SendFile 扩展发送给定的文件。
SendFileAsync(HttpResponse, IFileInfo, CancellationToken)	使用 SendFile 扩展发送给定的文件。
SendFileAsync(HttpResponse, String, Int64, Nullable<Int64>, CancellationToken)	使用 SendFile 扩展发送给定的文件。
SendFileAsync(HttpResponse, String, CancellationToken)	使用 SendFile 扩展发送给定的文件。