Что такое JSON — Журнал «Код» программирование без снобизма

JSON является синтаксисом для сериализации объектов, массивов, чисел, строк логических значений и значения null. Он основывается на синтаксисе JavaScript, однако всё же отличается от него: не каждый код на JavaScript является JSON, и не каждый JSON является кодом на JavaScript. Смотрите также статью JSON: подмножество JavaScript, которым он не является (на английском).

Ниже представлен полный синтаксис JSON:

JSON = null or true or false or JSONNumber or JSONString or JSONObject or JSONArray
JSONNumber = - PositiveNumber or PositiveNumber
PositiveNumber = DecimalNumber or DecimalNumber . Digits or DecimalNumber . Digits ExponentPart or DecimalNumber ExponentPart
DecimalNumber = 0 or OneToNine Digits
ExponentPart = e Exponent or E Exponent
Exponent = Digits or Digits or - Digits
Digits = Digit or Digits Digit
Digit = 0 through 9
OneToNine = 1 through 9
JSONString = "" or " StringCharacters "
StringCharacters = StringCharacter or StringCharacters StringCharacter
StringCharacter = any character except " or or U 0000 through U 001F or EscapeSequence
EscapeSequence = " or / or \ or b or f or n or r or t or u HexDigit HexDigit HexDigit HexDigit
HexDigit = 0 through 9 or A through F or a through f
JSONObject = { } or { Members }
Members = JSONString : JSON or Members , JSONString : JSON
JSONArray = [ ] or [ ArrayElements ]
ArrayElements = JSON or ArrayElements , JSON

Во всех продукциях могут присутствовать незначащие пробельные символы, за исключением продукций ЧислоJSON (числа не должны содержать пробелов) и СтрокаJSON (где они интерпретируются как часть строки или возбуждают ошибку). Пробельными символами считаются символы табуляции (U 0009), возврата каретки (U 000D), перевода строки (U 000A) и, собственно, пробела (U 0020).

Объект JSON не поддерживается старыми браузерами. Вы можете работать с ним, добавив следующий код в начало ваших скриптов, он позволяет использовать объект JSON в реализациях, которые его ещё не поддерживают (например, в Internet Explorer 6).

Следующий алгоритм имитирует работу настоящего объекта JSON:

