使用 MVC、C# 和 jQuery 导出为 CSV

Posted 2023-02-24

【中文标题】使用 MVC、C# 和 jQuery 导出为 CSV

【英文标题】：Export to CSV using MVC, C# and jQuery

【发布时间】：2011-06-07 19:43:48

【问题描述】：

我正在尝试将列表导出到 CSV 文件。 我已经完成了所有工作，直到我想将文件写入响应流。这没有任何作用。

这是我的代码：

从页面调用方法。

$('#btn_export').click(function () 
         $.post('NewsLetter/Export');
);

控制器中的代码如下：

[HttpPost]
        public void Export()
        
            try
            
                var filter = Session[FilterSessionKey] != null ? Session[FilterSessionKey] as SubscriberFilter : new SubscriberFilter();

                var predicate = _subscriberService.BuildPredicate(filter);
                var compiledPredicate = predicate.Compile();
                var filterRecords = _subscriberService.GetSubscribersInGroup().Where(x => !x.IsDeleted).AsEnumerable().Where(compiledPredicate).GroupBy(s => s.Subscriber.EmailAddress).OrderBy(x => x.Key);

                ExportAsCSV(filterRecords);
            
            catch (Exception exception)
            
                Logger.WriteLog(LogLevel.Error, exception);
            
        

        private void ExportAsCSV(IEnumerable<IGrouping<String, SubscriberInGroup>> filterRecords)
        
            var sw = new StringWriter();
            //write the header
            sw.WriteLine(String.Format("0,1,2,3", CMSMessages.EmailAddress, CMSMessages.Gender, CMSMessages.FirstName, CMSMessages.LastName));

            //write every subscriber to the file
            var resourceManager = new ResourceManager(typeof(CMSMessages));
            foreach (var record in filterRecords.Select(x => x.First().Subscriber))
            
                sw.WriteLine(String.Format("0,1,2,3", record.EmailAddress, record.Gender.HasValue ? resourceManager.GetString(record.Gender.ToString()) : "", record.FirstName, record.LastName));
            

            Response.Clear();
            Response.AddHeader("Content-Disposition", "attachment; filename=adressenbestand.csv");
            Response.ContentType = "text/csv";
            Response.Write(sw);
            Response.End();
        

但是在Response.Write(sw) 之后什么都没有发生。甚至可以这样保存文件吗？

问候

编辑 我点击按钮时看到的响应标题是：

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/csv; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
Content-Disposition: attachment; filename=adressenbestand.csv
X-Powered-By: ASP.NET
Date: Wed, 12 Jan 2011 13:05:42 GMT
Content-Length: 113

这对我来说似乎不错..

编辑 我摆脱了 jQuery 部分并用超链接替换了它，现在这对我来说很好：

<a class="export" href="NewsLetter/Export">exporteren</a>

【问题讨论】：

也许这个关于 SO 的问题有帮助：***.com/questions/4522590/…

您能否将您的答案记录为实际答案，而不是编辑问题。

【参考方案1】：

yan.kun 是在正确的轨道上，但这要容易得多。

    public FileContentResult DownloadCSV()
    
        string csv = "Charlie, Chaplin, Chuckles";
        return File(new System.Text.UTF8Encoding().GetBytes(csv), "text/csv", "Report123.csv");
    

【讨论】：

我们如何处理包含逗号的字符串？我尝试使用双引号作为文本限定符，但它似乎不起作用。

@mmssaann 这就是它的美妙之处，你不用 javascript。您只需将锚标记的 href 设置为操作。 <a href="ControllerName/ActionName">Download CSV</a>

我已经为锚标签设置了 href。它工作正常。但是，我仍然可以看到整个页面被发回。有没有办法限制回发？

@mmssaann 您应该提出一个新问题，详细说明您的特定设置。

我用你的方式创建下载CSV，一切正常，我调试，它进入控制器。但是浏览器没有显示任何下载文件的迹象？你认为发生了什么，我需要更改 Web.config 什么的吗？

【参考方案2】：

使用 MVC，您可以像这样简单地返回一个文件：

public ActionResult ExportData()

    System.IO.FileInfo exportFile = //create your ExportFile
    return File(exportFile.FullName, "text/csv", string.Format("Export-0.csv", DateTime.Now.ToString("yyyyMMdd-HHmmss")));

【讨论】：

你真的想在网络服务器上创建一堆文件吗？清理它们怎么样？安全呢？

