HttpClient Класс

Определение

Пространство имен:

System.Net.Http

Сборки:

netstandard.dll, System.Net.Http.dll

Исходный код:

HttpClient.cs

Предоставляет класс для отправки HTTP-запросов и получения HTTP-ответов из ресурса, определяемого URI.

public ref class HttpClient : System::Net::Http::HttpMessageInvoker

public class HttpClient : System.Net.Http.HttpMessageInvoker

type HttpClient = class
    inherit HttpMessageInvoker

Public Class HttpClient
Inherits HttpMessageInvoker

Наследование

Object

HttpMessageInvoker

HttpClient

Примеры

// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
static readonly HttpClient client = new HttpClient();

static async Task Main()
{
    // Call asynchronous network methods in a try/catch block to handle exceptions.
    try
    {
        using HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");
        response.EnsureSuccessStatusCode();
        string responseBody = await response.Content.ReadAsStringAsync();
        // Above three lines can be replaced with new helper method below
        // string responseBody = await client.GetStringAsync(uri);

        Console.WriteLine(responseBody);
    }
    catch (HttpRequestException e)
    {
        Console.WriteLine("\nException Caught!");
        Console.WriteLine("Message :{0} ", e.Message);
    }
}

open System.Net.Http

// HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
let client = new HttpClient()

let main =
    task {
        // Call asynchronous network methods in a try/catch block to handle exceptions.
        try
            use! response = client.GetAsync "http://www.contoso.com/"
            response.EnsureSuccessStatusCode() |> ignore
            let! responseBody = response.Content.ReadAsStringAsync()
            // Above three lines can be replaced with new helper method below
            // let! responseBody = client.GetStringAsync uri

            printfn $"{responseBody}"
        with
        | :? HttpRequestException as e ->
            printfn "\nException Caught!"
            printfn $"Message :{e.Message} "
    }

main.Wait()

' HttpClient is intended to be instantiated once per application, rather than per-use. See Remarks.
Shared ReadOnly client As HttpClient = New HttpClient()

Private Shared Async Function Main() As Task
    ' Call asynchronous network methods in a try/catch block to handle exceptions.
    Try
        Using response As HttpResponseMessage = Await client.GetAsync("http://www.contoso.com/")
            response.EnsureSuccessStatusCode()
            Dim responseBody As String = Await response.Content.ReadAsStringAsync()
            ' Above three lines can be replaced with new helper method below
            ' Dim responseBody As String = Await client.GetStringAsync(uri)

            Console.WriteLine(responseBody)
        End Using
    Catch e As HttpRequestException
        Console.WriteLine(Environment.NewLine & "Exception Caught!")
        Console.WriteLine("Message :{0} ", e.Message)
    End Try
End Function

Комментарии

Дополнительные сведения об этом API см. в дополнительных примечаниях API для HttpClient.

Конструкторы

Имя	Описание
HttpClient()	Инициализирует новый экземпляр HttpClient класса с помощью HttpClientHandler удаления этого экземпляра.
HttpClient(HttpMessageHandler, Boolean)	Инициализирует новый экземпляр HttpClient класса с предоставленным обработчиком и указывает, следует ли удалить этот обработчик при удалении этого экземпляра.
HttpClient(HttpMessageHandler)	Инициализирует новый экземпляр HttpClient класса с указанным обработчиком. Обработчик удаляется при удалении этого экземпляра.

Свойства

Имя	Описание
BaseAddress	Возвращает или задает базовый адрес универсального идентификатора ресурса (URI) ресурса Интернета, используемого при отправке запросов.
DefaultProxy	Возвращает или задает глобальный прокси-сервер HTTP.
DefaultRequestHeaders	Возвращает заголовки, которые должны отправляться с каждым запросом.
DefaultRequestVersion	Возвращает или задает версию HTTP по умолчанию, используемую для последующих запросов, сделанных этим HttpClient экземпляром.
DefaultVersionPolicy	Возвращает или задает политику версий по умолчанию для неявно созданных запросов в удобных методах, например GetAsync(String) и PostAsync(String, HttpContent).
MaxResponseContentBufferSize	Возвращает или задает максимальное количество байтов для буфера при чтении содержимого ответа.
Timeout	Возвращает или задает интервал времени ожидания до истечения времени ожидания запроса.

Методы

