HttpClient Classe

Referência

Definição

Namespace:: System.Net.Http

Assembly:: System.Net.Http.dll

Assembly:: netstandard.dll

Origem:: HttpClient.cs

Origem:: HttpClient.cs

Origem:: HttpClient.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Fornece uma classe para enviar solicitações HTTP e receber respostas HTTP de um recurso identificado por um 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

Herança: Object

HttpMessageInvoker
HttpClient

Exemplos

// 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

Comentários

Para obter mais informações sobre essa API, consulte Comentários sobre a API Complementar para HttpClient.

Construtores

HttpClient()	Inicializa uma nova instância da classe HttpClient usando um HttpClientHandler que é descartado quando essa instância é descartada.
HttpClient(HttpMessageHandler)	Inicializa uma nova instância da classe HttpClient com o manipulador especificado. O manipulador é descartado quando essa instância é descartada.
HttpClient(HttpMessageHandler, Boolean)	Inicializa uma nova instância da classe HttpClient com o manipulador fornecido e especifica se esse manipulador deverá ser descartado quando essa instância for descartada.

Propriedades

BaseAddress	Obtém ou define o endereço básico do URI (Uniform Resource Identifier) do recurso da Internet usado ao enviar solicitações.
DefaultProxy	Obtém ou define o proxy HTTP global.
DefaultRequestHeaders	Obtém os cabeçalhos que devem ser enviados com cada solicitação.
DefaultRequestVersion	Obtém ou define a versão HTTP padrão usada em solicitações posteriores feitas por essa instância de HttpClient.
DefaultVersionPolicy	Obtém ou define a política de versão padrão para solicitações criadas implicitamente em métodos de conveniência, por exemplo, GetAsync(String) e PostAsync(String, HttpContent).
MaxResponseContentBufferSize	Obtém ou define o número máximo de bytes armazenados no buffer ao ler o conteúdo da resposta.
Timeout	Obtém ou define o período de tempo de espera antes que a solicitação expire.

Métodos

