HttpWebRequest 类

定义

提供 WebRequest 类的特定于 HTTP 的实现。

public class HttpWebRequest : System.Net.WebRequest
public class HttpWebRequest : System.Net.WebRequest, System.Runtime.Serialization.ISerializable
[System.Serializable]
public class HttpWebRequest : System.Net.WebRequest, System.Runtime.Serialization.ISerializable
继承
HttpWebRequest
继承
属性
实现

示例

下面的代码示例为 URI http://www.contoso.com/创建 HttpWebRequest


HttpWebRequest myReq =
(HttpWebRequest)WebRequest.Create("http://www.contoso.com/");

注解

注意

WebRequestHttpWebRequestServicePointWebClient 已过时,不应将其用于新开发。 请改用 HttpClient

HttpWebRequest 类支持 WebRequest 中定义的属性和方法,以及允许用户使用 HTTP 直接与服务器交互的其他属性和方法。

请勿使用 HttpWebRequest 构造函数。 使用 WebRequest.Create 方法初始化新的 HttpWebRequest 对象。 如果统一资源标识符(URI)的方案 http://https://,则 Create 返回 HttpWebRequest 对象。

GetResponse 方法向 RequestUri 属性中指定的资源发出同步请求,并返回包含响应对象的 HttpWebResponse。 可以使用 GetResponseStream返回的流来接收响应数据。 如果响应对象或响应流已关闭,则剩余数据将被没收。 剩余数据将清空,在关闭响应对象或流(如果满足以下条件)时,套接字将重新用于后续请求:它是一个保持活动或管道化的请求,只需要接收少量数据,或者剩余的数据以较小的时间间隔接收。 如果上述任何条件均未保留或超出排空时间,则会关闭套接字。 对于保持连接或管道连接,强烈建议应用程序在 EOF 之前读取流。 这可确保套接字将重新用于后续请求,从而提高性能,减少使用的资源。

如果要将数据发送到资源,GetRequestStream 方法将返回用于发送数据的 Stream 对象。 BeginGetRequestStreamEndGetRequestStream 方法提供对发送数据流的异步访问。

若要使用 HttpWebRequest进行客户端身份验证,必须在当前用户的“我的证书”存储中安装客户端证书。

HttpWebRequest 类在访问资源时出错时引发 WebExceptionWebException.Status 属性包含一个指示错误源的 WebExceptionStatus 值。 当 WebException.StatusWebExceptionStatus.ProtocolError时,Response 属性包含从资源收到的 HttpWebResponse

HttpWebRequest 公开发送到 Internet 资源的常见 HTTP 标头值作为属性、方法设置或系统设置;下表包含完整列表。 可以在 Headers 属性中将其他标头设置为名称/值对。 请注意,服务器和缓存可能会在请求期间更改或添加标头。

下表列出了由属性或方法或系统设置的 HTTP 标头。

页眉 设置者
Accept Accept 属性设置。
Connection Connection 属性 KeepAlive 属性设置。
Content-Length ContentLength 属性设置。
Content-Type ContentType 属性设置。
Expect Expect 属性设置。
Date 由系统设置为当前日期。
Host 由系统设置为当前主机信息。
If-Modified-Since IfModifiedSince 属性设置。
Range AddRange 方法设置。
Referer Referer 属性设置。
Transfer-Encoding TransferEncoding 属性设置(SendChunked 属性必须 true)。
User-Agent UserAgent 属性设置。

备注

自动注册 HttpWebRequest。 在从 http://https://开始使用 URI 之前,无需调用 RegisterPrefix 方法来注册 System.Net.HttpWebRequest

本地计算机或应用程序配置文件可以指定使用默认代理。 如果指定了 Proxy 属性,则 Proxy 属性中的代理设置将覆盖本地计算机或应用程序配置文件,HttpWebRequest 实例将使用指定的代理设置。 如果在配置文件中未指定代理,并且未指定 Proxy 属性,HttpWebRequest 类将使用从本地计算机上的 Internet 选项继承的代理设置。 如果 Internet 选项中没有代理设置,则请求将直接发送到服务器。

备注

框架在创建 SSL 会话时缓存 SSL 会话,并尝试尽可能为新请求重复使用缓存会话。 尝试重用 SSL 会话时,框架使用 ClientCertificates 的第一个元素(如果有),或者尝试重复使用匿名会话(如果 ClientCertificates 为空)。

备注

出于安全原因,默认情况下会禁用 Cookie。 如果要使用 Cookie,请使用 CookieContainer 属性启用 Cookie。

.NET Framework 4.6 包括一项新的安全功能,用于阻止连接的不安全密码和哈希算法。 通过 HTTPClient、HttpWebRequest、FTPClient、SmtpClient、SslStream 等 API 使用 TLS/SSL 的应用程序,默认情况下面向 .NET Framework 4.6 获取更安全的行为。

