Ich arbeite an einem Webdienst mit der neuen WebAPI von ASP.NET MVC, die hauptsächlich Binärdateien .cabund .exeDateien bereitstellt.

Die folgende Controller-Methode scheint zu funktionieren, dh sie gibt eine Datei zurück, setzt jedoch den Inhaltstyp auf 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"));
}

Gibt es einen besseren Weg, dies zu tun?

Versuchen Sie es mit einem Simple, HttpResponseMessagedessen ContentEigenschaft auf a gesetzt ist 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;
}

Ein paar Dinge zu beachten über die streamverwendeten:

• Sie dürfen nicht aufrufen stream.Dispose(), da die Web-API weiterhin darauf zugreifen muss, wenn sie die Controller-Methoden verarbeitet result, um Daten an den Client zurückzusenden. Verwenden Sie daher keinen using (var stream = …)Block. Die Web-API stellt den Stream für Sie bereit.

• Stellen Sie sicher, dass die aktuelle Position des Streams auf 0 gesetzt ist (dh der Anfang der Daten des Streams). Im obigen Beispiel ist dies eine Selbstverständlichkeit, da Sie die Datei gerade erst geöffnet haben. In anderen Szenarien (z. B. wenn Sie zum ersten Mal einige Binärdaten in a schreiben MemoryStream) müssen Sie dies jedoch sicherstellen stream.Seek(0, SeekOrigin.Begin);oder festlegenstream.Position = 0;

• Bei Dateistreams kann die explizite Angabe von FileAccess.ReadBerechtigungen dazu beitragen, Probleme mit Zugriffsrechten auf Webservern zu vermeiden. IIS-Anwendungspoolkonten erhalten häufig nur Lese- / Listen- / Ausführungszugriffsrechte für die wwwroot.

Für Web API 2 können Sie implementieren IHttpActionResult. Hier ist meins:

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

Dann so etwas in Ihrem Controller:

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

Und hier ist eine Möglichkeit, wie Sie IIS anweisen können, Anforderungen mit einer Erweiterung zu ignorieren, damit die Anforderung an den Controller weitergeleitet wird:

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

Für Benutzer von .NET Core:

Sie können die IActionResult-Schnittstelle in einer API-Controller-Methode verwenden, wie z.

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

Dieses Beispiel ist vereinfacht, sollte aber den Punkt vermitteln. In .NET Core ist dieser Prozess so viel einfacher als in früheren Versionen von .NET - dh keine Einstellung von Antworttyp, Inhalt, Headern usw.

Natürlich hängt auch der MIME-Typ für die Datei und die Erweiterung von den individuellen Anforderungen ab.

Referenz: SO Antwort von @NKosi posten

Während die vorgeschlagene Lösung einwandfrei funktioniert, gibt es eine andere Möglichkeit, ein Byte-Array vom Controller zurückzugeben, wobei der Antwortstrom ordnungsgemäß formatiert ist:

• Setzen Sie in der Anfrage den Header "Accept: application / octet-stream".
• Fügen Sie serverseitig einen Medientyp-Formatierer hinzu, um diesen MIME-Typ zu unterstützen.

Leider enthält WebApi keinen Formatierer für "application / octet-stream". Hier auf GitHub gibt es eine Implementierung: BinaryMediaTypeFormatter (es gibt geringfügige Anpassungen, damit es für Webapi 2 funktioniert, Methodensignaturen geändert).

Sie können diesen Formatierer zu Ihrer globalen Konfiguration hinzufügen:

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

WebApi sollte jetzt verwendet werden, BinaryMediaTypeFormatterwenn die Anforderung den richtigen Accept-Header angibt.

Ich bevorzuge diese Lösung, weil ein Action-Controller, der Byte [] zurückgibt, bequemer zu testen ist. Mit der anderen Lösung haben Sie jedoch mehr Kontrolle, wenn Sie einen anderen Inhaltstyp als "application / octet-stream" (z. B. "image / gif") zurückgeben möchten.

Wenn das Problem auftritt, dass die API beim Herunterladen einer relativ großen Datei mit der in der akzeptierten Antwort angegebenen Methode mehrmals aufgerufen wird, setzen Sie die Antwortpufferung auf true. System.Web.HttpContext.Current.Response.Buffer = true;

Dadurch wird sichergestellt, dass der gesamte binäre Inhalt auf der Serverseite gepuffert wird, bevor er an den Client gesendet wird. Andernfalls werden mehrere Anforderungen an den Controller gesendet. Wenn Sie diese nicht ordnungsgemäß verarbeiten, wird die Datei beschädigt.

Die von Ihnen verwendete Überlastung legt die Aufzählung der Serialisierungsformatierer fest. Sie müssen den Inhaltstyp explizit wie folgt angeben:

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

Du könntest es versuchen

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