如何接受文件POST


254

我正在使用asp.net mvc 4 webapi beta来构建REST服务。我需要能够接受来自客户端应用程序的POST图像/文件。使用webapi可以吗?以下是我目前正在使用的操作。有谁知道一个例子,这应该如何工作?

[HttpPost]
public string ProfileImagePost(HttpPostedFile profileImage)
{
    string[] extensions = { ".jpg", ".jpeg", ".gif", ".bmp", ".png" };
    if (!extensions.Any(x => x.Equals(Path.GetExtension(profileImage.FileName.ToLower()), StringComparison.OrdinalIgnoreCase)))
    {
        throw new HttpResponseException("Invalid file type.", HttpStatusCode.BadRequest);
    }

    // Other code goes here

    return "/path/to/image.png";
}

3
这仅适用于MVC,不适用于WebAPI框架。
Phil

您应该可以从Request.Files
Tejs 2012年

7
ApiController不包含具有Files属性的HttpRequestBase。它的Request对象基于HttpRequestMessage类。
Phil

Answers:


168

看到http://www.asp.net/web-api/overview/formats-and-model-binding/html-forms-and-multipart-mime#multipartmime,尽管我认为这篇文章使它看起来比确实是。

基本上,

public Task<HttpResponseMessage> PostFile() 
{ 
    HttpRequestMessage request = this.Request; 
    if (!request.Content.IsMimeMultipartContent()) 
    { 
        throw new HttpResponseException(HttpStatusCode.UnsupportedMediaType); 
    } 

    string root = System.Web.HttpContext.Current.Server.MapPath("~/App_Data/uploads"); 
    var provider = new MultipartFormDataStreamProvider(root); 

    var task = request.Content.ReadAsMultipartAsync(provider). 
        ContinueWith<HttpResponseMessage>(o => 
    { 

        string file1 = provider.BodyPartFileNames.First().Value;
        // this is the file name on the server where the file was saved 

        return new HttpResponseMessage() 
        { 
            Content = new StringContent("File uploaded.") 
        }; 
    } 
    ); 
    return task; 
} 

5
使用任务仅读取一个文件有什么好处?真正的问题,我才刚开始使用Tasks。根据我目前的理解,此代码确实适合上载多个文件时的正确操作吗?
克里斯(Chris)

48
MultipartFormDataStreamProvider不再具有BodyPartFileNames属性(在WebApi RTM中)。请参阅asp.net/web-api/overview/working-with-http/…–
Shrike

5
大家好,请问大家为什么我们不能简单地使用HttpContext.Current.Request.Files访问文件,而需要使用这种高档的MultipartFormDataStreamProvider?完整问题:stackoverflow.com/questions/17967544
niaher

7
文件被保存为BodyPart_8b77040b-354b-464c-bc15-b3591f98f30f。是否不应该像在客户端上一样将它们像pic.jpg一样保存?
lbrahim 2014年

10
MultipartFormDataStreamProvider不公开BodyPartFileNames财产的任何更多的,我用FileData.First().LocalFileName代替。
Chtiwi Malek 2015年

374

令我感到惊讶的是,许多人似乎想在服务器上保存文件。将所有内容保留在内存中的解决方案如下:

[HttpPost("api/upload")]
public async Task<IHttpActionResult> Upload()
{
    if (!Request.Content.IsMimeMultipartContent())
        throw new HttpResponseException(HttpStatusCode.UnsupportedMediaType); 

    var provider = new MultipartMemoryStreamProvider();
    await Request.Content.ReadAsMultipartAsync(provider);
    foreach (var file in provider.Contents)
    {
        var filename = file.Headers.ContentDisposition.FileName.Trim('\"');
        var buffer = await file.ReadAsByteArrayAsync();
        //Do whatever you want with filename and its binary data.
    }

    return Ok();
}

34
如果您不想花费磁盘空间,则将文件保留在内存中可能很有用。但是,如果您允许上传大文件,那么将它们保存在内存中意味着您的网络服务器将占用大量内存,而这些内存不能花在为其他请求保留资源上。这将在高负载下工作的服务器上引起问题。
Willem Meints

21
@ W.Meints我了解要存储数据的原因,但我不明白为什么有人要在服务器磁盘空间上存储上载的数据。即使对于较小的项目,也应始终将文件存储与Web服务器隔离。
Gleno

1
确保您发布的文件大小小于64k,默认行为是忽略请求,否则,我在此上停留了一段时间。
加里·戴维斯