开发人员可能希望选择退出此行为,以便保持与其现有 SSL3 服务或 TLS w/ RC4 服务的互操作性。 本文 介绍如何修改代码,以便禁用新行为。

构造函数

HttpWebRequest()
已过时.
已过时.

初始化 HttpWebRequest 类的新实例。 此构造函数已过时。

HttpWebRequest(SerializationInfo, StreamingContext)
已过时.
已过时.
已过时.
已过时.

SerializationInfoStreamingContext 类的指定实例初始化 HttpWebRequest 类的新实例。 此构造函数已过时。

属性

Accept

获取或设置 Accept HTTP 标头的值。

Address

获取实际响应请求的 Internet 资源的统一资源标识符(URI)。

AllowAutoRedirect

获取或设置一个值,该值指示请求是否应遵循重定向响应。

AllowReadStreamBuffering

获取或设置一个值,该值指示是否缓冲从 Internet 资源接收的值。

AllowWriteStreamBuffering

获取或设置一个值,该值指示是否缓冲发送到 Internet 资源的数据。

AuthenticationLevel

获取或设置一个值,该值指示用于此请求的身份验证和模拟级别。

(继承自 WebRequest)
AutomaticDecompression

获取或设置使用的解压缩类型。

CachePolicy

获取或设置此请求的缓存策略。

(继承自 WebRequest)
ClientCertificates

获取或设置与此请求关联的安全证书的集合。

Connection

获取或设置 Connection HTTP 标头的值。

ConnectionGroupName

获取或设置请求的连接组的名称。

ConnectionGroupName

在后代类中重写时,获取或设置请求的连接组的名称。

(继承自 WebRequest)
ContentLength

获取或设置 Content-length HTTP 标头。

ContentLength

在后代类中重写时,获取或设置要发送的请求数据的内容长度。

(继承自 WebRequest)
ContentType

获取或设置 Content-type HTTP 标头的值。

ContinueDelegate

获取或设置从 Internet 资源接收 HTTP 100 继续响应时调用的委托方法。

ContinueTimeout

获取或设置一个超时(以毫秒为单位),等待从服务器接收 100-Continue。

CookieContainer

获取或设置与请求关联的 Cookie。

CreatorInstance
已过时.

在后代类中重写时,获取派生自 IWebRequestCreate 类的工厂对象,该类用于创建实例化 WebRequest,以便向指定的 URI 发出请求。

(继承自 WebRequest)
Credentials

获取或设置请求的身份验证信息。

Date

获取或设置要在 HTTP 请求中使用的 Date HTTP 标头值。

DefaultCachePolicy

获取或设置此请求的默认缓存策略。

DefaultMaximumErrorResponseLength

获取或设置 HTTP 错误响应的默认最大长度。

DefaultMaximumResponseHeadersLength

获取或设置 MaximumResponseHeadersLength 属性的默认值。

Expect

获取或设置 Expect HTTP 标头的值。

HaveResponse

获取一个值,该值指示是否已从 Internet 资源接收响应。

Headers

指定构成 HTTP 标头的名称/值对的集合。

Host

获取或设置要在独立于请求 URI 的 HTTP 请求中使用的主机标头值。

IfModifiedSince

获取或设置 If-Modified-Since HTTP 标头的值。

ImpersonationLevel

获取或设置当前请求的模拟级别。

(继承自 WebRequest)
KeepAlive

获取或设置一个值,该值指示是否与 Internet 资源建立持久连接。

MaximumAutomaticRedirections

获取或设置请求所遵循的最大重定向数。

MaximumResponseHeadersLength

获取或设置响应标头允许的最大长度。

MediaType

获取或设置请求的媒体类型。

Method

获取或设置请求的方法。

Pipelined

获取或设置一个值,该值指示是否将请求管道传递给 Internet 资源。

PreAuthenticate

获取或设置一个值,该值指示是否使用请求发送授权标头。

PreAuthenticate

在后代类中重写时,指示是否预先对请求进行身份验证。

(继承自 WebRequest)
ProtocolVersion

获取或设置要用于请求的 HTTP 版本。

Proxy

获取或设置请求的代理信息。

Proxy

在后代类中重写时,获取或设置用于访问此 Internet 资源的网络代理。

(继承自 WebRequest)
ReadWriteTimeout

获取或设置写入流或从流中读取时的超时(以毫秒为单位)。

Referer

获取或设置 Referer HTTP 标头的值。

RequestUri

获取请求的原始统一资源标识符(URI)。

SendChunked

获取或设置一个值,该值指示是否将数据段中的数据发送到 Internet 资源。

ServerCertificateValidationCallback

获取或设置用于验证服务器证书的回调函数。

ServicePoint

获取要用于请求的服务点。

SupportsCookieContainer

获取一个值,该值指示请求是否为 CookieContainer提供支持。

