ASP.NET Core Web API 导出CSV时返回文本而非可下载文件如何解决

问题背景 #

需要将用户列表导出为CSV文件，现有代码如下：

Sample.cs 实体类代码 #

public int Id { get; set; }
public string Name { get; set; }
public string Email { get; set; }
public string Password { get; set; }
public DateTime DateOfBirth { get; set; }

控制器代码与测试数据 #

private IList<Sample> sample = new List<Sample>
{
    new Sample {Id=1,Name ="pons",Email="pons@gmail.com"},
    new Sample {Id=2 ,Name="maddy",Email="maddy@hotmail.com"},
    new Sample {Id=3,Name="thom",Email="thom@malinator.com"},
    new Sample {Id=4,Name="gomz",Email="gomz@outlook.com"},
    new Sample { Id=5,Name="vaandu",Email="vaandu@gmail.com"}
};
[HttpGet]
[Route("GetValue")]
public IActionResult ExportToCSV()
{
    var builder = new StringBuilder();
    builder.AppendLine("Id,Name,Email");
    foreach (var data in sample)
    {
        builder.AppendLine($"{data.Id},{data.Name},{data.Email}");
    }
    return File(Encoding.UTF8.GetBytes(builder.ToString()), "text/csv", "god.csv");
}

预期返回可自动下载的CSV文件，但实际接口仅返回纯文本内容，Postman与Angular前端请求均未触发下载。 #

排查与解决步骤 #

• 调整响应头配置
  现有代码未强制指定附件下载属性，部分浏览器会默认将text/csv类型响应以inline模式直接展示文本，不会触发下载。需要显式添加Content-Disposition头：

var bytes = Encoding.UTF8.GetBytes(builder.ToString());
Response.Headers.Add("Content-Disposition", $"attachment; filename=god.csv");
return File(bytes, "text/csv");

.NET Core 3.0+版本也可以直接在File方法中指定fileDownloadName参数自动生成该头，如配置了全局响应头覆盖规则，需单独排除该接口的响应头修改。

• 修复UTF8编码兼容问题
  无BOM头的UTF8编码内容可能被浏览器或Postman识别为纯文本展示，同时中文环境下Excel打开CSV会出现乱码，可修改字节生成逻辑添加BOM头：

// 拼接UTF8 BOM头 + 内容字节
var bytes = Encoding.UTF8.GetPreamble()
    .Concat(Encoding.UTF8.GetBytes(builder.ToString()))
    .ToArray();

• Postman测试逻辑修正
  Postman默认点击「Send」会直接展示响应文本，要触发下载需要选择「Send and Download」选项发送请求，即可弹出文件保存窗口验证接口输出正确性。
• Angular前端请求适配
  Angular默认ajax请求会将响应作为普通文本处理，不会自动触发下载，需要修改前端请求逻辑，指定响应类型为blob后手动触发下载：

this.http.get('接口请求地址', { responseType: 'blob' }).subscribe(res => {
  const downloadLink = document.createElement('a');
  const objectUrl = URL.createObjectURL(res);
  downloadLink.href = objectUrl;
  downloadLink.download = 'god.csv';
  downloadLink.click();
  URL.revokeObjectURL(objectUrl);
})

• 特殊字符兼容处理
  如果字段内容包含逗号、换行符等特殊字符，会导致CSV格式错乱被识别为纯文本，导出时可将每个字段用双引号包裹：

builder.AppendLine($"\"{data.Id}\",\"{data.Name}\",\"{data.Email}\"");

内容的提问来源于stack exchange，提问作者Thomas Raj