3
不幸的是,如果您也想读取表单数据,则MultipartMemoryStreamProvider并没有帮助。想要创建类似MultipartFormDataDataMemoryStreamProvider的东西,但是aspnetwebstack中有很多类和帮助器类:(
martinoss 2015年

9
File.WriteAllBytes(filename, buffer);将其写入文件中
庞贝

118

请参阅下面的代码(改编自本文),该代码演示了我可以找到的最简单的示例代码。它包括文件和内存(更快)上载。

public HttpResponseMessage Post()
{
    var httpRequest = HttpContext.Current.Request;
    if (httpRequest.Files.Count < 1)
    {
        return Request.CreateResponse(HttpStatusCode.BadRequest);
    }

    foreach(string file in httpRequest.Files)
    {
        var postedFile = httpRequest.Files[file];
        var filePath = HttpContext.Current.Server.MapPath("~/" + postedFile.FileName);
        postedFile.SaveAs(filePath);
        // NOTE: To store in memory use postedFile.InputStream
    }

    return Request.CreateResponse(HttpStatusCode.Created);
}

26
当WebAPI托管在OWIN(一个自托管容器)中时,HttpContext.Current为null。
2014年

1
像这样修复它:var httpRequest = System.Web.HttpContext.Current.Request;
msysmilu 2014年

7
除非绝对必要,否则请勿在WebAPI中使用System.Web。
库格尔2015年

3
当然,System.Web与IIS紧密耦合。如果您在OWIN piple line或.Net Core中工作,则这些API在Linux下运行或自行托管时将不可用。
库格尔

2
好答案。只是一个细节:如果从HTML页面上载,则<input type =“ file” />标记必须具有“名称”属性,否则该文件将不会出现在HttpContext.Current.Request.Files中。
GBU

17

ASP.NET Core方式现在在这里

[HttpPost("UploadFiles")]
public async Task<IActionResult> Post(List<IFormFile> files)
{
    long size = files.Sum(f => f.Length);

    // full path to file in temp location
    var filePath = Path.GetTempFileName();

    foreach (var formFile in files)
    {
        if (formFile.Length > 0)
        {
            using (var stream = new FileStream(filePath, FileMode.Create))
            {
                await formFile.CopyToAsync(stream);
            }
        }
    }

    // process uploaded files
    // Don't rely on or trust the FileName property without validation.

    return Ok(new { count = files.Count, size, filePath});
}

16

这是一个快速而肮脏的解决方案,该解决方案从HTTP正文中获取上传的文件内容并将其写入文件。我为文件上传添加了“裸露的” HTML / JS代码段。

Web API方法:

[Route("api/myfileupload")]        
[HttpPost]
public string MyFileUpload()
{
    var request = HttpContext.Current.Request;
    var filePath = "C:\\temp\\" + request.Headers["filename"];
    using (var fs = new System.IO.FileStream(filePath, System.IO.FileMode.Create))
    {
        request.InputStream.CopyTo(fs);
    }
    return "uploaded";
}

HTML文件上传:

<form>
    <input type="file" id="myfile"/>  
    <input type="button" onclick="uploadFile();" value="Upload" />
</form>
<script type="text/javascript">
    function uploadFile() {        
        var xhr = new XMLHttpRequest();                 
        var file = document.getElementById('myfile').files[0];
        xhr.open("POST", "api/myfileupload");
        xhr.setRequestHeader("filename", file.name);
        xhr.send(file);
    }
</script>

请注意,这不适用于“常规”多部分表格上传。
汤姆(Tom)

3
@Tom是什么意思?
Chazt3n

这意味着它与禁用/不存在JavaScript的浏览器不兼容,例如Netscape 1. *。
MikaelDúiBolinder

13

在更新webapi mvc4项目中的所有NuGet之前,我使用了Mike Wasson的答案。完成后,我必须重新编写文件上传操作:

    public Task<HttpResponseMessage> Upload(int id)
    {
        HttpRequestMessage request = this.Request;
        if (!request.Content.IsMimeMultipartContent())
        {
            throw new HttpResponseException(new HttpResponseMessage(HttpStatusCode.UnsupportedMediaType));
        }

        string root = System.Web.HttpContext.Current.Server.MapPath("~/App_Data/uploads");
        var provider = new MultipartFormDataStreamProvider(root);

        var task = request.Content.ReadAsMultipartAsync(provider).
            ContinueWith<HttpResponseMessage>(o =>
            {
                FileInfo finfo = new FileInfo(provider.FileData.First().LocalFileName);

                string guid = Guid.NewGuid().ToString();

                File.Move(finfo.FullName, Path.Combine(root, guid + "_" + provider.FileData.First().Headers.ContentDisposition.FileName.Replace("\"", "")));

                return new HttpResponseMessage()
                {
                    Content = new StringContent("File uploaded.")
                };
            }
        );
        return task;
    }

显然,BodyPartFileNames在MultipartFormDataStreamProvider中不再可用。


在WebApi RTM中,BodyPartFileNames已更改为FileData。请参阅asp.net/web-api/overview/working-with-http/…的
Mark van Straten

为什么不只使用System.Web.HttpContext.Current.Request.Files集合?
ADOConnection

我正在考虑对您的方法进行2次保留:1)这是否不写两次:i)in ReadAsMultipartAsync和ii)In File.Move?2)可以async File.Move吗?
seebiscuit

