HttpClientHandler Klasse

Definition

Den Standardnachrichtenhandler, der von HttpClient in .NET Framework und .NET Core 2.0 und früheren Versionen verwendet wird.The default message handler used by HttpClient in .NET Framework and .NET Core 2.0 and earlier.

public ref class HttpClientHandler : System::Net::Http::HttpMessageHandler
public class HttpClientHandler : System.Net.Http.HttpMessageHandler
type HttpClientHandler = class
    inherit HttpMessageHandler
Public Class HttpClientHandler
Inherits HttpMessageHandler
Vererbung
HttpClientHandler
Abgeleitet

Beispiele

static async Task Main()
{
   // Create an HttpClientHandler object and set to use default credentials
   HttpClientHandler handler = new HttpClientHandler();
   handler.UseDefaultCredentials = true;

   // Create an HttpClient object
   HttpClient client = new HttpClient(handler);

   // Call asynchronous network methods in a try/catch block to handle exceptions
   try
   {
      HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");

      response.EnsureSuccessStatusCode();

      string responseBody = await response.Content.ReadAsStringAsync();
      Console.WriteLine(responseBody);
   }
   catch(HttpRequestException e)
   {
       Console.WriteLine("\nException Caught!");
       Console.WriteLine("Message :{0} ",e.Message);
   }

   // Need to call dispose on the HttpClient and HttpClientHandler objects
   // when done using them, so the app doesn't leak resources
   handler.Dispose();
   client.Dispose();
}

Im vorangehenden Codebeispiel wird ein async Task Main() Einstiegspunkt verwendet.The preceding code example uses an async Task Main() entry point. Diese Funktion erfordert c# 7,1 oder höher.That feature requires C# 7.1 or later.

Hinweise

Die HttpClientHandler Klasse und die Klassen, die von der IT abgeleitet werden, ermöglichen es Entwicklern, eine Vielzahl von Optionen zu konfigurieren, die von ProxysThe HttpClientHandler class and classes derived from it enable developers to configure a variety of options ranging from proxies to authentication.

Httpclienthandler in .net CoreHttpClientHandler in .NET Core

