如何从ASP下载CSV文件.. NET Web Api使用jQuery Ajax调用

本文关键字：Api Web 使用 jQuery 调用 Ajax NET 文件 ASP 下载 CSV | 更新日期: 2023-09-27 18:03:29

我正在研究如何从ASP下载CSV文件。. NET Web Api从jQuery ajax调用。CSV文件基于自定义的CsvFormatter从Web API服务器动态生成。

Ajax from jQuery:

   $.ajax({
        type: "GET",
        headers: {
            Accept: "text/csv; charset=utf-8",
        },
        url: "/api/employees",
        success: function (data) {
        }
    });

在服务器上，EmployeeCsvFormatter的实现与下面的文章类似，源自BufferedMediaTypeFormatter:

http://www.asp.net/web-api/overview/formats-and-model-binding/media-formatters 

public class EmployeeCsvFormatter : BufferedMediaTypeFormatter
{
    public EmployeeCsvFormatter()
    {
        SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/csv"));
    }
    ...
}

我还添加了覆盖方法，以表明我想下载像正常方式下载文件(可以在下载选项卡中看到下载文件):

 public override void SetDefaultContentHeaders(Type type, 
    HttpContentHeaders headers, MediaTypeHeaderValue mediaType)       
{
    base.SetDefaultContentHeaders(type, headers, mediaType);
    headers.Add("Content-Disposition", "attachment; filename=yourname.csv");
    headers.ContentType =  new MediaTypeHeaderValue("application/octet-stream");
}

但它不起作用，下载文件没有显示在状态栏或下载选项卡上的Chrome，即使从提琴手，我看到它的响应似乎是正确的:

HTTP/1.1 200 OK
Server: ASP.NET Development Server/11.0.0.0
Date: Mon, 11 Mar 2013 08:19:35 GMT
X-AspNet-Version: 4.0.30319
Content-Disposition: attachment; filename=yourname.csv
Cache-Control: no-cache
Pragma: no-cache
Expires: -1
Content-Type: application/octet-stream
Content-Length: 26
Connection: Close
1,Cuong,123
1,Trung,123

我的方法从ApiController:

public EmployeeDto[] Get()
{
    var result = new[]
               {
                   new EmployeeDto() {Id = 1, Name = "Cuong", Address = "123"},
                   new EmployeeDto() {Id = 1, Name = "Trung", Address = "123"},
               };
    return result;
}

一定是什么地方出了问题，我还没有发现。我怎样才能使它的工作下载CSV文件像正常的方式?

如何从ASP下载CSV文件.. NET Web Api使用jQuery Ajax调用

jQuery Plugin for requests like Ajax File Downloads使用一个简单的表单提交，无需Ajax。

内部:

jQuery('<form action="'+ url +'" method="'+ (method||'post') +'">'+inputs+'</form>')
    .appendTo('body').submit().remove()

它有一个ajax风格的界面所以从外部你可以这样调用它

$.download('/api/employees','format=csv');

另一个简单的方法是:

$('#btnDownload').click(function (e) {
    e.preventDefault();
    window.location = "/api/employees?format=csv";
});

在服务器端，MediaTypeMappings必须通过增加一个构造函数来使用:

    public EmployeeCsvFormatter(MediaTypeMapping mediaTypeMapping)
        : this()
    {
        MediaTypeMappings.Add(mediaTypeMapping);
    }

然后，将这个格式化程序添加到Web Api配置中:

   configuration.Formatters.Add(new EmployeeCsvFormatter
            (new QueryStringMapping("format", "csv", "text/csv")));

作为一种替代方法，可以在单击锚()或按钮时提供下载，并将请求的URL设置为响应附件的API方法。

在CsvMediaTypeFormatter(派生自System.Net.Http.Formatting.MediaTypeFormatter)中，除了如上面的答案所示映射文本/csv MIME类型外，我发现以下需要完成:

public override void SetDefaultContentHeaders(Type type, HttpContentHeaders headers, MediaTypeHeaderValue mediaType)
        {
            base.SetDefaultContentHeaders(type, headers, mediaType);
            headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
            {
                FileName = string.Concat("data", DateTime.UtcNow.ToString("yyyyMMddhhmmss"), ".csv")
            };
            headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
        }

注意:当写入流时，设置Content-Length头并记得冲洗流。我发现，如果没有调用Flush()，即使设置了正确的内容长度，返回的响应也不能成功地返回到客户端。

您也可以通过修改xhr在beforeend中设置请求头。

    $.ajax({
    url: "/api/employees",
    type: "GET",
    beforeSend: function (xhr) {
        xhr.setRequestHeader("Accept", "text/csv");
    },
    success: function (data) {
            }
    });
相关文章：