HttpWebRequest（.NET）を非同期で使用する方法

HttpWebRequest（.NET、C＃）を非同期で使用するにはどうすればよいですか？

使用する HttpWebRequest.BeginGetResponse()

HttpWebRequest webRequest;

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

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

コールバック関数は、非同期操作が完了すると呼び出されます。少なくともEndGetResponse()この関数から呼び出す必要があります。

答えを考える：

HttpWebRequest webRequest;

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

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

リクエストポインタまたは次のような他のオブジェクトを送信できます。

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

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

ご挨拶

BeginGetResponse()現在のスレッドでいくつかの作業を行っているため、これまでのところ誰もが間違っています。ドキュメントから：

BeginGetResponseメソッドは、このメソッドが非同期になる前に、いくつかの同期セットアップタスク（DNS解決、プロキシ検出、TCPソケット接続など）を完了する必要があります。結果として、エラーの例外がスローされる前に初期同期セットアップタスクを完了するのにかなりの時間がかかる場合があるため（ネットワーク設定によっては最大数分）、このメソッドをユーザーインターフェイス（UI）スレッドで呼び出さないでください。メソッドは成功します。

これを正しく行うには：

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);
}

その後、応答で必要なことを実行できます。例えば：

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

はるかに簡単な方法は、TPLからTaskFactory.FromAsyncを使用することです。新しい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);

C＃5コンパイラを使用できない場合は、Task.ContinueWithメソッドを使用して上記を実現できます。

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

結局、BackgroundWorkerを使用しました。上記のソリューションの一部とは異なり、非同期であり、GUIスレッドへの戻りを処理し、非常に簡単に理解できます。

例外はRunWorkerCompletedメソッドで終了するため、例外の処理も非常に簡単ですが、必ず読んでください。BackgroundWorkerでの未処理の例外

私はWebClientを使用しましたが、必要に応じてHttpWebRequest.GetResponseを使用できます。

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は変更されました。より最新の回答を提供したいと思います。非同期メソッドを使用Taskして、バックグラウンドスレッドで実行されるを開始します。

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;
}

asyncメソッドを使用するには：

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

更新：

このソリューションは、のWebRequest.GetResponseAsync()代わりにを使用するUWPアプリWebRequest.GetResponse()では機能せずDispose()、必要に応じてメソッドを呼び出しません。@dragansrには、これらの問題に対処する優れた代替ソリューションがあります。

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);
        } 
    }