HttpClient Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет класс для отправки 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
- Наследование
Примеры
// 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) |
Инициализирует новый экземпляр класса HttpClient с указанным обработчиком. Обработчик удаляется при удалении этого экземпляра. |
HttpClient(HttpMessageHandler, Boolean) |
Инициализирует новый экземпляр класса HttpClient с предоставленным обработчиком и указывает, должен ли этот обработчик удаляться при удалении этого экземпляра. |
Свойства
BaseAddress |
Возвращает или задает базовый адрес универсального кода ресурса (URI) интернет-ресурса, используемого при отправке запросов. |
DefaultProxy |
Возвращает или устанавливает глобальный прокси-сервер HTTP. |
DefaultRequestHeaders |
Возвращает заголовки, которые должны отправляться с каждым запросом. |
DefaultRequestVersion |
Возвращает или задает версию HTTP по умолчанию, используемую в последующих запросах, выполняемых этим экземпляром HttpClient. |
DefaultVersionPolicy |
Возвращает или задает политику выбора версий по умолчанию для неявно созданных запросов в удобных методах, например GetAsync(String) и PostAsync(String, HttpContent). |
MaxResponseContentBufferSize |
Возвращает или задает максимальное число байтов в буфере при чтении содержимого отклика. |
Timeout |
Возвращает или задает время ожидания для выполнения запроса. |
Методы
CancelPendingRequests() |
Отмена всех ожидающих запросов на этом экземпляре. |
DeleteAsync(String) |
Отправка запроса DELETE согласно указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
DeleteAsync(String, CancellationToken) |
Отправка запроса DELETE к указанному URI с токеном отмены в качестве асинхронной операции. |
DeleteAsync(Uri) |
Отправка запроса DELETE согласно указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
DeleteAsync(Uri, CancellationToken) |
Отправка запроса DELETE к указанному URI с токеном отмены в качестве асинхронной операции. |
Dispose() |
Освобождает неуправляемые ресурсы и удаляет управляемые ресурсы, используемые объектом HttpMessageInvoker. (Унаследовано от HttpMessageInvoker) |
Dispose(Boolean) |
Освобождает неуправляемые ресурсы, используемые объектом HttpClient, и опционально удаляет управляемые ресурсы. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetAsync(String) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
GetAsync(String, CancellationToken) |
Отправка запроса DELETE указанному универсальному коду ресурса (URI) с токеном отмены в качестве асинхронной операции. |
GetAsync(String, HttpCompletionOption) |
Отправка запроса GET указанному универсальному коду ресурса (URI) с параметром "выполнение HTTP" в качестве асинхронной операции. |
GetAsync(String, HttpCompletionOption, CancellationToken) |
Отправка запроса GET к указанному универсальному коду ресурса (URI) с параметром "выполнение HTTP" и токеном отмены в качестве асинхронной операции. |
GetAsync(Uri) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
GetAsync(Uri, CancellationToken) |
Отправка запроса DELETE указанному универсальному коду ресурса (URI) с токеном отмены в качестве асинхронной операции. |
GetAsync(Uri, HttpCompletionOption) |
Отправка запроса GET указанному универсальному коду ресурса (URI) с параметром "выполнение HTTP" в качестве асинхронной операции. |
GetAsync(Uri, HttpCompletionOption, CancellationToken) |
Отправка запроса GET к указанному универсальному коду ресурса (URI) с параметром "выполнение HTTP" и токеном отмены в качестве асинхронной операции. |
GetByteArrayAsync(String) |
Отправляет запрос GET согласно указанному универсальному коду ресурса (URI) и возвращает текст ответа в виде массива байтов в асинхронной операции. |
GetByteArrayAsync(String, CancellationToken) |
Отправляет запрос GET согласно указанному универсальному коду ресурса (URI) и возвращает текст ответа в виде массива байтов в асинхронной операции. |
GetByteArrayAsync(Uri) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде массива байтов в асинхронной операции. |
GetByteArrayAsync(Uri, CancellationToken) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде массива байтов в асинхронной операции. |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetStreamAsync(String) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде потока в асинхронной операции. |
GetStreamAsync(String, CancellationToken) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде потока в асинхронной операции. |
GetStreamAsync(Uri) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде потока в асинхронной операции. |
GetStreamAsync(Uri, CancellationToken) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде потока в асинхронной операции. |
GetStringAsync(String) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде строки в асинхронной операции. |
GetStringAsync(String, CancellationToken) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде строки в асинхронной операции. |
GetStringAsync(Uri) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде строки в асинхронной операции. |
GetStringAsync(Uri, CancellationToken) |
Отправка запроса GET согласно указанному универсальному коду ресурса (URI) и возврат текста ответа в виде строки в асинхронной операции. |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
PatchAsync(String, HttpContent) |
Асинхронно отправляет запрос PATCH к универсальному коду ресурса (URI), заданному в виде строки. |
PatchAsync(String, HttpContent, CancellationToken) |
Асинхронно отправляет запрос PATCH с токеном отмены к универсальному коду ресурса (URI), представленному строкой. |
PatchAsync(Uri, HttpContent) |
Отправляет запрос PATCH в качестве асинхронной операции. |
PatchAsync(Uri, HttpContent, CancellationToken) |
Отправляет запрос PATCH с токеном отмены в качестве асинхронной операции. |
PostAsync(String, HttpContent) |
Отправка запроса POST по указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
PostAsync(String, HttpContent, CancellationToken) |
Отправка запроса POST с токеном отмены в качестве асинхронной операции. |
PostAsync(Uri, HttpContent) |
Отправка запроса POST по указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
PostAsync(Uri, HttpContent, CancellationToken) |
Отправка запроса POST с токеном отмены в качестве асинхронной операции. |
PutAsync(String, HttpContent) |
Отправка запроса PUT по указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
PutAsync(String, HttpContent, CancellationToken) |
Отправка запроса PUT с токеном отмены в качестве асинхронной операции. |
PutAsync(Uri, HttpContent) |
Отправка запроса PUT по указанному универсальному коду ресурса (URI) в качестве асинхронной операции. |
PutAsync(Uri, HttpContent, CancellationToken) |
Отправка запроса PUT с токеном отмены в качестве асинхронной операции. |
Send(HttpRequestMessage) |
Отправляет HTTP-запрос с указанным запросом. |
Send(HttpRequestMessage, CancellationToken) |
Отправляет HTTP-запрос с указанным запросом и маркером отмены. |
Send(HttpRequestMessage, CancellationToken) |
Отправляет HTTP-запрос с указанным запросом и маркером отмены. (Унаследовано от HttpMessageInvoker) |
Send(HttpRequestMessage, HttpCompletionOption) |
Отправляет HTTP-запрос. |
Send(HttpRequestMessage, HttpCompletionOption, CancellationToken) |
Отправляет HTTP-запрос с указанным запросом, параметром завершения и маркером отмены. |
SendAsync(HttpRequestMessage) |
Отправка HTTP-запроса в качестве асинхронной операции. |
SendAsync(HttpRequestMessage, CancellationToken) |
Отправка HTTP-запроса в качестве асинхронной операции. |
SendAsync(HttpRequestMessage, HttpCompletionOption) |
Отправка HTTP-запроса в качестве асинхронной операции. |
SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken) |
Отправка HTTP-запроса в качестве асинхронной операции. |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Методы расширения
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync(HttpClient, String, Type, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync(HttpClient, Uri, Type, 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, String, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
DeleteFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken) |
Отправляет запрос DELETE на указанный универсальный код ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в виде JSON в асинхронной операции. |
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken) |
|
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken) |
|
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, CancellationToken) |
|
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
|
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
|
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, CancellationToken) |
|
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync(HttpClient, String, Type, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync(HttpClient, Uri, Type, 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, String, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
GetFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken) |
Отправляет запрос GET по указанному универсальному коду ресурса (URI) и возвращает значение, полученное в результате десериализации текста ответа в формате JSON в ходе асинхронной операции. |
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Отправляет запрос PATCH на указанный универсальный код ресурса (URI), содержащий |
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PostAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Отправляет запрос POST по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken) |
Отправляет запрос PUT по указанному универсальному коду ресурса (URI), содержащий сериализованное значение |