ASP.NET 无刷新文件下载并提示完成的实现方案

核心实现原理

该方案的核心在于将“文件传输”与“状态反馈”分离：

1. 前端发起：使用 JavaScript 动态创建一个隐藏表单并提交，触发浏览器的原生下载行为。
2. 后端处理：C# 服务端接收请求，读取文件并通过 Response 对象输出二进制流。
3. 状态标记：文件流发送完毕后，服务端将当前会话或 IP 相关的 Cache 状态置为 “Y”。
4. 轮询检测：前端在启动下载的与此同时开启定时器，定期 AJAX 请求服务端获取该 Cache 值。一旦收到 “Y”，则清除缓存、停止轮询并弹出完成提示。

准备工作

• 环境：ASP.NET Web Forms 项目 (.NET Framework)。
• 依赖库：jQuery (示例中使用 v1.8.2)。
• 基础代码：System.IO 用于文件操作，System.Web 用于 HTTP 响应控制。

第 1 步：构建前端 HTML 与逻辑

目的：创建下载入口，封装下载请求逻辑，并建立状态轮询机制。

界面元素：

• #downfile：文本框，用于输入要下载的文件名。
• #btnDownLoad：按钮，触发下载。
• #loadingbox：显示“加载中...”的状态提示层。

JavaScript 逻辑说明：

当点击按钮时，生成唯一的 downId 作为前后端通信的令牌。随后调用 DownLoad 函数创建表单并提交，并同时启动一个每 3 秒执行一次的计时器，向后端 WebForm2.aspx 发送 POST 请求询问进度。

$(function () {
    $("#btnDownLoad").on("click", function () {
        var $loading = $("#loadingbox");
        // 使用时间戳和随机数生成唯一ID，防止并发冲突
        var downId = new Date().getTime() + "-" + Math.random();
        
        $loading.css("display", "block");
        DownLoad($("#downfile").val(), downId);
        
        // 启动轮询定时器
        var tid = setInterval(function () {
            $.post("WebForm2.aspx", { getresult: "Y", downid: downId }, function (result) {
                if (result == "Y") {
                    clearInterval(tid); // 找到结果，清除定时任务
                    $loading.css("display", "none");
                    alert("下载完成！");
                }
            });
        }, 3000);
    });

    function DownLoad(filename, downid) {
        // 动态创建form以避免页面跳转
        var $form = $("<form target='' method='post' action='WebForm2.aspx'></form>");
        $form.append("<input type='hidden' name='filename' value='" + filename + "'>");
        $form.append("<input type='hidden' name='downid' value='" + downid + "'>");
        $('body').append($form);
        $form.submit();
    }
});

第 2 步：编写 C# 服务端处理代码

目的：解析文件名与 ID，执行文件输出，并在完成后更新 Cache。

在后端 Page_Load 事件中，需区分两种请求：

1. 普通下载请求：包含 filename 和 downid，执行文件流输出。
2. 查询请求：仅包含 getresult 和 downid，返回当前的完成状态并清理已完成的缓存。

using System;
using System.Web;
using System.IO;

namespace WebApplication1
{
    public partial class WebForm2 : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            if (Request.HttpMethod == "POST")
            {
                string getresult = Request.Form["getresult"];
                string downId = Request.Form["downid"];
                // Key 包含 IP，防止不同客户端之间的干扰
                string cacheKey = string.Format("downloadcompleted-{0}-{1}", downId, Request.UserHostAddress);

                // --- 分支1：前端轮询状态 ---
                if (getresult == "Y") 
                {
                    string result = (Cache[cacheKey] ?? "N").ToString();
                    Response.Clear();
                    Response.Write(result);
                    // 如果查到了 Y，说明下载已完成，此时清除此标记，避免重复消费
                    if (result == "Y") 
                    {
                        Cache.Remove(cacheKey);
                    }
                    Response.End();
                    return;
                }

                // --- 分支2：实际下载文件 ---
                string fileName = Request.Form["filename"];
                // 确保路径安全，防止目录遍历攻击，根据实际项目调整验证逻辑
                string localFilePath = Server.MapPath("~/" + fileName);
                
                if (!File.Exists(localFilePath))
                {
                    Response.StatusCode = 404;
                    Response.End();
                    return;
                }

                System.IO.FileInfo file = new System.IO.FileInfo(localFilePath);
                
                // 配置响应头
                Response.Clear();
                Response.ClearHeaders();
                Response.Buffer = false;
                Response.AddHeader("Content-Disposition", "attachment;filename=" + file.Name);
                Response.AddHeader("Content-Length", file.Length.ToString());
                Response.ContentType = "application/octet-stream";

                // 输出文件流
                Response.WriteFile(file.FullName);
                Response.Flush();

                // 关键步骤：文件发送完毕后，设置 Cache 为 "Y"
                // 这将被前端的轮询请求检测到
                Cache.Insert(cacheKey, "Y");
                
                Response.End();
            }
        }
    }
}

运行效果与注意事项

兼容性测试：经过多浏览器及大文件压力测试，此方式兼容性良好。

进阶优化建议：上述方案主要解决了“下载完成”的通知。若需要更完善的体验（如显示下载进度条），可以扩展 Cache 的逻辑。后端分块输出时记录字节偏移量并更新 Cache 中的百分比；前端轮询时解析百分比并渲染进度条。此外，在现代 Web 开发中，也可以考虑使用 HTML5 WebSocket 技术来替代轮询，以实现更实时的双向通信。

以上就是 ASP.NET 无刷新文件下载并提示下载完成的相关内容，更多关于 C# Web 开发的实用技巧请关注本站其它相关文章！