ASP.NET MVC中通过Ajax生成并下载Excel文件的实现方案

作者:资源驿站时间:2026-10-30 17:03:13浏览:376

本文介绍在ASP.NET MVC中利用Ajax生成并下载Excel文件的完整流程。核心思路是先由后端生成文件保存至服务器临时目录,返回文件路径后前端跳转触发下载,并通过自定义Action Filter在响应结束后自动删除临时文件,确保服务器空间不被占用。

ASP.NET MVC Ajax下载Excel文件实现方案

很久没有撰写技术文章,今天分享一种在ASP.NET MVC环境中通过Ajax实现文件生成与下载的方法,以下内容为个人实践总结。

在ASP.NET MVC中,通过Ajax调用后台控制器通常返回JSON对象,而无法直接返回文件流(若需直接返回文件则需刷新页面,这便失去了Ajax异步的优势)。因此,若希望使用Ajax生成并下载文件,策略是将生成的文件先保存至服务器指定位置,随后通过JSON返回文件路径,前端获取路径后再执行下载操作。鉴于这是临时性存储,下载完成后必须立即删除对应的文件。

以下以动态生成Excel文件为例进行说明(生成Excel的具体逻辑非本文重点,故省略具体实现细节):

生成Excel文件的Action实现

第一步,创建用于生成Excel文件的Action。


[HttpPost]
public JsonResult ExportExcel()
{
  DataTable dt = DataService.GetData();
  var fileName = "Excel_" + DateTime.Now.ToString("yyyyMMddHHmm") + ".xls";
  //將生成的文件保存到服務器的臨時目錄里
  string fullPath = Path.Combine(Server.MapPath("~/temp"), fileName);
 
  using (var exportData = new MemoryStream())
  {
    //如何生成Excel這里就不詳細說明啦,我這里對Excel的操作使用的是 NPOI
    Utility.WriteDataTableToExcel(dt, ".xls", exportData);
 
    FileStream file = new FileStream(fullPath, FileMode.Create, FileAccess.Write);
    exportData.WriteTo(file);
    file.Close();
  }
 
  var errorMessage = "you can return the errors in here!";
 
  //返回生成的文件名
  return Json(new { fileName = fileName, errorMessage = "" });
}

处理文件下载的Action实现

第二步,创建专门用于处理文件下载的Action。


[HttpGet]
[DeleteFileAttribute] //Action Filter, 下載完后自動刪除文件,這個屬性稍後解釋
public ActionResult Download(string file)
{
  //到服務器臨時文件目錄下載相應的文件
  string fullPath = Path.Combine(Server.MapPath("~/temp"), file);
  //返回文件對象,這里用的是Excel,所以文件頭使用了 "application/vnd.ms-excel"
  return File(fullPath, "application/vnd.ms-excel", file);
}

自动清理临时文件的Action Filter

第三步,为了实现下载完成后自动删除文件的功能,需要创建一个Action Filter。


public class DeleteFileAttribute : ActionFilterAttribute
{
  public override void OnResultExecuted(ResultExecutedContext filterContext)
  {
    filterContext.HttpContext.Response.Flush();
    //將當前filter context轉換成具體操作的文件并獲取文件路徑
    string filePath = (filterContext.Result as FilePathResult).FileName;
    //有文件路徑后就可以直接刪除相關文件了
    System.IO.File.Delete(filePath);
  }
}

前端Ajax调用代码示例

第四步,在前端页面添加Ajax调用代码以实现交互。


//這里我使用了 blockUI 做loading...
$.blockUI({ message: '<h3>Please wait a moment...</h3>' });  
$.ajax({
  type: "POST",
  url: '@Url.Action("ExportExcel","YourController")', //調用相應的controller/action
  contentType: "application/json; charset=utf-8",
  dataType: "json",
}).done(function (data) {
  //console.log(data.result);
  $.unblockUI();
  //接收返回的文件路徑,此文件這時已保存到服務器上了
  if (data.fileName != "") {
    //通過調用 window.location.href 直接跳轉到下載 action 進行文件下載操作
    window.location.href = "@Url.RouteUrl(new { Controller = "YourController", Action = "Download"})/?file=" + data.fileName;
  }
});

第五步,完成配置。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持本站。

作者最新文章