如何检查Web API中的文件下载是否完整

时间:2015-07-10 07:55:15

标签: javascript jquery asp.net-web-api export-to-excel

我正在开展一项用户可以以excel格式下载数据的任务。 数据是动态生成的(作为通用列表),然后写成excel文件,这是完美的。

问题:

我面临的问题是,当数据量巨大时,下载文件需要几秒钟。在此期间,我需要向最终用户显示某种进度/指示(比方说,下载....消息)。使用当前代码,我无法跟踪文件下载何时完成...

这是我的代码

传递web api方法和搜索条件的JS代码

var request = {};
request.Code = codeDdl.find(':selected').val();

$.blockUI({ message: '<h3>Downloading...</h3>' });
//Export to Excel all records
$().largeDownload("api/FileDownload/GetWorkQueueList", {
   'request': JSON.stringify(request)
});

读取搜索条件并将其传递给web api方法的JS代码:

(function (d) {
    d.fn.largeDownload = function (a, b, c) { void 0 !== c ? (c = c.toUpperCase(), "GET" != c && (c = "POST")) : c = "POST"; if (void 0 === b || !1 == b) b = d().parse_url(a), a = b.url, b = b.params; var e = d("<form></form"); e.attr("method", c); e.attr("action", a); for (var f in b) a = d("<input />"), a.attr("type", "hidden"), a.attr("name", f), a.attr("value", b[f]), a.appendTo(e); d("body").append(e); e.bind("submit", DownloadedCallback); e.submit() }; d.fn.parse_url = function (a) {
        if (-1 == a.indexOf("?")) return { url: a, params: {} }; var b = a.split("?"), a = b[0], c = {}, b = b[1].split("&"), e = {}, d; for (d in b) {
            var g =
            b[d].split("="); e[g[0]] = g[1]
        } c.url = a; c.params = e; return c
    }
})(jQuery);

Web API

    [HttpPost]
    public HttpResponseMessage GetWorkQueueList()
    {
        var resp = new HttpResponseMessage(HttpStatusCode.OK);
        var currentContext = HttpContext.Current;

        try
        {
            string strRequest = currentContext.Request.Form["request"];
            var serializer = new JavaScriptSerializer();
            var request = serializer.Deserialize<ViewRequest>(strRequest);
            request.QueryAllRecords = true;
            var workQueueList = MappingManager.GetWorkQueueList(request);

            var legacyExcelView = //get data as generic list
            ....
            ....

            var fileBytes = ExcelManager.GetExcelData<WQExcelView>(legacyExcelView);
            var stream = new MemoryStream(fileBytes);
            resp.Content = new StreamContent(stream);
            resp.Content.Headers.ContentType = new MediaTypeHeaderValue("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            resp.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment") { FileName = "WorkQueueList.xlsx" };
            resp.Content.Headers.Add("Content-Encoding", "UTF-8");
            return resp;
        }
        catch (Exception ex)
        {                
            resp.Content = new StringContent(ex.Message);
            return resp;
        }
    }

我尝试了什么:

在largeDownload javascript函数中,我添加了DownloadedCallback,它似乎没有像我期望的那样工作。它会在下载完成之前立即触发。

问题:

如何在Web API方法中检查文件下载是否完整...在显示文件下载对话框之前,如何显示进度条?

1 个答案:

答案 0 :(得分:0)

我们通常使用2-3个API调用解决问题。我们的应用程序是用Java编写的;但是,同样的基本原则适用于此。

第一个调用是在单独的线程中启动大型SQL查询,大型文件创建等。该请求立即返回,有时带有id来引用原始请求。

当CSV中的行正在生成的线程中写入时,我们在原始线程中写入两个属性值,用于处理的行数和总行数。如果它是一个大的SQL语句,我们经常将语句本身批处理为几个有限的SQL语句,以便可以逐步设置进度值并显示,而不是暂时保持0%,然后捕捉到100%。打破SQL语句通常只需要几毫秒的额外成本,但在用户体验方面提供了大量的价值。

我们有一个轮询的第二个API调用,然后返回已处理数量和总计数的属性值。这是我们用来动画我们的进度条的内容。如果该命令的响应发生100%或状态标志发生变化,我们通常会在单独的API调用中请求完成的文件。您也可以在同一进度调用中返回文件指针/路径。