JavaScript/jQuery для загрузки файла через POST с данными JSON
У меня есть одностраничный webapp, основанный на jquery. Он связывается с веб-службой RESTful через вызовы AJAX.
Я пытаюсь выполнить следующее:
- Отправьте POST, содержащий данные JSON, на URL REST.
- Если запрос указывает ответ JSON, возвращается JSON.
- Если запрос указывает ответ PDF/XLS/etc, возвращается возвращаемый двоичный файл.
Теперь у меня есть 1 и 2, а клиентское jquery-приложение отображает возвращенные данные на веб-странице, создавая элементы DOM на основе данных JSON. У меня также есть # 3, работающий с точки зрения веб-сервиса, то есть он будет создавать и возвращать двоичный файл, если заданы правильные параметры JSON. Но я не уверен, что лучший способ справиться с № 3 в коде JavaScript клиента.
Можно ли получить загружаемый файл обратно из вызова ajax, подобного этому? Как заставить браузер загружать и сохранять файл?
$.ajax({
type: "POST",
url: "/services/test",
contentType: "application/json",
data: JSON.stringify({category: 42, sort: 3, type: "pdf"}),
dataType: "json",
success: function(json, status){
if (status != "success") {
log("Error loading data");
return;
}
log("Data loaded!");
},
error: function(result, status, err) {
log("Error loading data");
return;
}
});
Сервер отвечает на следующие заголовки:
Content-Disposition:attachment; filename=export-1282022272283.pdf
Content-Length:5120
Content-Type:application/pdf
Server:Jetty(6.1.11)
Другая идея - создать PDF файл и сохранить его на сервере и вернуть JSON, который содержит URL-адрес файла. Затем выполните другой вызов в обработчике успеха ajax, чтобы сделать что-то вроде следующего:
success: function(json,status) {
window.location.href = json.url;
}
Но это означает, что мне нужно будет сделать более одного вызова на сервер, и моему серверу нужно будет создавать загружаемые файлы, хранить их где-нибудь, а затем периодически очищать эту область хранения.
Должен быть более простой способ выполнить это. Идеи?
EDIT: после просмотра документов для $.ajax, я вижу, что ответ dataType может быть только одним из xml, html, script, json, jsonp, text
, поэтому я предполагаю, что нет способа напрямую загрузить файл с помощью запроса ajax, если только я не вставьте двоичный файл с использованием схемы URI данных, как это предложено в ответе @VinayC (чего я не хочу делать).
Итак, мои варианты:
-
Не используйте ajax и вместо этого отправляйте сообщение формы и вставляйте мои данные JSON в значения формы. Вероятно, нужно будет собечать со скрытыми iframe и т.д.
-
Не используйте ajax и вместо этого конвертируйте мои данные JSON в строку запроса для создания стандартного запроса GET и установите для этого URL window.location.href. Может понадобиться использовать event.preventDefault() в моем обработчике кликов, чтобы браузер не изменялся с URL-адреса приложения.
-
Используйте мою другую идею выше, но расширенную с предложениями от ответа @naikus. Отправьте запрос AJAX с некоторым параметром, который позволяет веб-службе знать, что это вызвано с помощью вызова ajax. Если веб-служба вызывается из вызова ajax, просто верните JSON с URL-адресом для сгенерированного ресурса. Если ресурс вызывается напрямую, тогда верните фактический двоичный файл.
Чем больше я думаю об этом, тем больше мне нравится последний вариант. Таким образом, я могу получить информацию о запросе (время генерации, размер файла, сообщения об ошибках и т.д.), И я могу действовать по этой информации перед началом загрузки. Недостатком является дополнительное управление файлами на сервере.
Какие-нибудь другие способы сделать это? Любые плюсы и минусы этих методов, о которых я должен знать?
Ответы
Ответ 1
Решение letronje работает только на очень простых страницах. document.body.innerHTML +=
берет HTML-текст тела, добавляет HTML-код iframe и устанавливает innerHTML страницы в эту строку. Это приведет к уничтожению любых привязок к событиям вашей страницы, среди прочего. Создайте элемент и используйте appendChild
вместо этого.
$.post('/create_binary_file.php', postData, function(retData) {
var iframe = document.createElement("iframe");
iframe.setAttribute("src", retData.url);
iframe.setAttribute("style", "display: none");
document.body.appendChild(iframe);
});
Или используя jQuery
$.post('/create_binary_file.php', postData, function(retData) {
$("body").append("<iframe src='" + retData.url+ "' style='display: none;' ></iframe>");
});
Что это на самом деле делает: выполните запись в /create _binary_file.php с данными в переменной postData; если эта запись завершена успешно, добавьте новый фрейм в тело страницы. Предполагается, что ответ /create _binary_file.php будет содержать значение "url", которое является URL-адресом, с которого может быть загружен сгенерированный файл PDF/XLS/etc. Добавление iframe на страницу, которая ссылается на этот URL, приведет к тому, что браузер будет продвигать пользователя для загрузки файла, предполагая, что веб-сервер имеет соответствующую конфигурацию типа mime.
Ответ 2
Я играл с другим вариантом, который использует blobs. Мне удалось загрузить его, чтобы загрузить текстовые документы, и я загрузил PDF (однако они повреждены).
Используя API-интерфейс blob, вы сможете сделать следующее:
$.post(/*...*/,function (result)
{
var blob=new Blob([result]);
var link=document.createElement('a');
link.href=window.URL.createObjectURL(blob);
link.download="myFileName.txt";
link.click();
});
Это IE 10+, Chrome 8+, FF 4+. См. https://developer.mozilla.org/en-US/docs/Web/API/URL.createObjectURL
Он будет загружать только файл в Chrome, Firefox и Opera. Это использует атрибут загрузки в теге привязки, чтобы заставить браузер загружать его.
Ответ 3
Я знаю этот старый, но я думаю, что придумал более элегантное решение. У меня была точно такая же проблема. Проблема, с которой я столкнулся, заключалась в том, что все они требовали сохранения файла на сервере, но я не хотел сохранять файлы на сервере, поскольку он ввел другие проблемы (безопасность: к файлу можно было получить доступ неидентифицированные пользователи, очистка: как и когда вы избавляетесь от файлов). И, как и вы, мои данные были сложными, вложенными объектами JSON, которые трудно было бы вставить в форму.
Я создал две функции сервера. Первые подтвердили данные. Если возникла ошибка, она будет возвращена. Если это не была ошибка, я возвращал все параметры, сериализованные/закодированные как строка base64. Затем на клиенте у меня есть форма, которая имеет только один скрытый ввод и сообщения второй функции сервера. Я установил скрытый ввод в строку base64 и отправлю формат. Вторая функция сервера декодирует/десериализирует параметры и генерирует файл. Форма может быть отправлена в новое окно или iframe на странице, и файл откроется.
Там было немного больше работы и, возможно, немного больше обработки, но в целом, я чувствовал себя намного лучше с этим решением.
Код находится в С#/MVC
public JsonResult Validate(int reportId, string format, ReportParamModel[] parameters)
{
// TODO: do validation
if (valid)
{
GenerateParams generateParams = new GenerateParams(reportId, format, parameters);
string data = new EntityBase64Converter<GenerateParams>().ToBase64(generateParams);
return Json(new { State = "Success", Data = data });
}
return Json(new { State = "Error", Data = "Error message" });
}
public ActionResult Generate(string data)
{
GenerateParams generateParams = new EntityBase64Converter<GenerateParams>().ToEntity(data);
// TODO: Generate file
return File(bytes, mimeType);
}
на клиенте
function generate(reportId, format, parameters)
{
var data = {
reportId: reportId,
format: format,
params: params
};
$.ajax(
{
url: "/Validate",
type: 'POST',
data: JSON.stringify(data),
dataType: 'json',
contentType: 'application/json; charset=utf-8',
success: generateComplete
});
}
function generateComplete(result)
{
if (result.State == "Success")
{
// this could/should already be set in the HTML
formGenerate.action = "/Generate";
formGenerate.target = iframeFile;
hidData = result.Data;
formGenerate.submit();
}
else
// TODO: display error messages
}
Ответ 4
Существует более простой способ, создать форму и опубликовать ее, это может привести к перезагрузке страницы, если тип возвращаемого типа mime будет открываться браузером, но для csv и, таким образом, он идеально подходит
Пример требует подчеркивания и jquery
var postData = {
filename:filename,
filecontent:filecontent
};
var fakeFormHtmlFragment = "<form style='display: none;' method='POST' action='"+SAVEAS_PHP_MODE_URL+"'>";
_.each(postData, function(postValue, postKey){
var escapedKey = postKey.replace("\\", "\\\\").replace("'", "\'");
var escapedValue = postValue.replace("\\", "\\\\").replace("'", "\'");
fakeFormHtmlFragment += "<input type='hidden' name='"+escapedKey+"' value='"+escapedValue+"'>";
});
fakeFormHtmlFragment += "</form>";
$fakeFormDom = $(fakeFormHtmlFragment);
$("body").append($fakeFormDom);
$fakeFormDom.submit();
Для таких вещей, как html, текст и т.д., убедитесь, что тип mimetype - это что-то вроде application/octet-stream
php code
<?php
/**
* get HTTP POST variable which is a string ?foo=bar
* @param string $param
* @param bool $required
* @return string
*/
function getHTTPPostString ($param, $required = false) {
if(!isset($_POST[$param])) {
if($required) {
echo "required POST param '$param' missing";
exit 1;
} else {
return "";
}
}
return trim($_POST[$param]);
}
$filename = getHTTPPostString("filename", true);
$filecontent = getHTTPPostString("filecontent", true);
header("Content-type: application/octet-stream");
header("Content-Disposition: attachment; filename=\"$filename\"");
echo $filecontent;
Ответ 5
Короче говоря, нет более простого способа. Вам нужно сделать другой запрос сервера для показа файла PDF. Хотя, есть несколько альтернатив, но они не идеальны и не будут работать во всех браузерах:
- Посмотрите схему URI данных. Если двоичные данные невелики, вы можете использовать javascript для открытия данных, передающих окно в URI.
- Единственное решение для Windows/IE - иметь элемент управления .NET или FileSystemObject для сохранения данных в локальной файловой системе и откройте их оттуда.
Ответ 6
Прошло некоторое время с тех пор, как был задан этот вопрос, но у меня был такой же вызов, и я хочу поделиться своим решением. Он использует элементы из других ответов, но я не смог найти его целиком. Он не использует форму или iframe, но для нее требуется пара сообщений/получателя запроса. Вместо сохранения файла между запросами он сохраняет данные сообщения. Это кажется простым и эффективным.
клиент
var apples = new Array();
// construct data - replace with your own
$.ajax({
type: "POST",
url: '/Home/Download',
data: JSON.stringify(apples),
contentType: "application/json",
dataType: "text",
success: function (data) {
var url = '/Home/Download?id=' + data;
window.location = url;
});
});
сервер
[HttpPost]
// called first
public ActionResult Download(Apple[] apples)
{
string json = new JavaScriptSerializer().Serialize(apples);
string id = Guid.NewGuid().ToString();
string path = Server.MapPath(string.Format("~/temp/{0}.json", id));
System.IO.File.WriteAllText(path, json);
return Content(id);
}
// called next
public ActionResult Download(string id)
{
string path = Server.MapPath(string.Format("~/temp/{0}.json", id));
string json = System.IO.File.ReadAllText(path);
System.IO.File.Delete(path);
Apple[] apples = new JavaScriptSerializer().Deserialize<Apple[]>(json);
// work with apples to build your file in memory
byte[] file = createPdf(apples);
Response.AddHeader("Content-Disposition", "attachment; filename=juicy.pdf");
return File(file, "application/pdf");
}
Ответ 7
$scope.downloadSearchAsCSV = function(httpOptions) {
var httpOptions = _.extend({
method: 'POST',
url: '',
data: null
}, httpOptions);
$http(httpOptions).then(function(response) {
if( response.status >= 400 ) {
alert(response.status + " - Server Error \nUnable to download CSV from POST\n" + JSON.stringify(httpOptions.data));
} else {
$scope.downloadResponseAsCSVFile(response)
}
})
};
/**
* @source: https://github.com/asafdav/ng-csv/blob/master/src/ng-csv/directives/ng-csv.js
* @param response
*/
$scope.downloadResponseAsCSVFile = function(response) {
var charset = "utf-8";
var filename = "search_results.csv";
var blob = new Blob([response.data], {
type: "text/csv;charset="+ charset + ";"
});
if (window.navigator.msSaveOrOpenBlob) {
navigator.msSaveBlob(blob, filename); // @untested
} else {
var downloadContainer = angular.element('<div data-tap-disabled="true"><a></a></div>');
var downloadLink = angular.element(downloadContainer.children()[0]);
downloadLink.attr('href', window.URL.createObjectURL(blob));
downloadLink.attr('download', "search_results.csv");
downloadLink.attr('target', '_blank');
$document.find('body').append(downloadContainer);
$timeout(function() {
downloadLink[0].click();
downloadLink.remove();
}, null);
}
//// Gets blocked by Chrome popup-blocker
//var csv_window = window.open("","","");
//csv_window.document.write('<meta name="content-type" content="text/csv">');
//csv_window.document.write('<meta name="content-disposition" content="attachment; filename=data.csv"> ');
//csv_window.document.write(response.data);
};
Ответ 8
Не совсем ответ на исходный пост, но быстрое и грязное решение для размещения json-объекта на сервере и динамического создания загрузки.
Клиентская сторона jQuery:
var download = function(resource, payload) {
$("#downloadFormPoster").remove();
$("<div id='downloadFormPoster' style='display: none;'><iframe name='downloadFormPosterIframe'></iframe></div>").appendTo('body');
$("<form action='" + resource + "' target='downloadFormPosterIframe' method='post'>" +
"<input type='hidden' name='jsonstring' value='" + JSON.stringify(payload) + "'/>" +
"</form>")
.appendTo("#downloadFormPoster")
.submit();
}
.. и затем декодирование json-string на сервере и установление заголовков для загрузки (пример PHP):
$request = json_decode($_POST['jsonstring']), true);
header('Content-Type: application/csv');
header('Content-Disposition: attachment; filename=export.csv');
header('Pragma: no-cache');
Ответ 9
Я думаю, что лучший подход - использовать комбинацию. Ваш второй подход кажется элегантным решением, в котором задействованы браузеры.
Так что в зависимости от того, как делается вызов. (будь то браузер или вызов веб-службы) вы можете использовать комбинацию из двух, отправляя URL-адрес в браузер и отправляя необработанные данные любому другому клиенту веб-службы.
Ответ 10
Я уже два дня просыпаюсь, пытаясь выяснить, как загрузить файл с помощью jquery с вызовом ajax. Вся полученная поддержка не смогла помочь моей ситуации, пока я не попробую.
Клиентская сторона
function exportStaffCSV(t) {
var postData = { checkOne: t };
$.ajax({
type: "POST",
url: "/Admin/Staff/exportStaffAsCSV",
data: postData,
success: function (data) {
SuccessMessage("file download will start in few second..");
var url = '/Admin/Staff/DownloadCSV?data=' + data;
window.location = url;
},
traditional: true,
error: function (xhr, status, p3, p4) {
var err = "Error " + " " + status + " " + p3 + " " + p4;
if (xhr.responseText && xhr.responseText[0] == "{")
err = JSON.parse(xhr.responseText).Message;
ErrorMessage(err);
}
});
}
Ответ 11
С HTML5 вы можете просто создать привязку и нажать на нее. Нет необходимости добавлять его в документ в качестве ребенка.
const a = document.createElement('a');
a.download = '';
a.href = urlForPdfFile;
a.click();
Все сделано.
Если вы хотите иметь специальное имя для загрузки, просто передайте его в атрибуте download
:
const a = document.createElement('a');
a.download = 'my-special-name.pdf';
a.href = urlForPdfFile;
a.click();
Ответ 12
Другой подход вместо сохранения файла на сервере и его извлечения - использование .NET 4.0+ ObjectCache с коротким истечением срока действия до второго действия (после чего его можно окончательно сбрасывать). Причина, по которой я хочу использовать JQuery Ajax для вызова, заключается в том, что он асинхронный. Построение моего динамического PDF файла занимает довольно много времени, и в это время я показываю диалоговое окно занятого спиннера (он также позволяет выполнять другие работы). Подход использования данных, возвращаемых в "success:" для создания Blob, не работает надежно. Это зависит от содержимого файла PDF. Он легко повреждается данными в ответе, если он не является полностью текстовым, что все, что может обрабатывать Ajax.
Ответ 13
Нашел его где-то давно, и он отлично работает!
let payload = {
key: "val",
key2: "val2"
};
let url = "path/to/api.php";
let form = $('<form>', {'method': 'POST', 'action': url}).hide();
$.each(payload, (k, v) => form.append($('<input>', {'type': 'hidden', 'name': k, 'value': v})) );
$('body').append(form);
form.submit();
form.remove();
Ответ 14
Решение
Вложение Content-Disposition, похоже, работает для меня:
self.set_header("Content-Type", "application/json")
self.set_header("Content-Disposition", 'attachment; filename=learned_data.json')
Обход
Применение/октет-поток
У меня было что-то похожее со мной в JSON, для меня на стороне сервера я устанавливал заголовок на
self.set_header ("Content-Type", "application/json")
Однако, когда я изменил его на:
self.set_header("Content-Type", "application/octet-stream")
Он автоматически загрузил его.
Также знайте, что для того, чтобы файл все еще сохранял суффикс .json, он вам понадобится в заголовке файла:
self.set_header("Content-Disposition", 'filename=learned_data.json')