首页 ❯

如何在生成文件以供下载时显示加载动画？

php javascript jquery
2022-08-30 19:28:33

我有一个Web应用程序，用户可以在其中生成PDF和PowerPoint文件。这些文件可能需要一些时间来生成，因此我希望能够在生成时显示加载动画。这里的问题是，我没有办法知道下载何时开始。动画永远不会消失。

我知道可以使用AJAX在“侧面”生成文件，并在文件准备好下载时提醒用户，但我更喜欢在用户等待下载开始时“锁定”用户。


答案 1

为了理解这里需要做什么，让我们看看这种请求通常会发生什么。

  1. 用户单击该按钮以请求文件。

  2. 生成文件需要一些时间（用户不会收到任何反馈）。

  3. 文件已完成并开始发送给用户。

我们想添加的是一个反馈，让用户知道我们在做什么......在步骤1和2之间，我们需要对点击做出反应，并且我们需要找到一种方法来检测步骤3何时发生以删除视觉反馈。我们不会让用户了解下载状态，他们的浏览器将像任何其他下载一样这样做，我们只是想告诉用户我们正在处理他们的请求。

为了使文件生成脚本与我们的请求者页面的脚本进行通信，我们将使用cookie，这将确保我们不依赖于浏览器的事件，iframe或类似内容。在测试了多种解决方案之后，这似乎是从IE7到最新手机最稳定的解决方案。

步骤 1.5：显示图形反馈。

我们将使用javascript在屏幕上显示通知。我在整个页面上选择了一个简单的透明黑色叠加层，以防止用户与页面的其他元素进行交互，因为跟随链接可能会使他失去接收文件的可能性。

$('#downloadLink').click(function() {
  $('#fader').css('display', 'block');
});
#fader {
  opacity: 0.5;
  background: black;
  position: fixed;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  display: none;
}
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

<body>
  <div id="fader"></div>

  <a href="#path-to-file-generator" id="downloadLink">Click me to receive file!</a>
</body>

步骤 3.5：删除图形显示。

简单的部分已经完成，现在我们需要通知JavaScript该文件正在下载。当文件发送到浏览器时，它将使用通常的HTTP标头发送，这使我们能够更新客户端cookie。我们将利用此功能提供适当的视觉反馈。让我们修改上面的代码，我们需要设置cookie的起始值，并监听它的修改。

var setCookie = function(name, value, expiracy) {
  var exdate = new Date();
  exdate.setTime(exdate.getTime() + expiracy * 1000);
  var c_value = escape(value) + ((expiracy == null) ? "" : "; expires=" + exdate.toUTCString());
  document.cookie = name + "=" + c_value + '; path=/';
};

var getCookie = function(name) {
  var i, x, y, ARRcookies = document.cookie.split(";");
  for (i = 0; i < ARRcookies.length; i++) {
    x = ARRcookies[i].substr(0, ARRcookies[i].indexOf("="));
    y = ARRcookies[i].substr(ARRcookies[i].indexOf("=") + 1);
    x = x.replace(/^\s+|\s+$/g, "");
    if (x == name) {
      return y ? decodeURI(unescape(y.replace(/\+/g, ' '))) : y; //;//unescape(decodeURI(y));
    }
  }
};

$('#downloadLink').click(function() {
  $('#fader').css('display', 'block');
  setCookie('downloadStarted', 0, 100); //Expiration could be anything... As long as we reset the value
  setTimeout(checkDownloadCookie, 1000); //Initiate the loop to check the cookie.
});
var downloadTimeout;
var checkDownloadCookie = function() {
  if (getCookie("downloadStarted") == 1) {
    setCookie("downloadStarted", "false", 100); //Expiration could be anything... As long as we reset the value
    $('#fader').css('display', 'none');
  } else {
    downloadTimeout = setTimeout(checkDownloadCookie, 1000); //Re-run this function in 1 second.
  }
};
#fader {
  opacity: 0.5;
  background: black;
  position: fixed;
  top: 0;
  right: 0;
  bottom: 0;
  left: 0;
  display: none;
}
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

<body>
  <div id="fader"></div>

  <a href="#path-to-file-generator" id="downloadLink">Click me to receive file!</a>
</body>

