Я працюю над веб-сервісом, використовуючи новий WebAPI ASP.NET MVC, який обслуговуватиме двійкові файли, переважно .cabта .exeфайли.

Наступний метод контролера, здається, працює, це означає, що він повертає файл, але він встановлює тип вмісту 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"));
}

Чи є кращий спосіб зробити це?

Спробуйте скористатися простим HttpResponseMessageіз Contentвластивістю, встановленою на 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;
}

Кілька речей, які слід зазначити про streamвикористане:

• Не потрібно телефонувати stream.Dispose(), оскільки веб-API все ще потребує доступу до нього, коли він обробляє метод контролера resultдля повернення даних клієнту. Тому не використовуйте using (var stream = …)блок. Веб-API розпоряджається потоком для вас.

• Переконайтеся, що для потоку його поточне положення встановлено 0 (тобто початок даних потоку). У наведеному вище прикладі це дані, оскільки ви тільки що відкрили файл. Однак в інших сценаріях (наприклад, коли ви вперше записуєте деякі двійкові дані в a MemoryStream), переконайтесь, що це stream.Seek(0, SeekOrigin.Begin);встановлено або встановленоstream.Position = 0;

• У потоках файлів, чітко вказавши FileAccess.Readдозвіл, можна запобігти проблемам з правами доступу на веб-серверах; Облікові записи пулу програм IIS часто надаються лише для читання / списку / виконання прав доступу до wwwroot.

Для веб-API 2 можна реалізувати IHttpActionResult. Ось моя:

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

Тоді щось подібне у вашому контролері:

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

І ось один спосіб ви можете сказати IIS ігнорувати запити з розширенням, щоб запит перейшов до контролера:

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

Для тих, хто використовує .NET Core:

Ви можете використовувати інтерфейс IActionResult в методі контролера API, наприклад ...

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

Цей приклад спрощений, але має бути зрозумілим. У .NET Core цей процес настільки простіший, ніж у попередніх версіях .NET - тобто немає налаштування відповіді типу, вмісту, заголовків тощо.

Також, звичайно, тип MIME для файлу та розширення залежатиме від індивідуальних потреб.

Довідка: SO Відповідь відповіді від @NKosi

Хоча запропоноване рішення працює нормально, є інший спосіб повернути байтовий масив з контролера з правильним форматуванням потоку відповідей:

• У запиті встановіть заголовок "Прийняти: додаток / октет-потік".
• Сторінка сервера, додайте формат медіа-типу для підтримки цього типу mime.

На жаль, WebApi не містить жодного форматера для "application / octet-stream". Тут є реалізація на GitHub: BinaryMediaTypeFormatter (є незначні адаптації, щоб вона працювала для webapi 2, підписи методів змінені).

Ви можете додати цей форматер у вашу глобальну конфігурацію:

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

Тепер WebApi слід використовувати, BinaryMediaTypeFormatterякщо запит визначає правильний заголовок Accept.

Я вважаю за краще це рішення, оскільки контролер дій, що повертає байт [], зручніше перевірити. Хоча інше рішення дозволяє вам більше контролювати, якщо ви хочете повернути інший тип вмісту, ніж "application / octet-stream" (наприклад, "image / gif").

Для тих, хто має проблему виклику API не раз під час завантаження досить великого файлу, використовуючи метод у прийнятій відповіді, будь ласка, встановіть буферизацію відповіді на справжню System.Web.HttpContext.Current.Response.Buffer = true;

Це гарантує, що весь двійковий вміст буферизований на стороні сервера, перш ніж він буде надісланий клієнту. Інакше ви побачите кілька запитів, що надсилаються до контролера, і якщо ви не будете правильно їх обробляти, файл стане пошкодженим.

Перевантаження, яку ви використовуєте, задає перерахування форматів серіалізації. Вам потрібно вказати тип вмісту прямо:

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

Ви можете спробувати

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