Como aceitar um arquivo POST

254

Estou usando o asp.net mvc 4 webapi beta para criar um serviço de descanso. Preciso aceitar imagens / arquivos POST dos aplicativos clientes. Isso é possível usando o webapi? Abaixo está como ação eu estou usando atualmente. Alguém sabe de um exemplo como isso deve funcionar?

[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";
}
Phil
fonte
3
Isso funciona apenas com o MVC, não com a estrutura WebAPI.
24512 Phil
Você deve ser capaz de simplesmente pegar o item deRequest.Files
Tejs
7
O ApiController não contém o HttpRequestBase que possui a propriedade Files. O objeto Request é baseado na classe HttpRequestMessage.
25412 Phil

Respostas:

168

consulte http://www.asp.net/web-api/overview/formats-and-model-binding/html-forms-and-multipart-mime#multipartmime , embora eu ache que o artigo o faça parecer um pouco mais complicado do que é realmente.

Basicamente,

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; 
} 
Mike Wasson
fonte
5
Qual é o benefício de usar uma tarefa para ler apenas um arquivo? Pergunta genuína, estou apenas começando a usar o Tasks. Do meu entendimento atual, esse código é realmente adequado para o upload de mais de um arquivo, correto?
Chris
48
MultipartFormDataStreamProvider não tem mais a propriedade BodyPartFileNames (no WebApi RTM). Veja asp.net/web-api/overview/working-with-http/…
Shrike
5
Pessoal, algum de vocês pode esclarecer por que simplesmente não podemos acessar arquivos usando HttpContext.Current.Request.Files e, em vez disso, precisamos usar esse MultipartFormDataStreamProvider? A pergunta completa: stackoverflow.com/questions/17967544 .
Niaher
7
Os arquivos estão sendo salvos como BodyPart_8b77040b-354b-464c-bc15-b3591f98f30f . Eles não deveriam ser salvos como pic.jpg exatamente como estavam no cliente?
precisa saber é o seguinte
10
MultipartFormDataStreamProvidernão expõe mais a BodyPartFileNamespropriedade, eu usei FileData.First().LocalFileName.
Chtiwi Malek
374

Estou surpreso que muitos de vocês parecem querer salvar arquivos no servidor. A solução para manter tudo na memória é a seguinte:

[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();
}
Gleno
fonte
34
Manter os arquivos na memória pode ser útil se você não quiser gastar espaço em disco. No entanto, se você permitir o upload de arquivos grandes, mantê-los na memória significa que o servidor da Web consumirá muita memória, o que não pode ser gasto em manter as coisas para outras solicitações. Isso causará problemas em servidores que funcionam com alta carga.
Willem Meints
21
@ W.Meints Entendo os motivos para querer armazenar dados, mas não entendo por que alguém iria querer armazenar dados carregados no espaço em disco do servidor. Você sempre deve manter o armazenamento de arquivos isolado do servidor da web - mesmo para projetos menores.
quer
1
Verifique se o tamanho do arquivo postado é inferior a 64k, o comportamento padrão é ignorar solicitações, caso contrário, fiquei preso por um tempo de log.
Gary Davies
3
Infelizmente, o MultipartMemoryStreamProvider não ajuda se você deseja ler os dados do formulário também. Queria criar algo como um MultipartFormDataMemoryStreamProvider mas muitas classes e classes auxiliares são internos na aspnetwebstack :(
martinoss
9
File.WriteAllBytes(filename, buffer);escrevê-lo em um arquivo
pomber 26/10/16
118

Veja o código abaixo, adaptado deste artigo , que demonstra o código de exemplo mais simples que eu poderia encontrar. Inclui uploads de arquivos e de memória (mais rápidos).

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);
}
Brent Matzelle
fonte
26
HttpContext.Current é nulo quando o WebAPI está hospedado no OWIN, que é um contêiner de hospedagem automática.
Zach
1
Corrigido da seguinte maneira: var httpRequest = System.Web.HttpContext.Current.Request;
msysmilu
7
Não use System.Web na WebAPI, a menos que seja absolutamente necessário.
Kugel
3
Claro, o System.Web está fortemente associado ao IIS. Se você estiver trabalhando na linha piple OWIN ou no .Net Core, essa API não estará disponível quando executada no Linux ou auto-hospedada.
Kardel #
2
Ótima resposta. Apenas um detalhe: se você estiver carregando de uma página HTML, a tag <input type = "file" /> deve ter um atributo "name" ou o arquivo não estará presente no HttpContext.Current.Request.Files.
GBU
17

