如何在 ASP.NET Web API 中设置下载文件名

Question

在我的 ApiController 类中，我有以下方法来下载服务器创建的文件。

public HttpResponseMessage Get(int id)
{
    try
    {
        string dir = HttpContext.Current.Server.MapPath("~"); //location of the template file
        Stream file = new MemoryStream();
        Stream result = _service.GetMyForm(id, dir, file);
        if (result == null)
        {
            return Request.CreateResponse(HttpStatusCode.NotFound);
        }
        result.Position = 0;
        HttpResponseMessage response = new HttpResponseMessage();
        response.StatusCode = HttpStatusCode.OK;
        response.Content = new StreamContent(result);
        return response;
    }
    catch (IOException)
    {
        return Request.CreateResponse(HttpStatusCode.InternalServerError);
    }
}

除了默认的下载文件名是它的 id 之外，一切都运行良好，因此用户可能必须每次在另存为对话框中键入他/她自己的文件名。有没有办法在上面的代码中设置一个默认的文件名？

Answer 1

考虑到前面的答案，需要注意全球化字符。

假设文件名是：“Esdrújula prenda ñame - güena.jpg”

原始结果下载：“Esdrújula prenda ñame - güena.jpg”[丑陋]

HtmlEncode结果下载：“Esdr&_250;jula prenda &_241;ame - g&_252;ena.jpg”[丑]

UrlEncode 结果下载：“Esdrújula+prenda+ñame+-+güena.jpg”[OK]

然后，您需要几乎总是在文件名上使用 UrlEncode。 此外，如果您将 content-disposition 标头设置为直接字符串，则需要确保用引号括起来以避免浏览器兼容性问题。

Response.AddHeader("Content-Disposition", $"attachment; filename=\"{HttpUtility.UrlEncode(YourFilename)}\"");

或在课堂帮助下：

var cd = new ContentDisposition("attachment") { FileName = HttpUtility.UrlEncode(resultFileName) };
Response.AddHeader("Content-Disposition", cd.ToString());

System.Net.Mime.ContentDisposition 类负责处理引号。

Answer 2

注意：最后一行是强制性的。

如果我们没有指定 Access-Control-Expose-Headers，我们将不会在 UI 中获取 File Name。

FileInfo file = new FileInfo(FILEPATH);

HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
{
    FileName = file.Name
};
response.Content.Headers.Add("Access-Control-Expose-Headers", "Content-Disposition");

Answer 3

如果您使用的是 ASP.NET Core MVC，上面的答案会稍有改变...

在我的操作方法（返回 async Task<JsonResult>）中，我添加了这一行（返回语句之前的任何位置）：

Response.Headers.Add("Content-Disposition", $"attachment; filename={myFileName}");

Answer 4

应该这样做：

Response.AddHeader("Content-Disposition", "attachment;filename="+ YourFilename)

Answer 5

如果你想确保文件名被正确编码但又避免 WebApi HttpResponseMessage 你可以使用以下：

Response.AddHeader("Content-Disposition", new System.Net.Mime.ContentDisposition("attachment") { FileName = "foo.txt" }.ToString());

您可以使用 ContentDisposition 或 ContentDispositionHeaderValue。在任一实例上调用 ToString 将为您完成文件名的编码。

Answer 6

编辑： 正如评论中提到的，我的回答没有考虑像; 这样需要转义的字符。如果您的文件名可能包含分号，您应该使用 Darin 提供的公认答案。

添加一个Response.AddHeader来设置文件名

Response.AddHeader("Content-Disposition", "attachment; filename=*FILE_NAME*");

只需将 FILE_NAME 更改为文件名即可。

Answer 7

您需要在HttpResponseMessage 上设置Content-Disposition 标头：

HttpResponseMessage response = new HttpResponseMessage();
response.StatusCode = HttpStatusCode.OK;
response.Content = new StreamContent(result);
response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
{
    FileName = "foo.txt"
};

Answer 8

您需要将 content-disposition 标头添加到响应中：

 response.StatusCode = HttpStatusCode.OK;
 response.Content = new StreamContent(result);
 response.AppendHeader("content-disposition", "attachment; filename=" + fileName);
 return response;

Answer 9

我认为这可能对您有所帮助。

Response.AddHeader("Content-Disposition", "attachment; filename=" + fileName)