c# - 使用 HttpWebRequest 类上传和下载时以百分比显示进度

Question

我正在尝试使用 HttpWebRequest 上传和下载(在同一请求中)到服务器在 C#并且由于数据的大小相当大(考虑到网络速度)，我想向用户展示工作完成了多远以及还剩下多少(不是以秒为单位，而是以百分比为单位)。

我已经阅读了几个试图实现这一点的示例，但没有一个显示任何进度条。他们都只是使用 async在上传/下载时不要阻止 UI。他们主要专注于上传/下载，没有人尝试将它们都包含在同一个请求中。

由于我使用 .Net 4 作为我的目标框架，我无法实现 async方法我自己。如果您要建议任何异步操作，请使用 Begin...方法而不是 await关键词!谢谢。

Answer 1

你需要知道一些事情才能成功。

第 0 步:将 .NET 4.0 的文档放在手边:

HttpWebRequest

HttpWebResponse

如果你看 HttpWebRequest文档，你会看到 GetResponse()有两个名称相似的方法: BeginGetResponse()和 EndGetResponse() .这些方法使用最古老的 .NET 异步模式，称为“IAsyncResult 模式”。关于此模式的文本有数千页，如果需要详细信息，可以阅读教程。这是速成类(class):

对于方法 Foo() ，有一个BeginFoo()可以带参数并且必须返回 IAsyncResult 实现。此方法执行任务 Foo()执行，但在不阻塞当前线程的情况下完成工作。

如 BeginFoo()接受一个 AsyncCallback 参数，它希望你提供一个它在完成时将调用的委托(delegate)。 (这是知道它已完成的几种方法之一，但恰好是 HttpWebRequest 使用的技术。)

EndFoo()需要IAsyncResult返回者 BeginFoo()作为参数并返回相同的内容 Foo()返回。

接下来，您应该注意一个陷阱。控件有一个称为“线程关联”的属性，这意味着只有在创建控件的线程上工作时，才能与控件交互。这很重要，因为您提供给 BeginFoo() 的回调方法不能保证从该线程调用。处理这个实际上很容易:

每个控件都有一个 InvokeRequired属性是从错误线程调用的唯一安全属性。如果返回 true ，你知道你在一个不安全的线程上。

每个控件都有一个 Invoke()接受委托(delegate)参数并将在创建控件的线程上调用该委托(delegate)的方法。

抛开所有这些，让我们开始看看我在一个简单的 WinForms 应用程序中编写的一些代码，用于报告下载 Google 主页的进度。这应该类似于将解决您的问题的代码。它不是最好的代码，但它演示了概念。该表单有一个名为 progressBar1 的进度条。 ，我调用 GetWebContent()从一个按钮点击。

HttpWebRequest _request;
IAsyncResult _responseAsyncResult;

private void GetWebContent() {
    _request = WebRequest.Create("http://www.google.com") as HttpWebRequest;
    _responseAsyncResult = _request.BeginGetResponse(ResponseCallback, null);           
}

此代码启动 GetResponse() 的异步版本.我们需要存储请求和 IAsyncResult在字段中，因为 ResponseCallback()需要拨打 EndGetResponse() .一切尽在 GetWebContent()是在 UI 线程上，所以如果你想更新一些控件，在这里这样做是安全的。接下来， ResponseCallback() :

private void ResponseCallback(object state) {
    var response = _request.EndGetResponse(_responseAsyncResult) as HttpWebResponse;
    long contentLength = response.ContentLength;
    if (contentLength == -1) {
        // You'll have to figure this one out.
    }
    Stream responseStream = response.GetResponseStream();
    GetContentWithProgressReporting(responseStream, contentLength);
    response.Close();
}

它被迫采取 object参数由 AsyncCallback 委托(delegate)签名，但我没有使用它。它调用 EndGetResponse()与 IAsyncResult我们得到了更早的时间，现在我们可以继续进行，就好像我们没有使用异步调用一样。 但是由于这是一个异步回调，它可能在工作线程上执行，所以不要在此处直接更新任何控件。

无论如何，它从响应中获取内容长度，如果您想计算下载进度，则需要该长度。有时提供此信息的 header 不存在，您会得到 -1。这意味着您需要自己进行进度计算，并且必须找到其他方法来了解您正在下载的文件的总大小。在我的情况下，将变量设置为某个值就足够了，因为我不关心数据本身。

之后，它获取表示响应的流并将其传递给执行下载和进度报告的辅助方法:

private byte[] GetContentWithProgressReporting(Stream responseStream, long contentLength) {
    UpdateProgressBar(0);

    // Allocate space for the content
    var data = new byte[contentLength];
    int currentIndex = 0;
    int bytesReceived = 0;
    var buffer = new byte[256];
    do {
        bytesReceived = responseStream.Read(buffer, 0, 256);
        Array.Copy(buffer, 0, data, currentIndex, bytesReceived);
        currentIndex += bytesReceived;

        // Report percentage
        double percentage = (double)currentIndex / contentLength;
        UpdateProgressBar((int)(percentage * 100));
    } while (currentIndex < contentLength);

    UpdateProgressBar(100);
    return data;
}

这个方法仍然可能在一个工作线程上(因为它被回调调用)所以从这里更新控件仍然不安全。

该代码对于下载文件的示例很常见。它分配一些内存来存储文件。它分配一个缓冲区以从流中获取文件块。在循环中，它抓取一个块，将块放入更大的数组中，并计算进度百分比。当它下载了预期的字节数时，它会退出。这有点麻烦，但是如果您使用让您一次下载文件的技巧，您将无法中途报告下载进度。

(我觉得有必要指出一件事:如果你的块太小，你会很快更新进度条，这仍然会导致表单锁定。我通常保持 Stopwatch 运行并尽量不要每秒更新进度条两次以上，但还有其他方法可以限制更新。)

无论如何，剩下的唯一事情就是实际更新进度条的代码，它在自己的方法中是有原因的:

private void UpdateProgressBar(int percentage) {
    // If on a worker thread, marshal the call to the UI thread
    if (progressBar1.InvokeRequired) {
        progressBar1.Invoke(new Action<int>(UpdateProgressBar), percentage);
    } else {
        progressBar1.Value = percentage;
    }
}

如 InvokeRequired返回 true，它通过 Invoke() 调用自己.如果它恰好在正确的线程上，它会更新进度条。如果您碰巧使用 WPF，则有类似的方法来编码调用，但我相信它们是通过 Dispatcher 发生的。目的。

我知道很多。这就是为什么新 async 的部分原因东西太棒了。 IAsyncResult模式很强大，但不会从你那里抽象出很多细节。但即使在较新的模式中，您也必须跟踪更新进度条的安全时间。

需要考虑的事项:

这是示例代码。为简洁起见，我没有包含任何异常处理。

如果 GetResponse() 会抛出异常, 当你调用 EndGetResponse() 时，它会被抛出.

如果回调中发生异常而您尚未处理它，它将终止其线程而不是您的应用程序。对于新手异步程序员来说，这可能是奇怪而神秘的。

注意我说的内容长度!您可能认为您可以询问 Stream通过检查其 Length属性(property)，但我发现这不可靠。一个 Stream可以随意扔NotSupportedException或者如果不确定，则返回一个像 -1 这样的值，并且通常使用网络流，如果您没有事先被告知需要多少数据，那么您只能继续问，“还有更多吗？”

我没有说什么关于上传，因为:

我对上传不太熟悉。

您可以遵循类似的模式:您可能会使用 HttpWebRequest.BeginGetRequestStream()所以你可以异步写入你正在上传的文件。所有关于更新控件的警告都适用。