Timeout

获取或设置 GetResponse()GetRequestStream() 方法的超时值(以毫秒为单位)。

Timeout

获取或设置请求超时前的时间长度(以毫秒为单位)。

(继承自 WebRequest)
TransferEncoding

获取或设置 Transfer-encoding HTTP 标头的值。

UnsafeAuthenticatedConnectionSharing

获取或设置一个值,该值指示是否允许高速 NTLM 身份验证的连接共享。

UseDefaultCredentials

获取或设置一个 Boolean 值,该值控制是否使用请求发送默认凭据。

UseDefaultCredentials

在后代类中重写时,获取或设置一个 Boolean 值,该值控制是否使用请求发送 DefaultCredentials

(继承自 WebRequest)
UserAgent

获取或设置 User-agent HTTP 标头的值。

方法

Abort()

取消对 Internet 资源的请求。

AddRange(Int32)

将字节范围标头添加到从所请求数据的开头或末尾对特定范围的请求。

AddRange(Int32, Int32)

将字节范围标头添加到指定范围的请求中。

AddRange(Int64)

将字节范围标头添加到从所请求数据的开头或末尾对特定范围的请求。

AddRange(Int64, Int64)

将字节范围标头添加到指定范围的请求中。

AddRange(String, Int32)

将 Range 标头添加到从所请求数据的开始或结尾到特定范围的请求。

AddRange(String, Int32, Int32)

将范围标头添加到指定范围的请求中。

AddRange(String, Int64)

将 Range 标头添加到从所请求数据的开始或结尾到特定范围的请求。

AddRange(String, Int64, Int64)

将范围标头添加到指定范围的请求中。

BeginGetRequestStream(AsyncCallback, Object)

开始 Stream 对象用于写入数据的异步请求。

BeginGetResponse(AsyncCallback, Object)

开始对 Internet 资源的异步请求。

CreateObjRef(Type)

创建一个对象,其中包含生成用于与远程对象通信的代理所需的所有相关信息。

(继承自 MarshalByRefObject)
EndGetRequestStream(IAsyncResult)

结束 Stream 对象用于写入数据的异步请求。

EndGetRequestStream(IAsyncResult, TransportContext)

结束 Stream 对象的异步请求,该请求用于写入数据和输出与流关联的 TransportContext

EndGetResponse(IAsyncResult)

结束对 Internet 资源的异步请求。

Equals(Object)

确定指定的对象是否等于当前对象。

(继承自 Object)
GetHashCode()

返回 WebRequest 实例的哈希值。

GetHashCode()

用作默认哈希函数。

(继承自 Object)
GetLifetimeService()
已过时.

检索控制此实例的生存期策略的当前生存期服务对象。

(继承自 MarshalByRefObject)
GetObjectData(SerializationInfo, StreamingContext)
已过时.
已过时.
已过时.

使用序列化目标对象所需的数据填充 SerializationInfo

GetObjectData(SerializationInfo, StreamingContext)
已过时.

使用序列化目标对象所需的数据填充 SerializationInfo

(继承自 WebRequest)
GetRequestStream()

获取用于写入请求数据的 Stream 对象。

GetRequestStream()

在后代类中重写时,返回一个 Stream,用于将数据写入 Internet 资源。

(继承自 WebRequest)
GetRequestStream(TransportContext)

获取一个 Stream 对象,该对象用于写入请求数据并输出与流关联的 TransportContext

GetRequestStreamAsync()

在后代类中重写时,返回一个 Stream,用于将数据作为异步操作写入 Internet 资源。

(继承自 WebRequest)
GetResponse()

返回来自 Internet 资源的响应。

GetResponse()

在后代类中重写时,返回对 Internet 请求的响应。

(继承自 WebRequest)
GetResponseAsync()

在后代类中重写时,以异步操作的形式返回对 Internet 请求的响应。

(继承自 WebRequest)
GetType()

获取当前实例的 Type

(继承自 Object)
InitializeLifetimeService()
已过时.

获取生存期服务对象来控制此实例的生存期策略。

(继承自 MarshalByRefObject)
MemberwiseClone()

创建当前 Object的浅表副本。

(继承自 Object)
MemberwiseClone(Boolean)

创建当前 MarshalByRefObject 对象的浅表副本。

(继承自 MarshalByRefObject)
ToString()

返回一个表示当前对象的字符串。

(继承自 Object)

显式接口实现

ISerializable.GetObjectData(SerializationInfo, StreamingContext)
已过时.
已过时.
已过时.

使用序列化目标对象所需的数据填充 SerializationInfo

扩展方法

GetRequestMetadata(HttpWebRequest)

获取用于遥测目的的传出请求的元数据。

SetRequestMetadata(HttpWebRequest, RequestMetadata)

设置要用于遥测目的的传出请求的元数据。

适用于

产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

另请参阅