Как загрузить файлы на сервер веб-API и отправить параметры вместе с действием?

Добрый день!

Я работаю над проектом ASP.NET Web API 2. В определенный момент необходимо загрузить некоторые файлы. Файлы должны быть связаны с определенным FileModel (нашим собственным классом). Таким образом, клиенту необходимо отправить IEnumerable в качестве параметра, а файлы - как содержимое. Поскольку это RESTful API, оба должны быть отправлены с тем же запросом.

Самое лучшее, что мы могли бы придумать, - это следующее действие контроллера:

public async Task<HttpResponseMessage> Add([FromUri] IEnumerable<FileModel> fileModels)
{
   // REQUEST INTEGRITY TESTING

   var streamProvider = new CustomMultipartFormDataStreamProvider(fileSavePath, fileModels);
   // Read the MIME multipart content using the stream provider we just created.
   var work = await Request.Content.ReadAsMultipartAsync(streamProvider).ContinueWith(async t =>
        {
            // SOME WORK DONE AFTER SAVING THE FILES TO THE HARD DRIVE
        }

}

Проблема следующая: файлы загружаются с помощью заголовка Content-Type "multipart/form-data". Нам нужно знать содержимое FileModels, прежде чем обращаться с файлами на стороне сервера. Если мы используем MultipartFormDataStreamProvider, мы можем получить доступ только к параметрам non file после того, как файлы уже сохранены на жестком диске.

Единственным обходным решением для этого, которое мы могли найти, является отправка IEnumerable <FileModel> в URL. Но учитывая, что URL-адрес имеет ограниченную максимальную длину, это не является надежным методом.

Вопрос: есть ли способ отправить оба IEnumerable <FileModel> fileModels и файлы в теле запроса и получить доступ к параметру fileModels перед доступом к файлам? Мы также хотим использовать HttpContext.Current.Request.Files.Count;

Наш текущий jQuery для загрузки файлов выглядит так (для ранних целей тестирования он поддерживает только одну загрузку файла):

$('#Upload').click(function(e) {
            e.preventDefault();

            var headers = new Array();
            headers["SessionId"] = sessionId;

            var files = $('#fileInput').get(0).files;
            var formData = new FormData();
            formData.append("files", files[0]);

            var fileModel = $('#fileSubmission').serialize();

            $.ajax({
                url: "api/Submissions/Add/?" + fileModel,
                headers: headers,
                type: 'POST',
                data: formData,
                cache: false,
                contentType: false,
                processData: false,
                dataType: 'json'
            });
        });

Большое спасибо!

ОТВЕТЫ

Ответ 1

Прошу прощения за поздний ответ, но мы решили проблему (я забыл, что я не загрузил ответ здесь). В основном мы сделали то, что мы вызвали метод ReadAsMultiPartAsync во временном местоположении, а затем извлекли другие параметры из запроса. Впоследствии мы проверили входные данные и переместили файлы из временного в постоянное.

Если вы хотите увидеть код, это то, что сработало для нашего конкретного примера, и я считаю, что довольно легко адаптироваться к сценарию любого сценария:

На стороне клиента мы имеем следующую форму (да, эта реализация предназначена для демонстрационных целей и поддерживает только отправку одного файла... также поле input type="file" действительно вне формы; входной файл fileId завершено вручную в нашем случае, только для целей тестирования)

<input type="file" name="data" id="fileInput" multiple="multiple" />

<form id="fileSubmission">            
    <input type="text" width="10" onchange="getFileDetails()" autocomplete="off" placeholder="FileId" name="files[0].Id" id="fileId" /> 
    <input type="hidden" name="files[0].FileName" id="FileName"/>
    <input type="hidden" name="files[0].Extension" id="Extension"/>
    <input type="hidden" name="files[0].EntityId" id="EntityId"/>
    <br /><br />
    <input type="submit" id="Upload" value="Upload" />
</form>

где getFileDetails() заполняет другие поля ввода. Кроме того, форма отправляется на сервер с помощью следующего jQuery/Javascript:

$('#Upload').click(function(e) {
            e.preventDefault();

            var courseId = $('#courseId').val();
            var fileId = $('#fileId').val();
            if (!courseId || !fileId) {
                return;
            }

            var headers = new Array();
            headers["SessionId"] = sessionId;
            headers["contentType"] = "application/json; charset=UTF-8";

            var formData = new FormData();
            var opmlFile = $('#fileInput').get(0).files;

            // this is like the model we're expecting on the server
            var files = [];
            files.push({ 'Id': $('#fileId').val(), 'OriginalFileName': opmlFile[0].name, 'FileName': $('#FileName').val(), 'Extension': $('#Extension').val(), 'EntityId': $('#EntityId').val() });

            formData.append("fileModels", JSON.stringify(files));
            formData.append("File_0", opmlFile[0]);


            $.ajax({
                url: "api/Courses/" + courseId + "/Submissions/Add/",
                headers: headers,
                type: 'POST',
                data: formData,
                cache: false,
                contentType: false,
                processData: false,
                dataType: 'json'
            });
        });

На стороне сервера мы имеем следующее:

// POST: api/Courses/{courseId}/Submissions/Add
[HttpPost]
[ValidateModelState]
[ValidateMimeMultipartContent]
[PermissionsAuthorize(CoursePermissions.CanCreateSubmissions)]
public async Task<HttpResponseMessage> Add(int courseId)
    {
        // the same as in the jQuery part
        const string paramName = "fileModels";

        // Put the files in a temporary location
        // this way we call ReadAsMultiPartAsync and we get access to the other data submitted
        var tempPath = HttpContext.Current.Server.MapPath("~/App_Data/Temp/" + Guid.NewGuid());
        Directory.CreateDirectory(tempPath);

        var streamProvider = new MultipartFormDataStreamProvider(tempPath);
        var readResult = await Request.Content.ReadAsMultipartAsync(streamProvider);

        if (readResult.FormData[paramName] == null)
        {
            // We don't have the FileModels ... delete the TempFiles and return BadRequest
            Directory.Delete(tempPath, true);
            return Request.CreateResponse(HttpStatusCode.BadRequest);
        }

        // The files have been successfully saved in a TempLocation and the FileModels are not null
        // Validate that everything else is fine with this command
        var fileModels = JsonConvert.DeserializeObject<IEnumerable<FileModelExtension>>(readResult.FormData[paramName]).ToList();

        // AT THIS POINT, ON THE SERVER, WE HAVE ALL THE FILE MODELS 
        // AND ALL THE FILES ARE SAVED IN A TEMPORARY LOCATION

        // NEXT STEPS ARE VALIDATION OF THE INPUT AND THEN 
        // MOVING THE FILE FROM THE TEMP TO THE PERMANENT LOCATION

        // YOU CAN ACCESS THE INFO ABOUT THE FILES LIKE THIS:
        foreach (var tempFile in readResult.FileData)
            {
                var originalFileName = tempFile.Headers.ContentDisposition.FileName.Replace("\"", string.Empty);

                var localTempPath = tempFile.LocalFileName;
            }

    }

Я надеюсь, что это поможет любому, кто пытается отправить файлы и другие параметры сразу серверу, используя Post-запросы!:)

ПРИМЕЧАНИЕ. Некоторые атрибуты, используемые на сервере, являются обычными. PermissionAuthorize, ValidateModelState и ValidateMimeMultiPartContent - это настраиваемые фильтры, которые мы использовали. Реализация последних двух была вдохновлена ​​http://benfoster.io/blog/automatic-modelstate-validation-in-aspnet-mvc

Атрибут multipartcontent просто проверяет действиеContext.Request.Content.IsMimeMultipartContent(), как это:

public class ValidateMimeMultipartContent : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (!actionContext.Request.Content.IsMimeMultipartContent())
        {
            actionContext.Response = actionContext.Request.CreateErrorResponse(HttpStatusCode.UnsupportedMediaType, Messages.UnsupportedMediaType);
        }
    }
}