Jak zaakceptować plik POST

254

Korzystam z asp.net mvc 4 webapi beta, aby zbudować usługę odpoczynku. Muszę być w stanie zaakceptować obrazy / pliki POSTed z aplikacji klienckich. Czy jest to możliwe przy użyciu webapi? Poniżej przedstawiam sposób, w jaki aktualnie korzystam. Czy ktoś zna przykład, jak to powinno działać?

[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
źródło
3
Działa to tylko z MVC, a nie z interfejsem WebAPI.
Phil
Powinieneś być w stanie złapać przedmiot zRequest.Files
Tejs
7
ApiController nie zawiera HttpRequestBase, który ma właściwość Files. Jest to obiekt żądania oparty na klasie HttpRequestMessage.
Phil

Odpowiedzi:

168

widzieć http://www.asp.net/web-api/overview/formats-and-model-binding/html-forms-and-multipart-mime#multipartmime , chociaż myślę, że artykuł sprawia, że ​​wydaje się to nieco bardziej skomplikowane niż naprawdę jest.

Gruntownie,

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
źródło
5
Jakie są zalety używania zadania do odczytu tylko jednego pliku? Prawdziwe pytanie, dopiero zaczynam korzystać z Zadań. Według mojego obecnego zrozumienia, ten kod naprawdę nadaje się do przesyłania więcej niż jednego pliku, prawda?
Chris
48
MultipartFormDataStreamProvider nie ma już właściwości BodyPartFileNames (w WebApi RTM). Zobacz asp.net/web-api/overview/working-with-http/…
Dzierzba
5
Chłopaki, czy ktoś z was mógłby rzucić nieco światła na to, dlaczego nie możemy po prostu uzyskać dostępu do plików za pomocą HttpContext.Current.Request.Files, a zamiast tego trzeba użyć tego fantazyjnego MultipartFormDataStreamProvider? Pełne pytanie: stackoverflow.com/questions/17967544 .
niaher
7
Pliki są zapisywane jako BodyPart_8b77040b-354b-464c-bc15-b3591f98f30f . Czy nie powinny być zapisywane jak pic.jpg dokładnie tak, jak na kliencie?
lbrahim
10
MultipartFormDataStreamProvidernie ujawnia już BodyPartFileNameswłasności, użyłem FileData.First().LocalFileNamezamiast tego.
Chtiwi Malek
374

Dziwi mnie, że wielu z was chce zapisywać pliki na serwerze. Rozwiązanie, aby zachować wszystko w pamięci, jest następujące:

[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
źródło
34
Przechowywanie plików w pamięci może być przydatne, jeśli nie chcesz wydawać miejsca na dysku. Jeśli jednak zezwolisz na przesyłanie dużych plików, to przechowywanie ich w pamięci oznacza, że ​​Twój serwer internetowy zużyje dużo pamięci, której nie można przeznaczyć na przechowywanie innych plików. Spowoduje to problemy na serwerach, które działają pod dużym obciążeniem.
Willem Meints,
21
@ W.Wskazówki Rozumiem powody, dla których chcę przechowywać dane, ale nie rozumiem, dlaczego ktoś chciałby przechowywać przesłane dane na przestrzeni dyskowej serwera. Zawsze należy utrzymywać pamięć plików w izolacji od serwera WWW - nawet w przypadku mniejszych projektów.
Gleno,
1
Upewnij się, że rozmiar wysłanego pliku jest mniejszy niż 64 KB, domyślnym zachowaniem jest ignorowanie żądań, w przeciwnym razie utknąłem na tym przez czas logowania.
Gary Davies,
3
Niestety MultipartMemoryStreamProvider nie pomaga, jeśli chcesz również odczytać dane formularza. Chciałem stworzyć coś w rodzaju MultipartFormDataMemoryStreamProvider, ale tak wiele klas i klas pomocników jest wewnętrznych w aspnetwebstack :(
martinoss
9
File.WriteAllBytes(filename, buffer);zapisać go do pliku
pomber
118

Zobacz poniższy kod, zaadaptowany z tego artykułu , który pokazuje najprostszy przykładowy kod, jaki udało mi się znaleźć. Obejmuje przesyłanie plików i pamięci (szybsze).

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
źródło
26
HttpContext.Current ma wartość NULL, gdy interfejs WebAPI jest hostowany w OWIN, który jest kontenerem samoobsługowym.
Zach.
1
Naprawiono to tak: var httpRequest = System.Web.HttpContext.Current.Request;
msysmilu
7
Nie używaj System.Web w WebAPI, chyba że absolutnie musisz.
Kugel
3
Jasne, System.Web jest ściśle powiązany z IIS. Jeśli pracujesz w linii pipet OWIN lub .Net Core, te API nie będą dostępne, jeśli pracujesz pod Linuksem lub na własnym serwerze.
Kugel
2
Świetna odpowiedź. Tylko jeden szczegół: jeśli przesyłasz ze strony HTML, znacznik <input type = "file" /> musi mieć atrybut „name”, inaczej plik nie będzie obecny w pliku HttpContext.Current.Request.Files.
GBU,
17

Sposób ASP.NET Core jest teraz tutaj :

[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
źródło
16

Oto szybkie i brudne rozwiązanie, które pobiera przesłaną zawartość pliku z treści HTTP i zapisuje ją w pliku. Do przesłanego pliku dołączyłem fragment kodu HTML / JS „bare bones”.

Metoda interfejsu API sieci 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";
}

Przesyłanie pliku 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
źródło
Uważaj jednak, że nie będzie to działać przy „normalnym” przesyłaniu formularzy wieloczęściowych.
Tom
3
@ Tom co to znaczy?
Chazt3n
Oznacza to, że nie jest kompatybilny z przeglądarkami, w których JavaScript jest wyłączony / nie istnieje, np. Netscape 1. *.
Mikael Dúi Bolinder,
13

Użyłem odpowiedzi Mike'a Wassona, zanim zaktualizowałem wszystkie NuGets w moim projekcie webapi mvc4. Kiedy to zrobiłem, musiałem ponownie napisać akcję przesyłania pliku:

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

Najwyraźniej BodyPartFileNames nie jest już dostępny w MultipartFormDataStreamProvider.

Steve Stokes
źródło
W WebApi RTM nazwa BodyPartFileNames została zmieniona na FileData. Zobacz zaktualizowany przykład na stronie asp.net/web-api/overview/working-with-http/…
Mark van Straten
Dlaczego nie skorzystać z kolekcji System.Web.HttpContext.Current.Request.Files?
ADOConnection
Zastanawiam się nad zastosowaniem tej metody z 2 zastrzeżeniami: 1) Czy to nie pisze dwa razy: i) in ReadAsMultipartAsynci ii) In File.Move? 2) Czy możesz to zrobić async File.Move?
seebiscuit
1) Nie miałem problemów z dwoma zapisami, czy adres URL jest wywoływany dwukrotnie? 2) możesz wykonać Task.Run (() => {File.Move (src, dest);});
Steve Stokes,
10