CancelPendingRequests()	Cancele todas as solicitações pendentes nessa instância.
DeleteAsync(String)	Envie uma solicitação DELETE para o URI especificado como uma operação assíncrona.
DeleteAsync(String, CancellationToken)	Envie uma solicitação DELETE para o URI especificado com um token de cancelamento como uma operação assíncrona.
DeleteAsync(Uri)	Envie uma solicitação DELETE para o URI especificado como uma operação assíncrona.
DeleteAsync(Uri, CancellationToken)	Envie uma solicitação DELETE para o URI especificado com um token de cancelamento como uma operação assíncrona.
Dispose()	Libera os recursos não gerenciados e descarta aqueles gerenciados usados pelo HttpMessageInvoker. (Herdado de HttpMessageInvoker)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo HttpClient e, opcionalmente, descarta os recursos gerenciados.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetAsync(String)	Envie uma solicitação GET para o URI especificado como uma operação assíncrona.
GetAsync(String, CancellationToken)	Envie uma solicitação GET para o URI especificado com um token de cancelamento como uma operação assíncrona.
GetAsync(String, HttpCompletionOption)	Envie uma solicitação GET para o URI especificado com uma opção de conclusão de HTTP como uma operação assíncrona.
GetAsync(String, HttpCompletionOption, CancellationToken)	Envie uma solicitação GET para o URI especificado com uma opção de conclusão de HTTP e um token de cancelamento como uma operação assíncrona.
GetAsync(Uri)	Envie uma solicitação GET para o URI especificado como uma operação assíncrona.
GetAsync(Uri, CancellationToken)	Envie uma solicitação GET para o URI especificado com um token de cancelamento como uma operação assíncrona.
GetAsync(Uri, HttpCompletionOption)	Envie uma solicitação GET para o URI especificado com uma opção de conclusão de HTTP como uma operação assíncrona.
GetAsync(Uri, HttpCompletionOption, CancellationToken)	Envie uma solicitação GET para o URI especificado com uma opção de conclusão de HTTP e um token de cancelamento como uma operação assíncrona.
GetByteArrayAsync(String)	Envia uma solicitação GET para o Uri especificado e retorna o corpo da resposta como uma matriz de bytes em uma operação assíncrona.
GetByteArrayAsync(String, CancellationToken)	Envia uma solicitação GET para o Uri especificado e retorna o corpo da resposta como uma matriz de bytes em uma operação assíncrona.
GetByteArrayAsync(Uri)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma matriz de bytes em uma operação assíncrona.
GetByteArrayAsync(Uri, CancellationToken)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma matriz de bytes em uma operação assíncrona.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetStreamAsync(String)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como um fluxo em uma operação assíncrona.
GetStreamAsync(String, CancellationToken)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como um fluxo em uma operação assíncrona.
GetStreamAsync(Uri)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como um fluxo em uma operação assíncrona.
GetStreamAsync(Uri, CancellationToken)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como um fluxo em uma operação assíncrona.
GetStringAsync(String)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma cadeia de caracteres em uma operação assíncrona.
GetStringAsync(String, CancellationToken)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma cadeia de caracteres em uma operação assíncrona.
GetStringAsync(Uri)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma cadeia de caracteres em uma operação assíncrona.
GetStringAsync(Uri, CancellationToken)	Envie uma solicitação GET para o URI especificado e retorne o corpo da resposta como uma cadeia de caracteres em uma operação assíncrona.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
PatchAsync(String, HttpContent)	Envia uma solicitação PATCH a um URI designado como uma cadeia de caracteres, como uma operação assíncrona.
PatchAsync(String, HttpContent, CancellationToken)	Envia uma solicitação PATCH com um token de cancelamento a um URI representado como uma cadeia de caracteres, como uma operação assíncrona.
PatchAsync(Uri, HttpContent)	Envia uma solicitação PATCH como uma operação assíncrona.
PatchAsync(Uri, HttpContent, CancellationToken)	Envia uma solicitação PATCH com um token de cancelamento como uma operação assíncrona.
PostAsync(String, HttpContent)	Envie uma solicitação POST para o URI especificado como uma operação assíncrona.
PostAsync(String, HttpContent, CancellationToken)	Envie uma solicitação POST com um token de cancelamento como uma operação assíncrona.
PostAsync(Uri, HttpContent)	Envie uma solicitação POST para o URI especificado como uma operação assíncrona.
PostAsync(Uri, HttpContent, CancellationToken)	Envie uma solicitação POST com um token de cancelamento como uma operação assíncrona.
PutAsync(String, HttpContent)	Envie uma solicitação PUT para o URI especificado como uma operação assíncrona.
PutAsync(String, HttpContent, CancellationToken)	Envie uma solicitação PUT com um token de cancelamento como uma operação assíncrona.
PutAsync(Uri, HttpContent)	Envie uma solicitação PUT para o URI especificado como uma operação assíncrona.
PutAsync(Uri, HttpContent, CancellationToken)	Envie uma solicitação PUT com um token de cancelamento como uma operação assíncrona.
Send(HttpRequestMessage)	Envia uma solicitação HTTP com a solicitação especificada.
Send(HttpRequestMessage, CancellationToken)	Envia uma solicitação HTTP com a solicitação e o token de cancelamento especificados.
Send(HttpRequestMessage, CancellationToken)	Envia uma solicitação HTTP com a solicitação e o token de cancelamento especificados. (Herdado de HttpMessageInvoker)
Send(HttpRequestMessage, HttpCompletionOption)	Envia uma solicitação HTTP.
Send(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Envia uma solicitação HTTP com a solicitação especificada, a opção de conclusão e o token de cancelamento.
SendAsync(HttpRequestMessage)	Envie uma solicitação HTTP como uma operação assíncrona.
SendAsync(HttpRequestMessage, CancellationToken)	Envie uma solicitação HTTP como uma operação assíncrona.
SendAsync(HttpRequestMessage, HttpCompletionOption)	Envie uma solicitação HTTP como uma operação assíncrona.
SendAsync(HttpRequestMessage, HttpCompletionOption, CancellationToken)	Envie uma solicitação HTTP como uma operação assíncrona.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Métodos de Extensão

DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync(HttpClient, String, Type, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
DeleteFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Envia uma solicitação DELETE para o Uri especificado e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envia uma solicitação `HTTP GET` para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação `HTTP GET`para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, String, CancellationToken)	Envia uma solicitação `HTTP GET`para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envia uma solicitação `HTTP GET`para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação `HTTP GET`para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsAsyncEnumerable<TValue>(HttpClient, Uri, CancellationToken)	Envia uma solicitação `HTTP GET`para o especificado `requestUri` e retorna o valor resultante da desserialização do corpo da resposta como JSON em uma operação enumerável assíncrona.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerOptions, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync(HttpClient, String, Type, JsonSerializerContext, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync(HttpClient, String, Type, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerOptions, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync(HttpClient, Uri, Type, JsonSerializerContext, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync(HttpClient, Uri, Type, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, String, JsonSerializerOptions, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, String, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, String, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonSerializerOptions, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, Uri, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
GetFromJsonAsync<TValue>(HttpClient, Uri, CancellationToken)	Envia uma solicitação GET para o URI especificado e retorna o valor resultante da desserialização do corpo da resposta como um JSON em uma operação assíncrona.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PatchAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PatchAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envia uma solicitação PATCH para o Uri especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PostAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envia uma solicitação POST ao URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, String, TValue, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonSerializerOptions, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, JsonTypeInfo<TValue>, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.
PutAsJsonAsync<TValue>(HttpClient, Uri, TValue, CancellationToken)	Envia uma solicitação PUT para o URI especificado que contém o `value` serializado como JSON no corpo da solicitação.

Aplica-se a

Compartilhar via