Ab .net Core 2,1 wurde die Implementierung der- HttpClientHandler Klasse so geändert, dass Sie auf dem plattformübergreifenden HTTP-Protokollstapel basiert, der von der-Klasse verwendet wird System.Net.Http.SocketsHttpHandler .Starting in .NET Core 2.1, the implementation of the HttpClientHandler class was changed to be based on the cross-platform HTTP protocol stack used by the System.Net.Http.SocketsHttpHandler class. Vor .net Core 2,1 verwendete die- HttpClientHandler Klasse ältere HTTP-Protokollstapel ( WinHttpHandler unter Windows und CurlHandler eine interne Klasse, die zusätzlich zur nativen libcurl-Komponente von Linux implementiert ist, unter Linux).Prior to .NET Core 2.1, the HttpClientHandler class used older HTTP protocol stacks (WinHttpHandler on Windows and CurlHandler, an internal class implemented on top of Linux's native libcurl component, on Linux).

Sie können Ihre APP so konfigurieren, dass die älteren HTTP-Protokollstapel auf eine der folgenden drei Arten verwendet werden:You can configure your app to use the older HTTP protocol stacks in one of the following three ways:

  • Wenden Sie die- AppContext.SetSwitch Methode an:Call the AppContext.SetSwitch method:

    AppContext.SetSwitch("System.Net.Http.UseSocketsHttpHandler", false);
    
    AppContext.SetSwitch("System.Net.Http.UseSocketsHttpHandler", False)
    
  • Legen Sie den System.Net.Http.UseSocketsHttpHandler Schalter im .netcore.runtimeconfig.jsfür die Konfigurationsdatei fest:Define the System.Net.Http.UseSocketsHttpHandler switch in the .netcore.runtimeconfig.json configuration file:

    "runtimeOptions": {
      "configProperties": {
          "System.Net.Http.UseSocketsHttpHandler": false
      }
    }
    
  • Definieren Sie eine Umgebungsvariable DOTNET_SYSTEM_NET_HTTP_USESOCKETSHTTPHANDLER mit dem Namen, und legen Sie Sie entweder auf false oder 0 fest.Define an environment variable named DOTNET_SYSTEM_NET_HTTP_USESOCKETSHTTPHANDLER and set it to either false or 0.

Konstruktoren

HttpClientHandler()

Erstellt eine Instanz einer HttpClientHandler-Klasse.Creates an instance of a HttpClientHandler class.

Eigenschaften

AllowAutoRedirect

Ruft einen Wert ab, der angibt, ob der Handler Umleitungsantworten folgen soll, oder legt diesen Wert fest.Gets or sets a value that indicates whether the handler should follow redirection responses.

AutomaticDecompression

Ruft den Typ der Dekomprimierungsmethode ab, die vom Handler für die automatische Dekomprimierung von Antworten mit HTTP-Inhalt verwendet wird, oder legt den Typ fest.Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response.

CheckCertificateRevocationList

Ruft einen Wert ab, der angibt, ob das Zertifikat anhand der Sperrliste der Zertifizierungsstelle überprüft wird, oder legt diesen fest.Gets or sets a value that indicates whether the certificate is checked against the certificate authority revocation list.

ClientCertificateOptions

Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob das Zertifikat automatisch aus dem Zertifikatspeicher ausgewählt wird oder ob der Aufrufer ein bestimmtes Clientzertifikat übergeben darf.Gets or sets a value that indicates if the certificate is automatically picked from the certificate store or if the caller is allowed to pass in a specific client certificate.

ClientCertificates

Ruft die dieser Anforderungen an den Server zugeordnete Auflistung von Sicherheitszertifikaten ab.Gets the collection of security certificates that are associated requests to the server.

CookieContainer

Ruft den zum Speichern von Servercookies vom Handler verwendeten Cookiecontainer ab oder legt diesen fest.Gets or sets the cookie container used to store server cookies by the handler.

Credentials

Ruft von diesem Handler verwendete Authentifizierungsinformationen ab oder legt diese fest.Gets or sets authentication information used by this handler.

DangerousAcceptAnyServerCertificateValidator

Ruft einen zwischengespeicherten Delegaten ab, der immer true zurückgibt.Gets a cached delegate that always returns true.

DefaultProxyCredentials

Wenn der Standardproxy (Systemproxy) verwendet wird, werden die Anmeldeinformationen abgerufen oder festgelegt, die an den Standardproxyserver für die Authentifizierung übermittelt werden.When the default (system) proxy is being used, gets or sets the credentials to submit to the default proxy server for authentication. Der Standardproxy wird nur verwendet, wenn UseProxy auf true und Proxy auf null festgelegt ist.The default proxy is used only when UseProxy is set to true and Proxy is set to null.

MaxAutomaticRedirections

Ruft die maximale Anzahl von Umleitungen ab, denen der Handler folgt, oder legt diese fest.Gets or sets the maximum number of redirects that the handler follows.

MaxConnectionsPerServer

Ruft die maximal zulässige Anzahl gleichzeitiger Verbindungen (pro Serverendpunkt), wenn eine Anforderung mithilfe eines HttpClient-Objekts durchgeführt wird, oder legt diese fest.Gets or sets the maximum number of concurrent connections (per server endpoint) allowed when making requests using an HttpClient object. Beachten Sie, dass der Grenzwert pro Serverendpunkt gilt. Ein Wert von 256 würde beispielsweise 256 gleichzeitige Verbindungen zu „http://www.adatum.com/“ und weitere 256 zu „http://www.adventure-works.com/“ ermöglichen.Note that the limit is per server endpoint, so for example a value of 256 would permit 256 concurrent connections to http://www.adatum.com/ and another 256 to http://www.adventure-works.com/.

MaxRequestContentBufferSize

Dient zum Abrufen oder Festlegen der maximalen Größe des Anforderungsinhaltspuffers, die vom Handler verwendet wird.Gets or sets the maximum request content buffer size used by the handler.

MaxResponseHeadersLength

Ruft die maximale Länge des Antwortheaders in Kilobyte (1024 Byte) ab oder legt diese fest.Gets or sets the maximum length, in kilobytes (1024 bytes), of the response headers. Wenn der Wert beispielsweise 64 ist, sind 65536 Byte für die maximale Länge des Antwortheaders zulässig.For example, if the value is 64, then 65536 bytes are allowed for the maximum response headers' length.

PreAuthenticate

Ruft einen Wert ab, der angibt, ob vom Handler mit der Anforderung ein Autorisierungsheader gesendet wird, oder legt diesen fest.Gets or sets a value that indicates whether the handler sends an Authorization header with the request.

Properties

Ruft ein beschreibares Wörterbuch (d.h. eine Zuordnung) von benutzerdefinierten Eigenschaften für die HttpClient-Anforderungen ab.Gets a writable dictionary (that is, a map) of custom properties for the HttpClient requests. Das Wörterbuch ist zunächst leer. Sie können Schlüssel-Wert-Paare für benutzerdefinierte Handler und die spezielle Verarbeitung einfügen und abfragen.The dictionary is initialized empty; you can insert and query key-value pairs for your custom handlers and special processing.

Proxy

Ruft vom Handler verwendete Proxyinformationen ab oder legt diese fest.Gets or sets proxy information used by the handler.

ServerCertificateCustomValidationCallback

Ruft eine Rückrufmethode zur Überprüfung des Serverzertifikats ab oder legt diese fest.Gets or sets a callback method to validate the server certificate.

SslProtocols

Ruft das TSL-/SSL-Protokoll ab, das von den HttpClient-Objekten verwendet wird, die vom HttpClientHandler-Objekt verwaltet werden, oder legt dieses fest.Gets or sets the TLS/SSL protocol used by the HttpClient objects managed by the HttpClientHandler object.

SupportsAutomaticDecompression

Ruft einen Wert ab, der angibt, ob der Handler die automatische Dekomprimierung von Antwortinhalten unterstützt.Gets a value that indicates whether the handler supports automatic response content decompression.

SupportsProxy

Ruft einen Wert ab, der angibt, ob der Handler Proxyeinstellungen unterstützt.Gets a value that indicates whether the handler supports proxy settings.

SupportsRedirectConfiguration

Ruft einen Wert ab, der angibt, ob der Handler Konfigurationseinstellungen für die Eigenschaften AllowAutoRedirect und MaxAutomaticRedirections unterstützt.Gets a value that indicates whether the handler supports configuration settings for the AllowAutoRedirect and MaxAutomaticRedirections properties.

UseCookies

Ruft einen Wert ab oder legt diesen fest, der angibt, ob der Handler die CookieContainer-Eigenschaft zum Speichern von Servercookies und diese Cookies zum Senden von Anforderungen verwendet.Gets or sets a value that indicates whether the handler uses the CookieContainer property to store server cookies and uses these cookies when sending requests.

UseDefaultCredentials

Ruft einen Wert ab, der steuert, ob vom Handler mit den Anforderungen Standardanmeldeinformationen gesendet werden, oder legt diesen fest.Gets or sets a value that controls whether default credentials are sent with requests by the handler.

UseProxy

Ruft einen Wert ab, der angibt, ob der Handler einen Proxy für Anforderungen verwendet, oder legt diesen Wert fest.Gets or sets a value that indicates whether the handler uses a proxy for requests.

Methoden

Dispose()

Gibt die vom HttpMessageHandler verwendeten, nicht verwalteten Ressourcen frei und verwirft die verwalteten Ressourcen.Releases the unmanaged resources and disposes of the managed resources used by the HttpMessageHandler.

(Geerbt von HttpMessageHandler)
Dispose(Boolean)

Gibt die vom HttpClientHandler verwendeten, nicht verwalteten Ressourcen frei und verwirft optional auch die verwalteten Ressourcen.Releases the unmanaged resources used by the HttpClientHandler and optionally disposes of the managed resources.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
Send(HttpRequestMessage, CancellationToken)

Erstellt eine Instanz von HttpResponseMessage auf Basis der in HttpRequestMessage bereitgestellten Informationen.Creates an instance of HttpResponseMessage based on the information provided in the HttpRequestMessage.

Send(HttpRequestMessage, CancellationToken)

Sendet eine HTTP-Anforderung mit der angegebenen Anforderung und einem Abbruchtoken, wenn eine Überschreibung in einer abgeleiteten Klasse erfolgt.When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Löst andernfalls eine NotSupportedException aus.Otherwise, throws a NotSupportedException.

(Geerbt von HttpMessageHandler)
SendAsync(HttpRequestMessage, CancellationToken)

Erstellt eine Instanz von HttpResponseMessage auf Basis der in HttpRequestMessage bereitgestellten Informationen als nicht blockierender Vorgang.Creates an instance of HttpResponseMessage based on the information provided in the HttpRequestMessage as an operation that will not block.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für: