如何用AJAX和MVC实现文件下载

Question

我想通过在 MVC 下使用带有一些参数的 jQuery AJAX 调用来提供文件下载操作

例子

(javascript)
function DoDownload(startDate) {

  $.ajax({ 
     url:"controller/GetFile/",
     data: {startDate:startDate}
     ...
  });

}

C# Controller Code

 public void GetFile(string startDate) {

  var results = doQueryWith(startDate);

   // Create file based on results
   ....
   // How do I tell the server to make this a file download??
 }

我通常只会让我的文件下载一个链接，例如：

<a h r e f="mycontroller/getfile/1"/>Download</a>

但在上述情况下，日期将是动态的。

如果我不使用 ajax，使用 javascript 将参数传递给 MVC controller 的首选方法是什么？

例子：

window.location  = "mycontroller/GetFile/" + $("#fromDate").val();

假设日期是 12-25-2012

这会产生

mycontroller/GetFile/12/25/2012

MVC 会将其视为三个参数吗？

Answer 1

我最终做的是从我的javascript调用我的控制器，如：

var url = "/mycontroller/GetFile?startDate=" + $("#mydate").val() + etc...

window.location = url;

mycontroller.cs

 public void GetFile(DateTime startDate) 
{

}

我最初关心的是日期参数。 我不想解析它。

Answer 2

您可以使用控制器类的File方法将文件返回给浏览器。

以下示例返回pdf文件。

public ActionResult GetFile(int id)
{
  var fileInfo=repositary.GetFileDedetails(id);
  var byteArrayOFFile=fileInfo.FileContentAsByteArray();
  return File(byteArrayOFFile,"application/pdf","yourFriendlyName.pdf");
}

假设repositary.GetFileDedetails方法从id返回文件的详细信息。

您还可以从物理位置（路径）或流返回文件。 检查File方法的所有重载并使用适当的方法。

这与ajax无关。 这是浏览器的正常GET请求。

Answer 3

使用ActionLink助手，您可以将多个参数传递给控制器​​：

HtmlHelper.ActionLink(
    string linkText, 
    string actionName, 
    string controllerName, 
    object routeValues, 
    object htmlAttributes
)

所以在你的情况下：

@Html.ActionLink("Download file", "GetFile", "MyController", new { startDate = "##" }, new { id="mydownloadlink" })

使用jQuery，您可以使用日期选择器或文本框的内容更改链接中startDate的值。

$("#mydownloadlink").attr("href").replace("##", $("#yourdatetexbox").val);

然后，在你的控制器中，只需使用其中一个关于FileResult答案。

希望这能帮到你......

Answer 4

您的控制器操作方法应该返回FileResult而不是void。 而且没有必要通过AJAX这样做 - 事实上，你不想用AJAX做这件事。 您需要涉及的浏览器，因此它知道为用户提供下载对话框。

看到这些链接：

处理（jQuery）Ajax调用中返回的ASP.NET MVC FileResult

在Asp.Net MVC 2中下载文件

我希望这有帮助。

Answer 5

这对我有用。 确保从 controller 操作返回一个文件，其中内容类型为“application/vnd.openxmlformats-officedocument.spreadsheetml.sheet”，文件名为“List.xlsx”，这应该与 AJAX 成功调用中的相同。 我已经使用 ClosedXML NuGet package 生成了 excel 文件。

public IActionResult GetFile(DateTime startDate)
    {
        var results = doQueryWith(startDate);
        DataTable dt = new DataTable("Grid");
        //populate dt here.
        //if you result is a data table you can assign it to dt
        dt = results;
        string contentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
        string fileName = "List.xlsx";

        using (var workbook = new XLWorkbook())
        {
            workbook.Worksheets.Add(dt);

            using (var stream = new MemoryStream())
            {
                workbook.SaveAs(stream);
                workbook.SaveAs(stream);
                var content = stream.ToArray();
                return File(content, contentType, fileName);
            }
        }
    }

//.cshtml (JQuery AJAX call to the controller action)
$.ajax({
    url:"ControllerName/GetFile/",
    data: {startDate:startDate}     
    contentType: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
    xhrFields: { responseType: 'blob' },
    success: function (data) {
        var a = document.createElement('a');
        var url = window.URL.createObjectURL(data);
        a.href = url;
        a.download = 'List.xlsx';
        a.click();
        window.URL.revokeObjectURL(url);
    }
});