@chris 不是在服务器内存而不是文件系统中创建文件吗？

我用你的方式创建下载CSV，一切正常，我调试，它进入控制器。但是浏览器没有显示任何下载文件的迹象？你认为发生了什么，我需要更改 Web.config 什么的吗？

【参考方案3】：

除了 Biff MaGriff 的回答。要使用 JQuery 导出文件，请将用户重定向到新页面。

$('#btn_export').click(function () 
    window.location.href = 'NewsLetter/Export';
);

【参考方案4】：

如果你摆脱 stringwriter 会发生什么：

        Response.Clear();
        Response.AddHeader("Content-Disposition", "attachment; filename=adressenbestand.csv");
        Response.ContentType = "text/csv";
        //write the header
        Response.Write(String.Format("0,1,2,3", CMSMessages.EmailAddress, CMSMessages.Gender, CMSMessages.FirstName, CMSMessages.LastName));

        //write every subscriber to the file
        var resourceManager = new ResourceManager(typeof(CMSMessages));
        foreach (var record in filterRecords.Select(x => x.First().Subscriber))
        
            Response.Write(String.Format("0,1,2,3", record.EmailAddress, record.Gender.HasValue ? resourceManager.GetString(record.Gender.ToString()) : "", record.FirstName, record.LastName));
        

        Response.End();

【讨论】：

不，这也没有什么不同。我已经以不同的方式解决了它。请参阅我的编辑。无论如何感谢您的帮助！

【参考方案5】：

尊重 Biff，这里有一些调整，让我可以使用该方法将 CSV 从 jQuery/Post 反弹到服务器并作为 CSV 提示返回给用户。

    [Themed(false)]
    public FileContentResult DownloadCSV()
    

        var csvStringData = new StreamReader(Request.InputStream).ReadToEnd();

        csvStringData = Uri.UnescapeDataString(csvStringData.Replace("mydata=", ""));

        return File(new System.Text.UTF8Encoding().GetBytes(csvStringData), "text/csv", "report.csv");
    

如果您从带有如下代码的表单中点击它，您将需要 unescape 行，

    var input = $("<input>").attr("type", "hidden").attr("name", "mydata").val(data);
    $('#downloadForm').append($(input));
    $("#downloadForm").submit();

【参考方案6】：

从视图中的按钮调用 .click（调用一些 java 脚本）。从那里通过 window.location.href = 'Controller/Method'; 调用控制器方法；

在控制器中要么进行数据库调用并获取数据表，要么调用某种方法将数据从数据库表中获取到数据表中，然后执行以下操作，

using (DataTable dt = new DataTable())
                        
                            sda.Fill(dt);
                            //Build the CSV file data as a Comma separated string.
                            string csv = string.Empty;
                            foreach (DataColumn column in dt.Columns)
                            
                                //Add the Header row for CSV file.
                                csv += column.ColumnName + ',';
                            
                            //Add new line.
                            csv += "\r\n";
                            foreach (DataRow row in dt.Rows)
                            
                                foreach (DataColumn column in dt.Columns)
                                
                                    //Add the Data rows.
                                    csv += row[column.ColumnName].ToString().Replace(",", ";") + ',';
                                
                                //Add new line.
                                csv += "\r\n";
                             
                             //Download the CSV file.
                             Response.Clear();
                             Response.Buffer = true;
                             Response.AddHeader("content-disposition", "attachment;filename=SqlExport"+DateTime.Now+".csv");
                             Response.Charset = "";
                             //Response.ContentType = "application/text";
                             Response.ContentType = "application/x-msexcel";
                             Response.Output.Write(csv);
                             Response.Flush();
                             Response.End();
                           

【参考方案7】：

即使您已经解决了问题，这里还有一个尝试使用 mvc 导出 csv 的方法。

return new FileStreamResult(fileStream, "text/csv")  FileDownloadName = fileDownloadName ;

【参考方案8】：

我想你忘了使用

  Response.Flush();

下

  Response.Write(sw);

请检查

【参考方案9】：

公共 ActionResult 结果()

返回文件（新系统。 Text.UTF8Encoding().GetBytes("字符串数据"), "application/csv", "filename.csv");

【讨论】：

这不是一个好的答案。请参考How do I write a good answer?

这是一个很好的答案。它只是格式错误，并且重复了 6 年前发布的最佳答案。 :D