1)我两次写入都没有问题,URL被两次调用了吗?2)您可以执行Task.Run(()=> {File.Move(src,dest);});
史蒂夫·斯托克斯

10

朝着相同的方向,我发布了使用WebApi,c#4发送Excel文件的客户端和服务器片段:

public static void SetFile(String serviceUrl, byte[] fileArray, String fileName)
{
    try
    {
        using (var client = new HttpClient())
        {
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                using (var content = new MultipartFormDataContent())
                {
                    var fileContent = new ByteArrayContent(fileArray);//(System.IO.File.ReadAllBytes(fileName));
                    fileContent.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
                    {
                        FileName = fileName
                    };
                    content.Add(fileContent);
                    var result = client.PostAsync(serviceUrl, content).Result;
                }
        }
    }
    catch (Exception e)
    {
        //Log the exception
    }
}

和服务器的webapi控制器:

public Task<IEnumerable<string>> Post()
{
    if (Request.Content.IsMimeMultipartContent())
    {
        string fullPath = HttpContext.Current.Server.MapPath("~/uploads");
        MyMultipartFormDataStreamProvider streamProvider = new MyMultipartFormDataStreamProvider(fullPath);
        var task = Request.Content.ReadAsMultipartAsync(streamProvider).ContinueWith(t =>
        {
            if (t.IsFaulted || t.IsCanceled)
                    throw new HttpResponseException(HttpStatusCode.InternalServerError);

            var fileInfo = streamProvider.FileData.Select(i =>
            {
                var info = new FileInfo(i.LocalFileName);
                return "File uploaded as " + info.FullName + " (" + info.Length + ")";
            });
            return fileInfo;

        });
        return task;
    }
    else
    {
        throw new HttpResponseException(Request.CreateResponse(HttpStatusCode.NotAcceptable, "Invalid Request!"));
    }
}

还有自定义MyMultipartFormDataStreamProvider,需要自定义文件名:

PS:我从另一篇文章中获得了此代码http://www.codeguru.com/csharp/.net/uploading-files-asynchronously-using-asp.net-web-api .htm

public class MyMultipartFormDataStreamProvider : MultipartFormDataStreamProvider
{
    public MyMultipartFormDataStreamProvider(string path)
        : base(path)
    {

    }

    public override string GetLocalFileName(System.Net.Http.Headers.HttpContentHeaders headers)
    {
        string fileName;
        if (!string.IsNullOrWhiteSpace(headers.ContentDisposition.FileName))
        {
            fileName = headers.ContentDisposition.FileName;
        }
        else
        {
            fileName = Guid.NewGuid().ToString() + ".data";
        }
        return fileName.Replace("\"", string.Empty);
    }
}

您能否说明如何static method SetFile在Controller中给您打电话?

这是一个很好的答案。像这样扩展基本提供程序还使您能够控制流并提供比仅提供path云存储更大的灵活性。
菲尔·库珀