W tym samym kierunku publikuję fragmenty klienta i serwera, które wysyłają pliki Excel za pomocą 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
    }
}

I kontroler webapi serwera:

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

I niestandardowy MyMultipartFormDataStreamProvider, potrzebny do dostosowania nazwy pliku:

PS: Wziąłem ten kod z innego postu 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);
    }
}
Daniel Melo
źródło
Czy możesz pokazać, jak dzwonisz static method SetFiledo kontrolera?
To dobra odpowiedź. Rozszerzenie tego podstawowego dostawcy umożliwia również kontrolowanie strumienia i daje większą elastyczność niż zapewnianie tylko pathpamięci w chmurze.
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);

    }
}
użytkownik3722373
źródło
6
Myślę, że użytkownik potrzebuje wyjaśnienia ...!
kamesh
4

Oto dwa sposoby akceptacji pliku. Jeden używa w dostawcy pamięci MultipartMemoryStreamProvider i jeden używa MultipartFormDataStreamProvider, który zapisuje na dysku. Uwaga: dotyczy to tylko jednego przesłanego pliku na raz. Możesz z pewnością rozszerzyć to, aby zapisać wiele plików. Drugie podejście może obsługiwać duże pliki. Testowałem pliki powyżej 200 MB i działa dobrze. Korzystanie z metody pamięci nie wymaga zapisywania na dysku, ale spowoduje wyłączenie wyjątku pamięci, jeśli przekroczysz określony limit.

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;
}
Filiks Mohylewski
źródło
1

Miałem podobny problem z podglądem interfejsu API sieci Web. Nie przeniesiono jeszcze tej części do nowego interfejsu API sieci Web MVC 4, ale może to pomaga:

Przesyłanie pliku REST za pomocą HttpRequestMessage lub Stream?

Daj mi znać, mogę jutro usiąść i spróbować wdrożyć go ponownie.

Remy
źródło
1

To pytanie ma wiele dobrych odpowiedzi nawet dla .Net Core. Używałem obu frameworów, pod warunkiem że próbki kodu działają poprawnie. Więc nie powtórzę tego. W moim przypadku ważną rzeczą było, jak korzystać z akcji wysyłania plików za pomocą Swaggera :

Przycisk przesyłania pliku w Swagger

Oto moje podsumowanie:

ASP .Net WebAPI 2

  • Aby przesłać plik, użyj: MultipartFormDataStreamProvider zobacz odpowiedzi tutaj
  • Jak używać go z Swagger

.NET Core

Poważny
źródło
1

Kontroler 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
źródło
0

Uzupełnienie odpowiedzi Matta Freara - byłaby to alternatywa ASP NET Core do odczytu pliku bezpośrednio ze strumienia, bez zapisywania i odczytu z dysku:

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
źródło