if(!window.JSON){ window.JSON={parse:function(sJSON){returneval('('  sJSON  ')');},stringify:function(vContent){if(vContent instanceofObject){var sOutput ='';if(vContent.constructor === Array){for(var nId =0; nId < vContent.length; sOutput  =this.stringify(vContent[nId]) ',', nId );return'['  sOutput.substr(0, sOutput.length -1) ']';}if(vContent.toString !==Object.prototype.toString){return'"'  vContent.toString().replace(/"/g,'\$&') '"';}for(var sProp in vContent){ sOutput  ='"'  sProp.replace(/"/g,'\$&') '":' this.stringify(vContent[sProp]) ',';}return'{'  sOutput.substr(0, sOutput.length -1) '}';}returntypeof vContent ==='string'?'"'  vContent.replace(/"/g,'\$&') '"':String(vContent);}};}

Более сложными известными полифилами для объекта JSON являются проекты JSON2 и JSON3.

Допустим, у нас есть сложный объект, и мы хотели бы преобразовать его в строку, чтобы отправить по сети или просто вывести для логирования.

Естественно, такая строка должна включать в себя все важные свойства.

Мы могли бы реализовать преобразование следующим образом:

…Но в процессе разработки добавляются новые свойства, старые свойства переименовываются и удаляются. Обновление такого toString каждый раз может стать проблемой. Мы могли бы попытаться перебрать свойства в нём, но что, если объект сложный, и в его свойствах имеются вложенные объекты? Мы должны были бы осуществить их преобразование тоже.

К счастью, нет необходимости писать код для обработки всего этого. У задачи есть простое решение.

JSON (JavaScript Object Notation) – это общий формат для представления значений и объектов. Его описание задокументировано в стандарте RFC 4627. Первоначально он был создан для JavaScript, но многие другие языки также имеют библиотеки, которые могут работать с ним. Таким образом, JSON легко использовать для обмена данными, когда клиент использует JavaScript, а сервер написан на Ruby/PHP/Java или любом другом языке.

JavaScript предоставляет методы:

• JSON.stringify для преобразования объектов в JSON.
• JSON.parse для преобразования JSON обратно в объект.

Например, здесь мы преобразуем через JSON.stringify данные студента:

let student = { name: 'John', age: 30, isAdmin: false, courses: ['html', 'css', 'js'], wife: null
};
let json = JSON.stringify(student);
alert(typeof json); // мы получили строку!
alert(json);
/* выведет объект в формате JSON:
{ "name": "John", "age": 30, "isAdmin": false, "courses": ["html", "css", "js"], "wife": null
}
*/

Метод JSON.stringify(student) берёт объект и преобразует его в строку.

Полученная строка json называется JSON-форматированным или сериализованным объектом. Мы можем отправить его по сети или поместить в обычное хранилище данных.

Обратите внимание, что объект в формате JSON имеет несколько важных отличий от объектного литерала:

• Строки используют двойные кавычки. Никаких одинарных кавычек или обратных кавычек в JSON. Так 'John' становится "John".
• Имена свойств объекта также заключаются в двойные кавычки. Это обязательно. Так age:30 становится "age":30.

JSON.stringify может быть применён и к примитивам.

JSON поддерживает следующие типы данных:

• Объекты { ... }
• Массивы [ ... ]
• Примитивы:
  • строки,
  • числа,
  • логические значения true/false,
  • null.

Например:

JSON является независимой от языка спецификацией для данных, поэтому JSON.stringify пропускает некоторые специфические свойства объектов JavaScript.

А именно:

• Свойства-функции (методы).
• Символьные свойства.
• Свойства, содержащие undefined.

Обычно это нормально. Если это не то, чего мы хотим, то скоро мы увидим, как можно настроить этот процесс.

Самое замечательное, что вложенные объекты поддерживаются и конвертируются автоматически.

Например:

Важное ограничение: не должно быть циклических ссылок.

Например:

Здесь преобразование завершается неудачно из-за циклической ссылки: room.occupiedBy ссылается на meetup, и meetup.place ссылается на room:

Полный синтаксис JSON.stringify:

value

Значение для кодирования.

replacer

Массив свойств для кодирования или функция соответствия function(key, value).

space

Дополнительное пространство (отступы), используемое для форматирования.

В большинстве случаев JSON.stringify используется только с первым аргументом. Но если нам нужно настроить процесс замены, например, отфильтровать циклические ссылки, то можно использовать второй аргумент JSON.stringify.

Если мы передадим ему массив свойств, будут закодированы только эти свойства.

Например:

Здесь мы, наверное, слишком строги. Список свойств применяется ко всей структуре объекта. Так что внутри participants – пустые объекты, потому что name нет в списке.

Давайте включим в список все свойства, кроме room.occupiedBy, из-за которого появляется цикличная ссылка:

let room = { number: 23
};
let meetup = { title: "Conference", participants: [{name: "John"}, {name: "Alice"}], place: room // meetup ссылается на room
};
room.occupiedBy = meetup; // room ссылается на meetup
alert( JSON.stringify(meetup, ['title', 'participants', 'place', 'name', 'number']) );
/*
{ "title":"Conference", "participants":[{"name":"John"},{"name":"Alice"}], "place":{"number":23}
}
*/

Теперь всё, кроме occupiedBy, сериализовано. Но список свойств довольно длинный.

К счастью, в качестве replacer мы можем использовать функцию, а не массив.

Функция будет вызываться для каждой пары (key, value), и она должна возвращать заменённое значение, которое будет использоваться вместо исходного. Или undefined, чтобы пропустить значение.

В нашем случае мы можем вернуть value «как есть» для всего, кроме occupiedBy. Чтобы игнорировать occupiedBy, код ниже возвращает undefined:

Обратите внимание, что функция replacer получает каждую пару ключ/значение, включая вложенные объекты и элементы массива. И она применяется рекурсивно. Значение this внутри replacer – это объект, который содержит текущее свойство.

Первый вызов – особенный. Ему передаётся специальный «объект-обёртка»: {"": meetup}. Другими словами, первая (key, value) пара имеет пустой ключ, а значением является целевой объект в общем. Вот почему первая строка из примера выше будет ":[object Object]".

Идея состоит в том, чтобы дать как можно больше возможностей replacer – у него есть возможность проанализировать и заменить/пропустить даже весь объект целиком, если это необходимо.

Третий аргумент в JSON.stringify(value, replacer, space) – это количество пробелов, используемых для удобного форматирования.

Ранее все JSON-форматированные объекты не имели отступов и лишних пробелов. Это нормально, если мы хотим отправить объект по сети. Аргумент space используется исключительно для вывода в удобочитаемом виде.

Ниже space = 2 указывает JavaScript отображать вложенные объекты в несколько строк с отступом в 2 пробела внутри объекта:

let user = { name: "John", age: 25, roles: { isAdmin: false, isEditor: true }
};
alert(JSON.stringify(user, null, 2));
/* отступ в 2 пробела:
{ "name": "John", "age": 25, "roles": { "isAdmin": false, "isEditor": true }
}
*/
/* для JSON.stringify(user, null, 4) результат содержит больше отступов:
{ "name": "John", "age": 25, "roles": { "isAdmin": false, "isEditor": true }
}
*/

Параметр space применяется для логирования и красивого вывода.

Как и toString для преобразования строк, объект может предоставлять метод toJSON для преобразования в JSON. JSON.stringify автоматически вызывает его, если он есть.

Например:

Как видим, date(1) стал строкой. Это потому, что все объекты типа Date имеют встроенный метод toJSON, который возвращает такую строку.

Теперь давайте добавим собственную реализацию метода toJSON в наш объект room(2):

Как видите, toJSON используется как при прямом вызове JSON.stringify(room), так и когда room вложен в другой сериализуемый объект.

Чтобы декодировать JSON-строку, нам нужен другой метод с именем JSON.parse.

Синтаксис:

str

JSON для преобразования в объект.

reviver

Необязательная функция, которая будет вызываться для каждой пары (ключ, значение) и может преобразовывать значение.

Например:

Или для вложенных объектов:

JSON может быть настолько сложным, насколько это необходимо, объекты и массивы могут включать другие объекты и массивы. Но они должны быть в том же JSON-формате.

Вот типичные ошибки в написанном от руки JSON (иногда приходится писать его для отладки):

let json = `{ name: "John", // Ошибка: имя свойства без кавычек "surname": 'Smith', // Ошибка: одинарные кавычки в значении (должны быть двойными) 'isAdmin': false // Ошибка: одинарные кавычки в ключе (должны быть двойными) "birthday": new Date(2000, 2, 3), // Ошибка: не допускается конструктор "new", только значения. "friends": [0,1,2,3] // Здесь всё в порядке
}`;

Кроме того, JSON не поддерживает комментарии. Добавление комментария в JSON делает его недействительным.

Существует ещё один формат JSON5, который поддерживает ключи без кавычек, комментарии и т.д. Но это самостоятельная библиотека, а не спецификация языка.

Обычный JSON настолько строг не потому, что его разработчики ленивы, а потому, что позволяет легко, надёжно и очень быстро реализовывать алгоритм кодирования и чтения.

Представьте, что мы получили объект meetup с сервера в виде строки данных.

Вот такой:

…А теперь нам нужно десериализовать её, т.е. снова превратить в объект JavaScript.

Давайте сделаем это, вызвав JSON.parse:

Ой, ошибка!

Значением meetup.date является строка, а не Date объект. Как JSON.parse мог знать, что он должен был преобразовать эту строку в Date?

Давайте передадим JSON.parse функцию восстановления вторым аргументом, которая возвращает все значения «как есть», но date станет Date:

Кстати, это работает и для вложенных объектов: