Jak asynchronicznie używać HttpWebRequest (.NET)?

Jak mogę asynchronicznie używać HttpWebRequest (.NET, C #)?

Posługiwać się HttpWebRequest.BeginGetResponse()

HttpWebRequest webRequest;

void StartWebRequest()
{
    webRequest.BeginGetResponse(new AsyncCallback(FinishWebRequest), null);
}

void FinishWebRequest(IAsyncResult result)
{
    webRequest.EndGetResponse(result);
}

Funkcja wywołania zwrotnego jest wywoływana po zakończeniu operacji asynchronicznej. Musisz przynajmniej zadzwonić EndGetResponse()z tej funkcji.

Biorąc pod uwagę odpowiedź:

HttpWebRequest webRequest;

void StartWebRequest()
{
    webRequest.BeginGetResponse(new AsyncCallback(FinishWebRequest), null);
}

void FinishWebRequest(IAsyncResult result)
{
    webRequest.EndGetResponse(result);
}

Możesz wysłać wskaźnik żądania lub dowolny inny obiekt, taki jak ten:

void StartWebRequest()
{
    HttpWebRequest webRequest = ...;
    webRequest.BeginGetResponse(new AsyncCallback(FinishWebRequest), webRequest);
}

void FinishWebRequest(IAsyncResult result)
{
    HttpWebResponse response = (result.AsyncState as HttpWebRequest).EndGetResponse(result) as HttpWebResponse;
}

Pozdrowienia

Do tej pory wszyscy się mylili, ponieważ BeginGetResponse()trochę popracuje nad bieżącym wątkiem. Z dokumentacji :

Metoda BeginGetResponse wymaga ukończenia niektórych synchronicznych zadań konfiguracyjnych (na przykład rozpoznawania nazw DNS, wykrywania serwera proxy i połączenia przez gniazdo TCP), zanim ta metoda stanie się asynchroniczna. W rezultacie ta metoda nigdy nie powinna być wywoływana w wątku interfejsu użytkownika (UI), ponieważ ukończenie początkowych zadań synchronicznej konfiguracji może zająć dużo czasu (do kilku minut w zależności od ustawień sieci), zanim zostanie zgłoszony wyjątek dla błędu lub metoda się powiodła.

Aby to zrobić dobrze:

void DoWithResponse(HttpWebRequest request, Action<HttpWebResponse> responseAction)
{
    Action wrapperAction = () =>
    {
        request.BeginGetResponse(new AsyncCallback((iar) =>
        {
            var response = (HttpWebResponse)((HttpWebRequest)iar.AsyncState).EndGetResponse(iar);
            responseAction(response);
        }), request);
    };
    wrapperAction.BeginInvoke(new AsyncCallback((iar) =>
    {
        var action = (Action)iar.AsyncState;
        action.EndInvoke(iar);
    }), wrapperAction);
}

Następnie możesz zrobić z odpowiedzią, co musisz. Na przykład:

HttpWebRequest request;
// init your request...then:
DoWithResponse(request, (response) => {
    var body = new StreamReader(response.GetResponseStream()).ReadToEnd();
    Console.Write(body);
});

Zdecydowanie najłatwiejszym sposobem jest użycie TaskFactory.FromAsync z TPL . To dosłownie kilka wierszy kodu w połączeniu z nowymi słowami kluczowymi async / await :

var request = WebRequest.Create("http://www.stackoverflow.com");
var response = (HttpWebResponse) await Task.Factory
    .FromAsync<WebResponse>(request.BeginGetResponse,
                            request.EndGetResponse,
                            null);
Debug.Assert(response.StatusCode == HttpStatusCode.OK);

Jeśli nie możesz użyć kompilatora C # 5, powyższe można wykonać za pomocą metody Task.ContinueWith :

Task.Factory.FromAsync<WebResponse>(request.BeginGetResponse,
                                    request.EndGetResponse,
                                    null)
    .ContinueWith(task =>
    {
        var response = (HttpWebResponse) task.Result;
        Debug.Assert(response.StatusCode == HttpStatusCode.OK);
    });

Skończyło się na korzystaniu z BackgroundWorker, jest on zdecydowanie asynchroniczny, w przeciwieństwie do niektórych z powyższych rozwiązań, obsługuje powrót do wątku GUI za Ciebie i jest bardzo łatwy do zrozumienia.

Obsługa wyjątków jest również bardzo łatwa, ponieważ kończą się one w metodzie RunWorkerCompleted, ale przeczytaj to: Nieobsłużone wyjątki w BackgroundWorker

Użyłem WebClient, ale oczywiście możesz użyć HttpWebRequest.GetResponse, jeśli chcesz.

var worker = new BackgroundWorker();

worker.DoWork += (sender, args) => {
    args.Result = new WebClient().DownloadString(settings.test_url);
};

worker.RunWorkerCompleted += (sender, e) => {
    if (e.Error != null) {
        connectivityLabel.Text = "Error: " + e.Error.Message;
    } else {
        connectivityLabel.Text = "Connectivity OK";
        Log.d("result:" + e.Result);
    }
};

connectivityLabel.Text = "Testing Connectivity";
worker.RunWorkerAsync();

public static async Task<byte[]> GetBytesAsync(string url) {
    var request = (HttpWebRequest)WebRequest.Create(url);
    using (var response = await request.GetResponseAsync())
    using (var content = new MemoryStream())
    using (var responseStream = response.GetResponseStream()) {
        await responseStream.CopyToAsync(content);
        return content.ToArray();
    }
}

public static async Task<string> GetStringAsync(string url) {
    var bytes = await GetBytesAsync(url);
    return Encoding.UTF8.GetString(bytes, 0, bytes.Length);
}

.NET zmienił się od czasu opublikowania wielu z tych odpowiedzi i chciałbym podać bardziej aktualną odpowiedź. Użyj metody asynchronicznej, aby rozpocząć Taskdziałanie w wątku w tle:

private async Task<String> MakeRequestAsync(String url)
{    
    String responseText = await Task.Run(() =>
    {
        try
        {
            HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
            WebResponse response = request.GetResponse();            
            Stream responseStream = response.GetResponseStream();
            return new StreamReader(responseStream).ReadToEnd();            
        }
        catch (Exception e)
        {
            Console.WriteLine("Error: " + e.Message);
        }
        return null;
    });

    return responseText;
}

Aby użyć metody asynchronicznej:

String response = await MakeRequestAsync("http://example.com/");

Aktualizacja:

To rozwiązanie nie działa w przypadku aplikacji platformy UWP, które używają WebRequest.GetResponseAsync()zamiast WebRequest.GetResponse()i nie wywołuje Dispose()metod w odpowiednich przypadkach. @dragansr ma dobre alternatywne rozwiązanie, które rozwiązuje te problemy.

public void GetResponseAsync (HttpWebRequest request, Action<HttpWebResponse> gotResponse)
    {
        if (request != null) { 
            request.BeginGetRequestStream ((r) => {
                try { // there's a try/catch here because execution path is different from invokation one, exception here may cause a crash
                    HttpWebResponse response = request.EndGetResponse (r);
                    if (gotResponse != null) 
                        gotResponse (response);
                } catch (Exception x) {
                    Console.WriteLine ("Unable to get response for '" + request.RequestUri + "' Err: " + x);
                }
            }, null);
        } 
    }