如何异步使用 HttpWebRequest (.NET, C#)？
【问题讨论】：
标签： c# .net asynchronous httprequest
跟进@Isak 的回答，这非常好。尽管如此，它最大的缺陷是它只会在响应状态为 200-299 时调用 responseAction。解决此问题的最佳方法是：
private void DoWithResponseAsync(HttpWebRequest request, Action<HttpWebResponse> responseAction)
{
Action wrapperAction = () =>
{
request.BeginGetResponse(new AsyncCallback((iar) =>
{
HttpWebResponse response;
try
{
response = (HttpWebResponse)((HttpWebRequest)iar.AsyncState).EndGetResponse(iar);
}
catch (WebException ex)
{
// It needs to be done like this in order to read responses with error status:
response = ex.Response as HttpWebResponse;
}
responseAction(response);
}), request);
};
wrapperAction.BeginInvoke(new AsyncCallback((iar) =>
{
var action = (Action)iar.AsyncState;
action.EndInvoke(iar);
}), wrapperAction);
}
然后@Isak 如下：
HttpWebRequest request;
// init your request...then:
DoWithResponse(request, (response) => {
var body = new StreamReader(response.GetResponseStream()).ReadToEnd();
Console.Write(body);
});
【讨论】：
自从发布了许多这些答案以来，.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;
}
使用异步方法：
String response = await MakeRequestAsync("http://example.com/");
更新：
此解决方案不适用于使用 WebRequest.GetResponseAsync() 而不是 WebRequest.GetResponse() 的 UWP 应用，并且它不会在适当的情况下调用 Dispose() 方法。 @dragansr 有一个很好的替代解决方案来解决这些问题。
【讨论】：
WebRequest.GetResponseAsync() 和 StreamReader.ReadToEndAync() 并等待。
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);
}
【讨论】：
到目前为止，最简单的方法是使用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 方法中，但请务必阅读以下内容：Unhandled exceptions in 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();
【讨论】：
到目前为止，每个人都错了，因为BeginGetResponse() 在当前线程上做了一些工作。来自documentation：
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);
});
【讨论】：
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);
}
}
【讨论】：
考虑答案：
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;
}
问候
【讨论】：
使用HttpWebRequest.BeginGetResponse()
HttpWebRequest webRequest;
void StartWebRequest()
{
webRequest.BeginGetResponse(new AsyncCallback(FinishWebRequest), null);
}
void FinishWebRequest(IAsyncResult result)
{
webRequest.EndGetResponse(result);
}
异步操作完成时调用回调函数。你至少需要从这个函数调用EndGetResponse()。
【讨论】：
webRequest.Proxy = null 以显着加快请求速度。