A maneira do ASP.NET Core agora está aqui :

[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});
}
Matt Frear
fonte
16

Aqui está uma solução rápida e suja que pega o conteúdo do arquivo carregado do corpo HTTP e o grava em um arquivo. Incluí um snippet HTML / JS "básico" para o upload do arquivo.

Método da API da Web:

[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";
}

Upload de arquivo 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>
James Lawruk
fonte
Cuidado, porém, que isso não funcionará com uploads de formulários de várias partes 'normais'.
Tom
3
@ Tom, o que isso significa?
Chazt3n
Isso significa que não é compatível com navegadores onde o JavaScript está desativado / inexistente, por exemplo, Netscape 1. *.
Mikael Dúi Bolinder 08/08/19
13

Usei a resposta de Mike Wasson antes de atualizar todos os NuGets no meu projeto webapi mvc4. Depois disso, tive que reescrever a ação de upload do arquivo:

    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;
    }

Aparentemente, BodyPartFileNames não está mais disponível no MultipartFormDataStreamProvider.

Steve Stokes
fonte
No WebApi RTM, o BodyPartFileNames foi alterado para FileData. Veja o exemplo atualizado em asp.net/web-api/overview/working-with-http/…
Mark van Straten
Por que não usar apenas a coleção System.Web.HttpContext.Current.Request.Files?
ADOConnection
Estou pensando em usar seu método com 2 reservas: 1) Isso não escreve duas vezes: i) in ReadAsMultipartAsynce ii) In File.Move? 2) você poderia fazer async File.Move?
seebiscuit
1) Não tive problemas com duas gravações. O URL está sendo chamado duas vezes? 2) você pode executar Task.Run (() => {File.Move (src, dest);});
Steve Stokes
10

Na mesma direção, estou postando um snippets de cliente e servidor que enviam arquivos do Excel usando o WebApi, c # 4:

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
    }
}

E o servidor webapi controller:

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!"));
    }
}

E o MyMultipartFormDataStreamProvider personalizado, necessário para personalizar o nome do arquivo:

PS: peguei esse código em outra postagem http://www.codeguru.com/csharp/.net/uploading-files-asynchronously-using-asp-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);
    }
}
Daniel Melo
fonte
Você poderia mostrar como você o chama static method SetFileno seu Controller?
Esta é uma boa resposta. A extensão do provedor base como este também permite controlar o fluxo e oferece mais flexibilidade do que fornecer apenas um patharmazenamento em nuvem, ou seja.
Phil Cooper
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);

    }
}
user3722373
fonte
6
Eu acho que o usuário precisa de alguma explicação ...!
Kamesh
4

Aqui estão duas maneiras de aceitar um arquivo. Um usando no provedor de memória MultipartMemoryStreamProvider e outro usando MultipartFormDataStreamProvider, que salva em um disco. Observe que isso é apenas para um upload de arquivo por vez. Você pode estender isso com certeza para salvar vários arquivos. A segunda abordagem pode suportar arquivos grandes. Eu testei arquivos com mais de 200 MB e funciona bem. O uso da abordagem de memória não exige que você salve no disco, mas emitirá uma exceção de falta de memória se você exceder um determinado limite.

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;
}
Filix Mogilevsky
fonte
1

Eu tive um problema semelhante na API da Web de visualização. Ainda não portou essa parte para a nova API da Web MVC 4, mas talvez isso ajude:

Upload de arquivo REST com HttpRequestMessage ou Stream?

Informe-me, pode sentar-se amanhã e tentar implementá-lo novamente.

Remy
fonte
1

Esta pergunta tem muitas boas respostas, mesmo para o .Net Core. Eu estava usando os dois frameworks, os exemplos de código fornecidos funcionam bem. Então não vou repetir. No meu caso, o importante era como usar as ações de upload de arquivos com o Swagger assim:

Botão de upload de arquivo no Swagger

Aqui está o meu resumo:

ASP .Net WebAPI 2

  • Para fazer upload de arquivos, use: MultipartFormDataStreamProvider, veja as respostas aqui
  • Como usá-lo com o Swagger

.NET Core

Principal
fonte
1

Controlador de 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);
}
Tiago Medici
fonte
0

Complementando a resposta de Matt Frear - Essa seria uma alternativa do ASP NET Core para ler o arquivo diretamente do Stream, sem salvá-lo e lê-lo a partir do disco:

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}");
        }
    }
Pedro Coelho
fonte