6
[HttpPost]
public JsonResult PostImage(HttpPostedFileBase file)
{
    try
    {
        if (file != null && file.ContentLength > 0 && file.ContentLength<=10485760)
        {
            var fileName = Path.GetFileName(file.FileName);                                        

            var path = Path.Combine(Server.MapPath("~/") + "HisloImages" + "\\", fileName);

            file.SaveAs(path);
            #region MyRegion
            ////save imag in Db
            //using (MemoryStream ms = new MemoryStream())
            //{
            //    file.InputStream.CopyTo(ms);
            //    byte[] array = ms.GetBuffer();
            //} 
            #endregion
            return Json(JsonResponseFactory.SuccessResponse("Status:0 ,Message: OK"), JsonRequestBehavior.AllowGet);
        }
        else
        {
            return Json(JsonResponseFactory.ErrorResponse("Status:1 , Message: Upload Again and File Size Should be Less Than 10MB"), JsonRequestBehavior.AllowGet);
        }
    }
    catch (Exception ex)
    {

        return Json(JsonResponseFactory.ErrorResponse(ex.Message), JsonRequestBehavior.AllowGet);

    }
}

6
我认为用户需要一些解释...!
kamesh

4

这是接受文件的两种方法。一种在内存提供程序MultipartMemoryStreamProvider中使用,另一种在保存到磁盘的MultipartFormDataStreamProvider中使用。请注意,这一次只能上传一个文件。您可以肯定地扩展它以保存多个文件。第二种方法可以支持大文件。我已经测试了200MB以上的文件,并且工作正常。使用内存中的方法不需要将其保存到磁盘,但是如果超出一定限制,则会抛出内存不足异常。

private async Task<Stream> ReadStream()
{
    Stream stream = null;
    var provider = new MultipartMemoryStreamProvider();
    await Request.Content.ReadAsMultipartAsync(provider);
    foreach (var file in provider.Contents)
    {
        var buffer = await file.ReadAsByteArrayAsync();
        stream = new MemoryStream(buffer);
    }

    return stream;
}

private async Task<Stream> ReadLargeStream()
{
    Stream stream = null;
    string root = Path.GetTempPath();
    var provider = new MultipartFormDataStreamProvider(root);
    await Request.Content.ReadAsMultipartAsync(provider);
    foreach (var file in provider.FileData)
    {
        var path = file.LocalFileName;
        byte[] content = File.ReadAllBytes(path);
        File.Delete(path);
        stream = new MemoryStream(content);
    }

    return stream;
}


1

即使对于.Net Core,此问题也有很多很好的答案。我使用了两个框架,提供的代码示例运行正常。所以我不再重复。就我而言,重要的是如何在Swagger中使用文件上传操作,如下所示:

Swagger中的文件上传按钮

这是我的回顾:

ASP .Net WebAPI 2

  • 要上传文件,请使用:MultipartFormDataStreamProvider在此处查看答案
  • 如何 与Swagger使用

.NET核心


1

API控制器:

[HttpPost]
public HttpResponseMessage Post()
{
    var httpRequest = System.Web.HttpContext.Current.Request;

    if (System.Web.HttpContext.Current.Request.Files.Count < 1)
    {
        //TODO
    }
    else
    {

    try
    { 
        foreach (string file in httpRequest.Files)
        { 
            var postedFile = httpRequest.Files[file];
            BinaryReader binReader = new BinaryReader(postedFile.InputStream);
            byte[] byteArray = binReader.ReadBytes(postedFile.ContentLength);

        }

    }
    catch (System.Exception e)
    {
        //TODO
    }

    return Request.CreateResponse(HttpStatusCode.Created);
}

0

补充Matt Frear的答案-这将是ASP NET Core的替代方案,可直接从Stream读取文件,而无需从磁盘保存和读取文件:

public ActionResult OnPostUpload(List<IFormFile> files)
    {
        try
        {
            var file = files.FirstOrDefault();
            var inputstream = file.OpenReadStream();

            XSSFWorkbook workbook = new XSSFWorkbook(stream);

            var FIRST_ROW_NUMBER = {{firstRowWithValue}};

            ISheet sheet = workbook.GetSheetAt(0);
            // Example: var firstCellRow = (int)sheet.GetRow(0).GetCell(0).NumericCellValue;

            for (int rowIdx = 2; rowIdx <= sheet.LastRowNum; rowIdx++)
               {
                  IRow currentRow = sheet.GetRow(rowIdx);

                  if (currentRow == null || currentRow.Cells == null || currentRow.Cells.Count() < FIRST_ROW_NUMBER) break;

                  var df = new DataFormatter();                

                  for (int cellNumber = {{firstCellWithValue}}; cellNumber < {{lastCellWithValue}}; cellNumber++)
                      {
                         //business logic & saving data to DB                        
                      }               
                }
        }
        catch(Exception ex)
        {
            throw new FileFormatException($"Error on file processing - {ex.Message}");
        }
    }
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.