Pracuję nad usługą internetową przy użyciu nowego interfejsu WebAPI programu ASP.NET MVC, który będzie obsługiwał pliki binarne, głównie .cabi .exepliki.

Następująca metoda kontrolera wydaje się działać, co oznacza, że ​​zwraca plik, ale ustawia typ zawartości na application/json:

public HttpResponseMessage<Stream> Post(string version, string environment, string filetype)
{
    var path = @"C:\Temp\test.exe";
    var stream = new FileStream(path, FileMode.Open);
    return new HttpResponseMessage<Stream>(stream, new MediaTypeHeaderValue("application/octet-stream"));
}

Czy jest na to lepszy sposób?

Spróbuj użyć prostego HttpResponseMessagez jego Contentwłaściwością ustawioną na StreamContent:

// using System.IO;
// using System.Net.Http;
// using System.Net.Http.Headers;

public HttpResponseMessage Post(string version, string environment,
    string filetype)
{
    var path = @"C:\Temp\test.exe";
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK);
    var stream = new FileStream(path, FileMode.Open, FileAccess.Read);
    result.Content = new StreamContent(stream);
    result.Content.Headers.ContentType = 
        new MediaTypeHeaderValue("application/octet-stream");
    return result;
}

Kilka rzeczy do zapamiętania na temat streamużywanych:

• Nie można dzwonić stream.Dispose(), ponieważ interfejs API sieci Web nadal musi mieć do niego dostęp podczas przetwarzania metody kontrolera w resultcelu wysłania danych z powrotem do klienta. Dlatego nie używaj using (var stream = …)bloku. Interfejs API sieci Web udostępni Ci strumień.

• Upewnij się, że bieżąca pozycja strumienia ustawiona jest na 0 (tj. Początek danych strumienia). W powyższym przykładzie jest to podane, ponieważ właśnie otworzyłeś plik. Jednak w innych scenariuszach (np. Gdy po raz pierwszy zapisujesz jakieś dane binarne w a MemoryStream), upewnij się stream.Seek(0, SeekOrigin.Begin);lub ustawstream.Position = 0;

• W przypadku strumieni plików wyraźne określenie FileAccess.Readuprawnień może pomóc w zapobieganiu problemom z prawami dostępu na serwerach internetowych; Kontom puli aplikacji IIS często przyznawane są tylko prawa odczytu / listy / wykonywania dla wwwroot.

W przypadku interfejsu API sieci Web 2 można zaimplementować IHttpActionResult. To moje:

using System;
using System.IO;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Web.Http;

class FileResult : IHttpActionResult
{
    private readonly string _filePath;
    private readonly string _contentType;

    public FileResult(string filePath, string contentType = null)
    {
        if (filePath == null) throw new ArgumentNullException("filePath");

        _filePath = filePath;
        _contentType = contentType;
    }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = new HttpResponseMessage(HttpStatusCode.OK)
        {
            Content = new StreamContent(File.OpenRead(_filePath))
        };

        var contentType = _contentType ?? MimeMapping.GetMimeMapping(Path.GetExtension(_filePath));
        response.Content.Headers.ContentType = new MediaTypeHeaderValue(contentType);

        return Task.FromResult(response);
    }
}

Następnie coś takiego w kontrolerze:

[Route("Images/{*imagePath}")]
public IHttpActionResult GetImage(string imagePath)
{
    var serverPath = Path.Combine(_rootPath, imagePath);
    var fileInfo = new FileInfo(serverPath);

    return !fileInfo.Exists
        ? (IHttpActionResult) NotFound()
        : new FileResult(fileInfo.FullName);
}

A oto jeden ze sposobów, w jaki możesz powiedzieć IIS, aby ignorował żądania z rozszerzeniem, aby żądanie trafiło do kontrolera:

<!-- web.config -->
<system.webServer>
  <modules runAllManagedModulesForAllRequests="true"/>

Dla osób korzystających z .NET Core:

Możesz użyć interfejsu IActionResult w metodzie kontrolera API, tak jak ...

    [HttpGet("GetReportData/{year}")]
    public async Task<IActionResult> GetReportData(int year)
    {
        // Render Excel document in memory and return as Byte[]
        Byte[] file = await this._reportDao.RenderReportAsExcel(year);

        return File(file, "application/vnd.openxmlformats", "fileName.xlsx");
    }

Ten przykład jest uproszczony, ale powinien być zrozumiały. W .NET Core proces ten jest o wiele prostszy niż w poprzednich wersjach .NET - tzn. Brak ustawienia typu odpowiedzi, treści, nagłówków itp.

Oczywiście typ MIME pliku i rozszerzenia zależy od indywidualnych potrzeb.

Odniesienie: SO Post Answer by @NKosi

Chociaż sugerowane rozwiązanie działa poprawnie, istnieje inny sposób na zwrócenie tablicy bajtów ze sterownika, z odpowiednio sformatowanym strumieniem odpowiedzi:

• W żądaniu ustaw nagłówek „Zaakceptuj: application / octet-stream”.
• Po stronie serwera dodaj formater typu nośnika, aby obsługiwać ten typ MIME.

Niestety WebApi nie zawiera żadnego formatyzatora dla „application / octet-stream”. Na GitHub istnieje implementacja: BinaryMediaTypeFormatter (wprowadzono drobne dostosowania, aby działała w przypadku webapi 2, zmieniono podpisy metod).

Możesz dodać ten formatyzator do swojej globalnej konfiguracji:

HttpConfiguration config;
// ...
config.Formatters.Add(new BinaryMediaTypeFormatter(false));

WebApi powinno teraz używać, BinaryMediaTypeFormatterjeśli żądanie określa poprawny nagłówek Accept.

Wolę to rozwiązanie, ponieważ kontroler akcji zwracający bajt [] jest wygodniejszy do przetestowania. Jednak inne rozwiązanie umożliwia większą kontrolę, jeśli chcesz zwrócić inny typ zawartości niż „application / octet-stream” (na przykład „image / gif”).

Dla każdego, kto ma problem z wywołaniem API więcej niż raz podczas pobierania dość dużego pliku przy użyciu metody z zaakceptowanej odpowiedzi, ustaw buforowanie odpowiedzi na true System.Web.HttpContext.Current.Response.Buffer = true;

Dzięki temu cała zawartość binarna jest buforowana po stronie serwera, zanim zostanie wysłana do klienta. W przeciwnym razie zobaczysz wiele żądań wysyłanych do kontrolera, a jeśli nie załatwisz go poprawnie, plik zostanie uszkodzony.

Przeciążenie, którego używasz, ustawia wyliczanie formatatorów serializacji. Musisz jawnie określić typ zawartości, np .:

httpResponseMessage.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");

Możesz spróbować

httpResponseMessage.Content.Headers.Add("Content-Type", "application/octet-stream");