好的，我们在这里添加了什么。我已经把我使用的set/getCookie函数放了出来，我不知道它们是否是最好的，但它们工作得很好。当我们启动下载时，我们将cookie值设置为0，这将确保任何其他过去的执行都不会干扰。我们还启动一个“超时循环”，以每秒检查一次 Cookie 的值。这是代码中最有争议的部分，使用超时循环函数调用等待cookie更改发生可能不是最好的，但它一直是在所有浏览器上实现这一点的最简单方法。因此，我们每秒检查cookie值，如果该值设置为1，我们将隐藏褪色的视觉效果。

更改 Cookie 服务器端

在 PHP 中，人们会这样做：

setCookie("downloadStarted", 1, time() + 20, '/', "", false, false);

在 ASP.Net

Response.Cookies.Add(new HttpCookie("downloadStarted", "1") { Expires = DateTime.Now.AddSeconds(20) });

Cookie的名称是 ，它的值为 ，它过期（我们每秒检查一次，所以20就足够了，如果你改变javascript中的超时值，请更改这个值），它的路径在整个域上（根据你的喜好改变这个），它不安全，因为它不包含敏感数据，它不是HTTP，所以我们的JavaScript可以看到它。downloadStarted1NOW + 20seconds

瞧！这就是总结。请注意，提供的代码在我正在使用的生产应用程序上可以完美地工作，但可能不适合您的确切需求，请根据您的喜好进行更正。


答案 2

这是Salketer优秀答案的简化版本。它只是检查cookie是否存在，而不考虑其价值。

提交表单后，它将每秒轮询一次cookie的存在。如果 Cookie 存在，则下载仍在处理中。否则，下载即告完成。有 2 分钟的超时。

HTML/JS 页面：

var downloadTimer;  // reference to timer object

function startDownloadChecker(buttonId, imageId, timeout) {
    var cookieName = "DownloadCompleteChecker";
    var downloadTimerAttempts = timeout;    // seconds

    setCookie(cookieName, 0, downloadTimerAttempts);

    // set timer to check for cookie every second
    downloadTimer = window.setInterval(function () {
        var cookie = getCookie(cookieName);

        // if cookie doesn't exist, or attempts have expired, re-enable form
        if ((typeof cookie === 'undefined') || (downloadTimerAttempts == 0)) {
            $("#" + buttonId).removeAttr("disabled");
            $("#" + imageId).hide();
            window.clearInterval(downloadTimer);
            expireCookie(cookieName);
        }

        downloadTimerAttempts--;
    }, 1000);
}

// form submit event
$("#btnSubmit").click(function () {
    $(this).attr("disabled", "disabled");  // disable form submit button
    $("#imgLoading").show();  // show loading animation
    startDownloadChecker("btnSubmit", "imgLoading", 120);
});

<form method="post">
    ...fields...
    <button id="btnSubmit">Submit</button>
    <img id="imgLoading" src="spinner.gif" style="display:none" />
</form>

支持Javascript设置/获取/删除cookie：

function setCookie(name, value, expiresInSeconds) {
    var exdate = new Date();
    exdate.setTime(exdate.getTime() + expiresInSeconds * 1000);
    var c_value = escape(value) + ((expiresInSeconds == null) ? "" : "; expires=" + exdate.toUTCString());
    document.cookie = name + "=" + c_value + '; path=/';
};
function getCookie(name) {
    var parts = document.cookie.split(name + "=");
    if (parts.length == 2) return parts.pop().split(";").shift();
}
function expireCookie(name) {
    document.cookie = encodeURIComponent(name) + "=; path=/; expires=" + new Date(0).toUTCString();
}

ASP.Net 中的服务器端代码：

...generate big document...

// attach expired cookie to response to signal download is complete
var cookie = new HttpCookie("DownloadCompleteChecker");  // same cookie name as above!
cookie.Expires = DateTime.Now.AddDays(-1d);  // expires yesterday
HttpContext.Current.Response.Cookies.Add(cookie); // Add cookie to response headers
HttpContext.Current.Response.Flush();  // send response

希望有所帮助！:)


推荐
更多 »
标签
更多 »
php pass-by-reference optional-parameters default-value javascript arrays dom function string object serialization tostring visibility syntax jslint use-strict operators equality equality-operator identity-operator datetime timestamp date-arithmetic redirect angularjs loops foreach iteration scope variables
推荐
更多 »