Имя	Описание
CancelPendingRequests()	Отмена всех ожидающих запросов на этом экземпляре.
DeleteAsync(String, CancellationToken)	Отправьте запрос DELETE в указанный URI с маркером отмены в качестве асинхронной операции.
DeleteAsync(String)	Отправьте запрос DELETE в указанный универсальный код ресурса (URI) в качестве асинхронной операции.
DeleteAsync(Uri, CancellationToken)	Отправьте запрос DELETE в указанный URI с маркером отмены в качестве асинхронной операции.
DeleteAsync(Uri)	Отправьте запрос DELETE в указанный универсальный код ресурса (URI) в качестве асинхронной операции.
Dispose()	Освобождает неуправляемые ресурсы и удаляет управляемые ресурсы, используемые параметром HttpMessageInvoker. (Унаследовано от HttpMessageInvoker)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые HttpClient и при необходимости удаляет управляемые ресурсы.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetAsync(String, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) с маркером отмены в виде асинхронной операции.
GetAsync(String, HttpCompletionOption, CancellationToken)	Отправьте запрос GET в указанный URI с параметром завершения HTTP и маркером отмены в качестве асинхронной операции.
GetAsync(String, HttpCompletionOption)	Отправьте запрос GET в указанный URI с параметром завершения HTTP в качестве асинхронной операции.
GetAsync(String)	Отправьте запрос GET в указанный универсальный код ресурса (URI) в качестве асинхронной операции.
GetAsync(Uri, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) с маркером отмены в виде асинхронной операции.
GetAsync(Uri, HttpCompletionOption, CancellationToken)	Отправьте запрос GET в указанный URI с параметром завершения HTTP и маркером отмены в качестве асинхронной операции.
GetAsync(Uri, HttpCompletionOption)	Отправьте запрос GET в указанный URI с параметром завершения HTTP в качестве асинхронной операции.
GetAsync(Uri)	Отправьте запрос GET в указанный универсальный код ресурса (URI) в качестве асинхронной операции.
GetByteArrayAsync(String, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает текст ответа в виде массива байтов в асинхронной операции.
GetByteArrayAsync(String)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает текст ответа в виде массива байтов в асинхронной операции.
GetByteArrayAsync(Uri, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде массива байтов в асинхронной операции.
GetByteArrayAsync(Uri)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде массива байтов в асинхронной операции.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetStreamAsync(String, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде потока в асинхронной операции.
GetStreamAsync(String)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде потока в асинхронной операции.
GetStreamAsync(Uri, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде потока в асинхронной операции.
GetStreamAsync(Uri)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде потока в асинхронной операции.
GetStringAsync(String, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде строки в асинхронной операции.
GetStringAsync(String)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде строки в асинхронной операции.
GetStringAsync(Uri, CancellationToken)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде строки в асинхронной операции.
GetStringAsync(Uri)	Отправьте запрос GET в указанный универсальный код ресурса (URI) и верните текст ответа в виде строки в асинхронной операции.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
PatchAsync(String, HttpContent, CancellationToken)	Отправляет запрос PATCH с маркером отмены в URI, представленный как строка в виде асинхронной операции.
PatchAsync(String, HttpContent)	Отправляет запрос PATCH в универсальный код ресурса (URI), назначенный как строка в качестве асинхронной операции.
PatchAsync(Uri, HttpContent, CancellationToken)	Отправляет запрос PATCH с маркером отмены в виде асинхронной операции.
PatchAsync(Uri, HttpContent)	Отправляет запрос PATCH в виде асинхронной операции.
PostAsync(String, HttpContent, CancellationToken)	Отправьте запрос POST с маркером отмены в виде асинхронной операции.
PostAsync(String, HttpContent)	Отправьте запрос POST в указанный URI в качестве асинхронной операции.
PostAsync(Uri, HttpContent, CancellationToken)	Отправьте запрос POST с маркером отмены в виде асинхронной операции.
PostAsync(Uri, HttpContent)	Отправьте запрос POST в указанный URI в качестве асинхронной операции.
PutAsync(String, HttpContent, CancellationToken)	Отправьте запрос PUT с маркером отмены в виде асинхронной операции.
PutAsync(String, HttpContent)	Отправьте запрос PUT в указанный универсальный код ресурса (URI) в виде асинхронной операции.
PutAsync(Uri, HttpContent, CancellationToken)	Отправьте запрос PUT с маркером отмены в виде асинхронной операции.
PutAsync(Uri, HttpContent)	Отправьте запрос PUT в указанный универсальный код ресурса (URI) в виде асинхронной операции.
Send(HttpRequestMessage, CancellationToken)	Отправляет HTTP-запрос с указанным маркером запроса и отмены.
Send(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Отправляет HTTP-запрос с указанным запросом, параметром завершения и маркером отмены.
Send(HttpRequestMessage, HttpCompletionOption)	Отправляет HTTP-запрос.
Send(HttpRequestMessage)	Отправляет HTTP-запрос с указанным запросом.
SendAsync(HttpRequestMessage, CancellationToken)	Отправка HTTP-запроса в виде асинхронной операции.
SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Отправка HTTP-запроса в виде асинхронной операции.
SendAsync(HttpRequestMessage, HttpCompletionOption)	Отправка HTTP-запроса в виде асинхронной операции.
SendAsync(HttpRequestMessage)	Отправка HTTP-запроса в виде асинхронной операции.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Методы расширения

Имя	Описание
DeleteFromJsonAsync(HttpClient, String, Type, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос DELETE в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, CancellationToken)	HTTP GETОтправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	HTTP GET Отправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	HTTP GETОтправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, CancellationToken)	HTTP GETОтправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	HTTP GETОтправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	HTTP GETОтправляет запрос указанному и requestUri возвращает значение, которое приводит к десериализации текста ответа в формате JSON в асинхронной операции перечисления.
GetFromJsonAsync(HttpClient, String, Type, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос GET в указанный универсальный код ресурса (URI) и возвращает значение, которое приводит к десериализации текста ответа в виде JSON в асинхронной операции.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос PATCH на указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправляет запрос POST в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Отправьте запрос PUT в указанный URI, value содержащий сериализованный как JSON в тексте запроса.

См. также раздел

• Рекомендации по использованию HttpClient
• Пример HttpClient