jQuery.getJSON()
jQuery.getJSON( url [, data ] [, success ] ) Returns: jqXHR
Description: Load JSON-encoded data from the server using a GET HTTP request.
version added: 1.0 jQuery.getJSON( url [, data ] [, success ] )
This is a shorthand Ajax function, which is equivalent to:
$.ajax(
dataType: "json",
url: url,
data: data,
success: success
>);
Data that is sent to the server is appended to the URL as a query string. If the value of the data parameter is a plain object, it is converted to a string and url-encoded before it is appended to the URL.
Most implementations will specify a success handler:
This example, of course, relies on the structure of the JSON file:
"one": "Singular sensation",
"two": "Beady little eyes",
"three": "Little birds pitch by my doorstep"
>
Using this structure, the example loops through the requested data, builds an unordered list, and appends it to the body.
The success callback is passed the returned data, which is typically a JavaScript object or array as defined by the JSON structure and parsed using the $.parseJSON() method. It is also passed the text status of the response.
As of jQuery 1.5, the success callback function receives a "jqXHR" object (in jQuery 1.4, it received the XMLHttpRequest object). However, since JSONP and cross-domain GET requests do not use XHR , in those cases the jqXHR and textStatus parameters passed to the success callback are undefined.
Important: As of jQuery 1.4, if the JSON file contains a syntax error, the request will usually fail silently. Avoid frequent hand-editing of JSON data for this reason. JSON is a data-interchange format with syntax rules that are stricter than those of JavaScript's object literal notation. For example, all strings represented in JSON, whether they are properties or values, must be enclosed in double-quotes. For details on the JSON format, see https://json.org/.
JSONP
If the URL includes the string "callback=?" (or similar, as defined by the server-side API), the request is treated as JSONP instead. See the discussion of the jsonp data type in $.ajax() for more details.
The jqXHR Object
As of jQuery 1.5, all of jQuery's Ajax methods return a superset of the XMLHTTPRequest object. This jQuery XHR object, or "jqXHR," returned by $.getJSON() implements the Promise interface, giving it all the properties, methods, and behavior of a Promise (see Deferred object for more information). The jqXHR.done() (for success), jqXHR.fail() (for error), and jqXHR.always() (for completion, whether success or error; added in jQuery 1.6) methods take a function argument that is called when the request terminates. For information about the arguments this function receives, see the jqXHR Object section of the $.ajax() documentation.
The Promise interface in jQuery 1.5 also allows jQuery's Ajax methods, including $.getJSON() , to chain multiple .done() , .always() , and .fail() callbacks on a single request, and even to assign these callbacks after the request may have completed. If the request is already complete, the callback is fired immediately.
AJAX и JSON
Давайте рассмотрим JavaScript и HTML коды, а затем постараемся построчно их разобрать. Подразумевается, что JavaScript подключен к HTML коду.
function makeXHR( ) < var xhr=new XMLHttpRequest(); //создание объекта для работы с асинхронными запросами xhr.onreadystatechange=function( ) < if (xhr.readyState==4 && xhr.status==200) < document.getElementById("myDiv").innerHTML=xhr.responseText; > > //формирование запроса xhr.open("GET","ajax_info.txt",true); //отправка запроса xhr.send(); >
div id="myDiv"> h2>Ajax поменяет этот текст h2> div> button type="button" onclick="makeXHR()">Послать AJAX button>
Для работы с AJAX нам понадобится объект от конструктора XMLHttpRequest. Любой браузер, поддерживающий AJAX содержит данный конструктор. Создаем мы такой объект строчкой
var xhr=new XMLHttpRequest();
Название объекта может быть любым, xhr выбрано просто, чтобы легче было запомнить (сокращение от Xml Http Request)
Далее пропустим пока что строчки для установки обработчика события. и перейдем сразу к формированию AJAX-запроса
Строка xhr.open подготавливает(но не отправляет) AJAX-запрос. Мы можем отправлять запросы двумя методами протокола http - GET и POST. В данном случае мы используем метод GET. Запрос пойдет к файлу ajax_info.txt, который находится в той же папке, что и наш скрипт. Последний параметр true, говорит о том, что запрос будет асинхронным, то есть мы не будем приостанавливать выполнение скрипта, ожидая получения ответа от сервера
xhr.open("GET","ajax_info.txt",true);
Ну и непосредственно отправка запроса на сервер
Рано или поздно, если всё было в порядке, сервер пришлет нам свой ответ, и его нужно обработать. Когда данные поступают от сервера в браузере срабатывает событие onreadystatechange. Поэтому нам необходимо поставить на него обработчик
xhr.onreadystatechange=function( ) < if (xhr.readyState==4 && xhr.status==200) < document.getElementById("myDiv").innerHTML=xhr.responseText; > >
Данные от сервера могут поступать порциями, затем будут проходить стадию подготовки. Каждый раз, при изменении состояния этого процесса будет вызываться событие onreadystatechange. Нас же интересует только тот момент, когда данные полностью загрузились и готовы для работы с ними. Это соответствует моменту когда xhr.readyState == 4. Строка xhr.status==200 означает, что сервер, к которому мы обращались нормально отработал и сформировал свой ответ.
После того как данные получены, они находятся в поле responseText объекта xhr. В нашем примере мы загружаем их внутрь div'a c id myDiv.
Для того, чтобы протестировать работоспособность этого примера, скопируйте код, приведенный ниже, сохраните его в файле index.html и откройте этот файл в Mozilla Firefox (Chrome и Safari не работают с локальными файлами). Не забудьте создать файл ajax_info.txt - напишите там, например Hello World! Файл создавать лучше в Sublime или Notepad++, но не в Блокноте или WordPad, потому что могут возникнуть проблемы с кодировками, из-за которых ничего не будет работать.
html lang="en"> head> meta charset="UTF-8"> title>Document title> script> function makeXHR( ) < var xhr=new XMLHttpRequest(); //создание объекта для работы с асинхронными запросами xhr.onreadystatechange=function( ) < if (xhr.readyState==4 && xhr.status==200) < document.getElementById("myDiv").innerHTML=xhr.responseText; > > //формирование запроса xhr.open("GET","ajax_info.txt",true); //отправка запроса xhr.send(); > script> head> body> div id="myDiv">h2>Ajax поменяет этот текст h2> div> button type="button" onclick="makeXHR()">Послать AJAX button> body> html>
Формат JSON
Как правило нам нужно получать от сервера более сложную информацию, чем просто строку. Если у нас есть разнородная информация, ее необходимо как-то структурировать. Как один из вариантов такого структурирования был придуман формат XML. Ему обязан своим названием объект XMLHttpRequest и сам протокол AJAX (Asynchronous JavaScript And XML). Но поскольку он довольно громоздкий, со временем он был заменён форматом JSON. Пример формата JSON можно посмотреть ниже.
Внимание! Для того, чтобы JSON парсился без ошибок, в нем не должно быть переносов строк
Хорошая подсветка для JSON - Monokai JSON+
< "firstName": "Остап", "lastName": "Бендер", "address": < "streetAddress": "Большая Арнаутская 23a", "city": "Одесса", "postalCode": 65000 >, "phoneNumbers": [ "+380 (48) 728‒10‒68", "+380 (48) 777–02–42" ] >
Если присмотреться, то JSON очень напоминает способ создания объекта с помощью литеральной нотации. Из отличий - мы должны везде использовать двойные кавычки: для названий свойств это обязательно, для значений исключение делается только для значений-чисел (посмотрите на postalCode в примере).
Функции внутри JSON'а не описываются. Если нам нужен объект, мы также можем использовать фигурные скобки, если нам нужен массив, то используем квадратные скобки.
JSON вряд ли бы стал сильно популярным, если бы не одно его свойство. Строку из JSON очень просто перевести в JavaScript объект. Для этого используется метод parse объекта JSON. Выглядит это преобразование примерно вот так.
var obj = JSON.parse(json_string);
Заменим содержимое нашего файла ajax_info.txt на JSON следующего вида
Если мы оставим строку с xhr.responseText без изменений (код ниже)
document.getElementById("myDiv").innerHTML=xhr.responseText;
То при нажатии на кнопку мы увидим наш JSON-код. Это вряд ли то, чего мы хотели добиться! Изменим немного код этой строки
var person = JSON.parse(xhr.responseText); document.getElementById("myDiv").innerHTML=person.name+' '+person.lastname;
Теперь у нас должно вывестись Остап Бендер вместо Hello World! Значит Вы таки да освоили JSON 😉
JSON.stringify
Иногда нужно JavaScript-объект преобразовать в JSON. Для этого используется метод JSON.stringify. Например
var obj = <>; obj.a = 5; obj.b = 7; var str = JSON.stringify(obj); console.log(str);//
Поля с методами в объекте либо убираются при таком преобразованиями, либо значение такого поля будет null
Примеры JSON-файлов
Мы можем создать JSON состоящий из массива объектов
[ "name":"Mark","surname":"Twain">, "name":"Lev","surname":"Tolstoy">, "name":"Antoine","surname":"de Saint-Exupéry"> ]
Допустим мы получили этот JSON в переменную str. После того как мы ее распарсим, мы получим массив с тремя элементами, в роли которых будут объекты
var obj=JSON.parse(str); console.log(obj.length); //3 console.log(obj[1].surname);//Tolstoy
var xhr = new XMLHttpRequest(), fd = new FormData(); fd.append( 'file', input.files[0] ); xhr.open( 'POST', '/api/upload'); xhr.onreadystatechange = handler; xhr.send( fd );
Полезное чтиво:
- Cоздаем JSON файл со свойствами прямоугольника – шириной, высотой и фоновым цветом. С помощью AJAX считываем его. Парсим с помощью JSON.parse и используем полученные данные для вывода прямоугольника на экран.
- Есть JSON-файл в нем хранятся имена людей. Получаем данные из файла с помощью AJAX. Вывести квадраты с именами людей внутри.
- Создаем JSON файл продукта. В нем должно содержаться название, описание, цена и адрес картинки.
- Создаем JSON, в котором будут храниться информация о товарах. Получить его AJAX'ом и вывести товары ввиде каталога.
- Создать Single Page Application, имитирующее трехстраничный сайт